Network.HTTP2.Frame

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 0EncodeInfo {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 (FrameData,(FrameHeader 100 0 0))Left (FrameDecodeError ProtocolError 0 "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 raw frame type.

Converting FrameType to Word8.

>>> fromFrameType FrameData0>>> fromFrameType FrameContinuation9

Getting FrameType from FramePayload.

>>> framePayloadToFrameType (DataFrame "body")FrameData

Type for stream priority. Deprecated in RFC 9113 but provided for FrameHeaders.

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

The type for stream identifier

Checking if the stream identifier for control.

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

Checking if the stream identifier is from a client.

>>> isClientInitiated 0False>>> isClientInitiated 1True

Checking if the stream identifier is from a server.

>>> isServerInitiated 0False>>> isServerInitiated 2True

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.

>>> defaultFlags0

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 0x4True

Checking if the PADDED flag is set.

>>> testPadded 0x8True

Checking if the PRIORITY flag is set.

>>> testPriority 0x20True

Setting the END_STREAM flag.

>>> setEndStream 01

Setting the ACK flag.

>>> setAck 01

Setting the END_HEADERS flag.

>>> setEndHeader 04

Setting the PADDED flag.

>>> setPadded 08

Setting the PRIORITY flag.

>>> setPriority 032

Association list of SETTINGS.

The type for SETTINGS key.

The type for raw SETTINGS value.

The default payload length of HTTP/2 payload.

>>> defaultPayloadLength16384

The maximum payload length of HTTP/2 payload.

>>> maxPayloadLength16777215

Window size.

The default initial window size.

>>> defaultWindowSize65535

The maximum window size.

>>> maxWindowSize2147483647

Checking if a window size exceeds the maximum window size.

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

The type for raw error code.

The type for error code. See https://www.rfc-editor.org/rfc/rfc9113#ErrorCodes.

The preface of HTTP/2.

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

Length of the preface.

>>> connectionPrefaceLength24

The length of HTTP/2 frame header.

>>> frameHeaderLength9

Default concurrency.

>>> recommendedConcurrency100