Safe Haskell	None
Language	Haskell2010

Network.HTTP2

Contents

Frame
Encoding
Decoding
Decoding payload
Frame type ID
Frame type
Types
Stream identifier
Stream identifier related
Flags
SettingsList
Settings
Error code
Error
Magic

Description

Framing in HTTP/2.

Synopsis

Frame

data Frame Source

The data type for HTTP/2 frames.

Constructors

Frame
Fields frameHeader :: FrameHeader framePayload :: FramePayload

Instances

Eq Frame
Read Frame
Show Frame

data FrameHeader Source

The data type for HTTP/2 frame headers.

Constructors

FrameHeader
Fields payloadLength :: Int flags :: FrameFlags streamId :: StreamIdentifier

Instances

Eq FrameHeader
Read FrameHeader
Show FrameHeader

data FramePayload Source

The data type for HTTP/2 frame payloads.

Instances

Eq FramePayload
Read FramePayload
Show FramePayload

isPaddingDefined :: FramePayload -> Bool Source

Checking if padding is defined in this frame type.

Encoding

encodeFrame :: EncodeInfo -> FramePayload -> ByteString Source

Encoding an HTTP/2 frame to ByteString. This function is not efficient enough for high performace program because of the concatenation of ByteString.

>>> encodeFrame (encodeInfo id 1) (DataFrame "body")
"\NUL\NUL\EOT\NUL\NUL\NUL\NUL\NUL\SOHbody"

encodeFrameChunks :: EncodeInfo -> FramePayload -> [ByteString] Source

Encoding an HTTP/2 frame to [ByteString]. This is suitable for sendMany.

encodeFrameHeader :: FrameTypeId -> FrameHeader -> ByteString Source

Encoding an HTTP/2 frame header. The frame header must be completed.

encodeFramePayload :: EncodeInfo -> FramePayload -> (FrameHeader, [ByteString]) Source

Encoding an HTTP/2 frame payload. This returns a complete frame header and chunks of payload.

data EncodeInfo Source

Auxiliary information for frame encoding.

Constructors

EncodeInfo
Fields encodeFlags :: FrameFlags Flags to be set in a frame header encodeStreamId :: StreamIdentifier Stream id to be set in a frame header encodePadding :: Maybe Padding Padding if any. In the case where this value is set but the priority flag is not set, this value gets preference over the priority flag. So, if this value is set, the priority flag is also set.

Instances

Read EncodeInfo
Show EncodeInfo

encodeInfo Source

Arguments

:: (FrameFlags -> FrameFlags)
-> Int	stream identifier
-> EncodeInfo

A smart builder of EncodeInfo.

>>> encodeInfo setAck 0
EncodeInfo {encodeFlags = 1, encodeStreamId = StreamIdentifier 0, encodePadding = Nothing}

Decoding

decodeFrame Source

Arguments

:: Settings	HTTP/2 settings
-> ByteString	Input byte-stream
-> Either HTTP2Error Frame	Decoded frame

Decoding an HTTP/2 frame to ByteString. The second argument must be include the entire of frame. So, this function is not useful for real applications but useful for testing.

decodeFrameHeader :: ByteString -> (FrameTypeId, FrameHeader) Source

Decoding an HTTP/2 frame header. Must supply 9 bytes.

checkFrameHeader :: Settings -> (FrameTypeId, FrameHeader) -> Either HTTP2Error (FrameTypeId, FrameHeader) Source

Checking a frame header and reporting an error if any.

>>> let stid = toStreamIdentifier 0
>>> checkFrameHeader defaultSettings (FrameData,(FrameHeader 100 0 stid))
Left (ConnectionError ProtocolError "cannot used in control stream")

Decoding payload

decodeFramePayload :: FrameTypeId -> FramePayloadDecoder Source

Decoding an HTTP/2 frame payload.

type FramePayloadDecoder = FrameHeader -> ByteString -> Either HTTP2Error FramePayload Source

decodeDataFrame :: FramePayloadDecoder Source

decodeHeadersFrame :: FramePayloadDecoder Source

decodePriorityFrame :: FramePayloadDecoder Source

decoderstStreamFrame :: FramePayloadDecoder Source

decodeSettingsFrame :: FramePayloadDecoder Source

