The data type for HTTP/2 frames.

The data type for HTTP/2 frame headers.

The data type for HTTP/2 frame payloads.

The type for fragments of a header encoded with HPACK.

The type for padding in payloads.

Checking if padding is defined in this frame type.

>>> isPaddingDefined $ DataFrame ""
True
>>> isPaddingDefined $ PingFrame ""
False

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"

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

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

Writing an encoded HTTP/2 frame header to the buffer. The length of the buffer must be larger than or equal to 9 bytes.

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

Auxiliary information for frame encoding.

A smart builder of EncodeInfo.

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

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.

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

Checking a frame header and reporting an error if any.

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

Decoding an HTTP/2 frame payload. This function is considered to return a frame payload decoder according to a frame type.

The type for frame payload decoder.

Frame payload decoder for DATA frame.

Frame payload decoder for HEADERS frame.

Frame payload decoder for PRIORITY frame.

Frame payload decoder for RST_STREAM frame.

Frame payload decoder for SETTINGS frame.

Frame payload decoder for PUSH_PROMISE frame.

Frame payload decoder for PING frame.

Frame payload decoder for GOAWAY frame.

Frame payload decoder for WINDOW_UPDATE frame.

Frame payload decoder for CONTINUATION frame.

The type for frame type.

Getting FrameType from FramePayload.

>>> framePayloadToFrameTypeId (DataFrame "body")
FrameData

The type for raw frame type.

Converting FrameTypeId to FrameType.

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

Converting FrameType to FrameTypeId.

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

Type for stream priority

The type for weight in priority. Its values are from 1 to 256.

Default priority which depends on stream 0.

>>> defaultPriority
Priority {exclusive = False, streamDependency = 0, weight = 16}

Highest priority which depends on stream 0.

>>> highestPriority
Priority {exclusive = False, streamDependency = 0, weight = 256}

The type for stream identifier

Checking if the stream identifier for control.

>>> isControl 0
True
>>> isControl 1
False

Checking if the stream identifier for request.

>>> isRequest 0
False
>>> isRequest 1
True

Checking if the stream identifier for response.

>>> isResponse 0
False
>>> isResponse 2
True

Checking if the exclusive flag is set.

Setting the exclusive flag.

Clearing the exclusive flag.

The type for flags.

The initial value of flags. No flags are set.

>>> defaultFlags
0

Checking if the END_STREAM flag is set. >>> testEndStream 0x1 True

Checking if the ACK flag is set. >>> testAck 0x1 True

Checking if the END_HEADERS flag is set.

>>> testEndHeader 0x4
True

Checking if the PADDED flag is set.

>>> testPadded 0x8
True

Checking if the PRIORITY flag is set.

>>> testPriority 0x20
True

Setting the END_STREAM flag.

>>> setEndStream 0
1

Setting the ACK flag.

>>> setAck 0
1

Setting the END_HEADERS flag.

>>> setEndHeader 0
4

Setting the PADDED flag.

>>> setPadded 0
8

Setting the PRIORITY flag.

>>> setPriority 0
32

Association list of SETTINGS.

The type for SETTINGS key.

The type for raw SETTINGS value.

Converting SettingsKeyId to raw value.

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

Converting raw value to SettingsKeyId.

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

Checking SettingsList and reporting an error if any.

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

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

The default settings.

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

Updating settings.

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

The type for window size.

The default initial window size.

>>> defaultInitialWindowSize
65535

The maximum window size.

>>> maxWindowSize
2147483647

Checking if a window size exceeds the maximum window size.

>>> isWindowOverflow 10
False
>>> isWindowOverflow maxWindowSize
False
>>> isWindowOverflow (maxWindowSize + 1)
True

The type for raw error code.

The type for error code. See https://tools.ietf.org/html/rfc7540#section-7.

Converting ErrorCodeId to ErrorCode.

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

Converting ErrorCode to ErrorCodeId.

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

The connection error or the stream error.

Obtaining ErrorCodeId from HTTP2Error.

The preface of HTTP/2.

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

Length of the preface.

>>> connectionPrefaceLength
24

The length of HTTP/2 frame header.

>>> frameHeaderLength
9

The maximum length of HTTP/2 payload.

>>> maxPayloadLength
16384

Default concurrency.

>>> recommendedConcurrency
100