decodePushPromiseFrame :: FramePayloadDecoder Source

decodePingFrame :: FramePayloadDecoder Source

decodeGoAwayFrame :: FramePayloadDecoder Source

decodeWindowUpdateFrame :: FramePayloadDecoder Source

decodeContinuationFrame :: FramePayloadDecoder Source

Frame type ID

framePayloadToFrameTypeId :: FramePayload -> FrameTypeId Source

Getting FrameType from FramePayload.

>>> framePayloadToFrameTypeId (DataFrame "body")
FrameData

Frame type

type FrameType = Word8 Source

fromFrameTypeId :: FrameTypeId -> FrameType Source

>>> fromFrameTypeId FrameData
0
>>> fromFrameTypeId FrameContinuation
9
>>> fromFrameTypeId (FrameUnknown 10)
10

toFrameTypeId :: FrameType -> FrameTypeId Source

>>> toFrameTypeId 0
FrameData
>>> toFrameTypeId 9
FrameContinuation
>>> toFrameTypeId 10
FrameUnknown 10

Types

type HeaderBlockFragment = ByteString Source

type Padding = ByteString Source

data Priority Source

Constructors

Priority
Fields exclusive :: Bool streamDependency :: StreamIdentifier weight :: Int

Instances

Eq Priority
Read Priority
Show Priority

type PromisedStreamId = StreamIdentifier Source

type LastStreamId = StreamIdentifier Source

type StreamDependency = StreamIdentifier Source

type WindowSizeIncrement = Word32 Source

Stream identifier

data StreamIdentifier Source

Instances

Eq StreamIdentifier
Read StreamIdentifier
Show StreamIdentifier

fromStreamIdentifier :: StreamIdentifier -> Int Source

>>> fromStreamIdentifier (toStreamIdentifier 0)
0

toStreamIdentifier :: Int -> StreamIdentifier Source

>>> toStreamIdentifier 0
StreamIdentifier 0

isControl :: StreamIdentifier -> Bool Source

>>> isControl $ toStreamIdentifier 0
True
>>> isControl $ toStreamIdentifier 1
False

isRequest :: StreamIdentifier -> Bool Source

>>> isRequest $ toStreamIdentifier 0
False
>>> isRequest $ toStreamIdentifier 1
True

isResponse :: StreamIdentifier -> Bool Source

>>> isResponse $ toStreamIdentifier 0
False
>>> isResponse $ toStreamIdentifier 2
True

Stream identifier related

testExclusive :: Int -> Bool Source

setExclusive :: Int -> Int Source

Flags

type FrameFlags = Word8 Source

defaultFlags :: FrameFlags Source

>>> defaultFlags
0

testEndStream :: FrameFlags -> Bool Source

>>> testEndStream 0x1
True

testAck :: FrameFlags -> Bool Source

>>> testAck 0x1
True

testEndHeader :: FrameFlags -> Bool Source

>>> testEndHeader 0x4
True

testPadded :: FrameFlags -> Bool Source

>>> testPadded 0x8
True

testPriority :: FrameFlags -> Bool Source

>>> testPriority 0x20
True

setEndStream :: FrameFlags -> FrameFlags Source

>>> setEndStream 0
1

setAck :: FrameFlags -> FrameFlags Source

>>> setAck 0
1

setEndHeader :: FrameFlags -> FrameFlags Source

>>> setEndHeader 0
4

setPadded :: FrameFlags -> FrameFlags Source

>>> setPadded 0
8

setPriority :: FrameFlags -> FrameFlags Source

>>> setPriority 0
32

SettingsList

type SettingsList = [(SettingsKeyId, SettingsValue)] Source

Settings containing raw values.

type SettingsValue = Int Source

fromSettingsKeyId :: SettingsKeyId -> Word16 Source

>>> fromSettingsKeyId SettingsHeaderTableSize
1
>>> fromSettingsKeyId SettingsMaxHeaderBlockSize
6

toSettingsKeyId :: Word16 -> Maybe SettingsKeyId Source

>>> toSettingsKeyId 0
Nothing
>>> toSettingsKeyId 1
Just SettingsHeaderTableSize
>>> toSettingsKeyId 6
Just SettingsMaxHeaderBlockSize
>>> toSettingsKeyId 7
Nothing

checkSettingsList :: SettingsList -> Maybe HTTP2Error Source

Checking SettingsList and reporting an error if any.

>>> checkSettingsList [(SettingsEnablePush,2)]
Just (ConnectionError ProtocolError "enable push must be 0 or 1")

Settings

data Settings Source

Cooked version of settings. This is suitable to be stored in a HTTP/2 context.

Constructors

Settings
Fields headerTableSize :: Int enablePush :: Bool maxConcurrentStreams :: Maybe Int initialWindowSize :: Int maxFrameSize :: Int maxHeaderBlockSize :: Maybe Int

Instances

Show Settings

defaultSettings :: Settings Source

The default settings.

>>> defaultSettings
Settings {headerTableSize = 4096, enablePush = True, maxConcurrentStreams = Nothing, initialWindowSize = 65535, maxFrameSize = 16384, maxHeaderBlockSize = Nothing}

updateSettings :: Settings -> SettingsList -> Settings Source

Updating settings.

>>> updateSettings defaultSettings [(SettingsEnablePush,0),(SettingsMaxHeaderBlockSize,200)]
Settings {headerTableSize = 4096, enablePush = False, maxConcurrentStreams = Nothing, initialWindowSize = 65535, maxFrameSize = 16384, maxHeaderBlockSize = Just 200}

Error code

type ErrorCode = Word32 Source

fromErrorCodeId :: ErrorCodeId -> ErrorCode Source

>>> fromErrorCodeId NoError
0
>>> fromErrorCodeId InadequateSecurity
12

toErrorCodeId :: ErrorCode -> ErrorCodeId Source

>>> toErrorCodeId 0
NoError
>>> toErrorCodeId 0xc
InadequateSecurity
>>> toErrorCodeId 0xe
UnknownErrorCode 14

Error

data HTTP2Error Source

The connection error or the stream error.

Constructors

ConnectionError ErrorCodeId ByteString
StreamError ErrorCodeId StreamIdentifier

Instances

Eq HTTP2Error
Read HTTP2Error
Show HTTP2Error
Exception HTTP2Error
Typeable * HTTP2Error

errorCodeId :: HTTP2Error -> ErrorCodeId Source

Obtaining ErrorCodeId from HTTP2Error.

Magic

connectionPreface :: ByteString Source

The preface of HTTP/2.

>>> connectionPreface
"PRI * HTTP/2.0\r\n\r\nSM\r\n\r\n"

connectionPrefaceLength :: Int Source

Length of the preface.

>>> connectionPrefaceLength
24

frameHeaderLength :: Int Source

The length of HTTP/2 frame header.

>>> frameHeaderLength
9

maxPayloadLength :: Int Source

The maximum length of HTTP/2 payload.

>>> maxPayloadLength
16384

DataFrame ByteString
HeadersFrame (Maybe Priority) HeaderBlockFragment
PriorityFrame Priority
RSTStreamFrame ErrorCodeId
SettingsFrame SettingsList
PushPromiseFrame PromisedStreamId HeaderBlockFragment
PingFrame ByteString
GoAwayFrame LastStreamId ErrorCodeId ByteString
WindowUpdateFrame WindowSizeIncrement
ContinuationFrame HeaderBlockFragment
UnknownFrame FrameType ByteString

FrameData
FrameHeaders
FramePriority
FrameRSTStream
FrameSettings
FramePushPromise
FramePing
FrameGoAway
FrameWindowUpdate
FrameContinuation
FrameUnknown FrameType

Bounded SettingsKeyId
Enum SettingsKeyId
Eq SettingsKeyId
Ord SettingsKeyId
Read SettingsKeyId
Show SettingsKeyId

NoError
ProtocolError
InternalError
FlowControlError
SettingsTimeout
StreamClosed
FrameSizeError
RefusedStream
Cancel
CompressionError
ConnectError
EnhanceYourCalm
InadequateSecurity
HTTP11Required
UnknownErrorCode ErrorCode

Eq ErrorCodeId
Ord ErrorCodeId
Read ErrorCodeId
Show ErrorCodeId

SettingsHeaderTableSize
SettingsEnablePush
SettingsMaxConcurrentStreams
SettingsInitialWindowSize
SettingsMaxFrameSize
SettingsMaxHeaderBlockSize