http2-3.0.3: HTTP/2 library
Safe Haskell None
Language Haskell2010

Network.HTTP2.Frame

Description

Framing in HTTP/2( https://tools.ietf.org/html/rfc7540 ).

Synopsis

Frame

data Frame Source #

The data type for HTTP/2 frames.

Constructors

Frame

Fields

Instances

Instances details
Eq Frame Source #
Instance details

Defined in Network.HTTP2.Frame.Types

Methods

(==) :: Frame -> Frame -> Bool Source #

(/=) :: Frame -> Frame -> Bool Source #

Read Frame Source #
Instance details

Defined in Network.HTTP2.Frame.Types

Methods

readsPrec :: Int -> ReadS Frame Source #

readList :: ReadS [ Frame ] Source #

readPrec :: ReadPrec Frame Source #

readListPrec :: ReadPrec [ Frame ] Source #

Show Frame Source #
Instance details

Defined in Network.HTTP2.Frame.Types

Methods

showsPrec :: Int -> Frame -> ShowS Source #

show :: Frame -> String Source #

showList :: [ Frame ] -> ShowS Source #

data FrameHeader Source #

The data type for HTTP/2 frame headers.

Constructors

FrameHeader

Fields

Instances

Instances details
Eq FrameHeader Source #
Instance details

Defined in Network.HTTP2.Frame.Types

Methods

(==) :: FrameHeader -> FrameHeader -> Bool Source #

(/=) :: FrameHeader -> FrameHeader -> Bool Source #

Read FrameHeader Source #
Instance details

Defined in Network.HTTP2.Frame.Types

Methods

readsPrec :: Int -> ReadS FrameHeader Source #

readList :: ReadS [ FrameHeader ] Source #

readPrec :: ReadPrec FrameHeader Source #

readListPrec :: ReadPrec [ FrameHeader ] Source #

Show FrameHeader Source #
Instance details

Defined in Network.HTTP2.Frame.Types

Methods

showsPrec :: Int -> FrameHeader -> ShowS Source #

show :: FrameHeader -> String Source #

showList :: [ FrameHeader ] -> ShowS Source #

data FramePayload Source #

The data type for HTTP/2 frame payloads.

Constructors

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

Instances

Instances details
Eq FramePayload Source #
Instance details

Defined in Network.HTTP2.Frame.Types

Methods

(==) :: FramePayload -> FramePayload -> Bool Source #

(/=) :: FramePayload -> FramePayload -> Bool Source #

Read FramePayload Source #
Instance details

Defined in Network.HTTP2.Frame.Types

Methods

readsPrec :: Int -> ReadS FramePayload Source #

readList :: ReadS [ FramePayload ] Source #

readPrec :: ReadPrec FramePayload Source #

readListPrec :: ReadPrec [ FramePayload ] Source #

Show FramePayload Source #
Instance details

Defined in Network.HTTP2.Frame.Types

Methods

showsPrec :: Int -> FramePayload -> ShowS Source #

show :: FramePayload -> String Source #

showList :: [ FramePayload ] -> ShowS Source #

type HeaderBlockFragment = ByteString Source #

The type for fragments of a header encoded with HPACK.

type Padding = ByteString Source #

The type for padding in payloads.

isPaddingDefined :: FramePayload -> Bool Source #

Checking if padding is defined in this frame type. 

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

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.

encodeFrameHeaderBuf :: FrameTypeId -> FrameHeader -> Ptr Word8 -> IO () Source #

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

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

Instances

Instances details
Read EncodeInfo Source #
Instance details

Defined in Network.HTTP2.Frame.Encode

Methods

readsPrec :: Int -> ReadS EncodeInfo Source #

readList :: ReadS [ EncodeInfo ] Source #

readPrec :: ReadPrec EncodeInfo Source #

readListPrec :: ReadPrec [ EncodeInfo ] Source #

Show EncodeInfo Source #
Instance details

Defined in Network.HTTP2.Frame.Encode

Methods

showsPrec :: Int -> EncodeInfo -> ShowS Source #

show :: EncodeInfo -> String Source #

showList :: [ EncodeInfo ] -> ShowS Source #

encodeInfo Source #

Arguments

:: ( FrameFlags -> FrameFlags )
-> Int

stream identifier

-> EncodeInfo

A smart builder of EncodeInfo . 

>>> encodeInfo setAck 0
EncodeInfo {encodeFlags = 1, encodeStreamId = 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. 

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

Decoding payload

decodeFramePayload :: FrameTypeId -> FramePayloadDecoder Source #

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

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

The type for frame payload decoder.

decodeDataFrame :: FramePayloadDecoder Source #

Frame payload decoder for DATA frame.

decodeHeadersFrame :: FramePayloadDecoder Source #

Frame payload decoder for HEADERS frame.

decodePriorityFrame :: FramePayloadDecoder Source #

Frame payload decoder for PRIORITY frame.

decoderstStreamFrame :: FramePayloadDecoder Source #

Frame payload decoder for RST_STREAM frame.

decodeSettingsFrame :: FramePayloadDecoder Source #

Frame payload decoder for SETTINGS frame.

decodePushPromiseFrame :: FramePayloadDecoder Source #

Frame payload decoder for PUSH_PROMISE frame.

decodePingFrame :: FramePayloadDecoder Source #

Frame payload decoder for PING frame.

decodeGoAwayFrame :: FramePayloadDecoder Source #

Frame payload decoder for GOAWAY frame.

decodeWindowUpdateFrame :: FramePayloadDecoder Source #

Frame payload decoder for WINDOW_UPDATE frame.

decodeContinuationFrame :: FramePayloadDecoder Source #

Frame payload decoder for CONTINUATION frame.

Frame type ID

data FrameTypeId Source #

The type for frame type.

Constructors

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

Instances

Instances details
Eq FrameTypeId Source #
Instance details

Defined in Network.HTTP2.Frame.Types

Methods

(==) :: FrameTypeId -> FrameTypeId -> Bool Source #

(/=) :: FrameTypeId -> FrameTypeId -> Bool Source #

Ord FrameTypeId Source #
Instance details

Defined in Network.HTTP2.Frame.Types

Methods

compare :: FrameTypeId -> FrameTypeId -> Ordering Source #

(<) :: FrameTypeId -> FrameTypeId -> Bool Source #

(<=) :: FrameTypeId -> FrameTypeId -> Bool Source #

(>) :: FrameTypeId -> FrameTypeId -> Bool Source #

(>=) :: FrameTypeId -> FrameTypeId -> Bool Source #

max :: FrameTypeId -> FrameTypeId -> FrameTypeId Source #

min :: FrameTypeId -> FrameTypeId -> FrameTypeId Source #

Show FrameTypeId Source #
Instance details

Defined in Network.HTTP2.Frame.Types

Methods

showsPrec :: Int -> FrameTypeId -> ShowS Source #

show :: FrameTypeId -> String Source #

showList :: [ FrameTypeId ] -> ShowS Source #

framePayloadToFrameTypeId :: FramePayload -> FrameTypeId Source #

Getting FrameType from FramePayload . 

>>> framePayloadToFrameTypeId (DataFrame "body")
FrameData

Frame type

type FrameType = Word8 Source #

The type for raw frame type.

fromFrameTypeId :: FrameTypeId -> FrameType Source #

Converting FrameTypeId to FrameType . 

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

toFrameTypeId :: FrameType -> FrameTypeId Source #

Converting FrameType to FrameTypeId . 

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

Priority

data Priority Source #

Type for stream priority

Constructors

Priority

Fields

Instances

Instances details
Eq Priority Source #
Instance details

Defined in Network.HTTP2.Frame.Types

Methods

(==) :: Priority -> Priority -> Bool Source #

(/=) :: Priority -> Priority -> Bool Source #

Read Priority Source #
Instance details

Defined in Network.HTTP2.Frame.Types

Methods

readsPrec :: Int -> ReadS Priority Source #

readList :: ReadS [ Priority ] Source #

readPrec :: ReadPrec Priority Source #

readListPrec :: ReadPrec [ Priority ] Source #

Show Priority Source #
Instance details

Defined in Network.HTTP2.Frame.Types

Methods

showsPrec :: Int -> Priority -> ShowS Source #

show :: Priority -> String Source #

showList :: [ Priority ] -> ShowS Source #

type Weight = Int Source #

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

defaultPriority :: Priority Source #

Default priority which depends on stream 0. 

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

highestPriority :: Priority Source #

Highest priority which depends on stream 0. 

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

defaultWeight :: Weight Source #

Deprecated: Don't use this

Default weight. 

>>> defaultWeight
16

Stream identifier

type StreamId = Int Source #

The type for stream identifier

isControl :: StreamId -> Bool Source #

Checking if the stream identifier for control. 

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

isClientInitiated :: StreamId -> Bool Source #

Checking if the stream identifier is from a client. 

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

isServerInitiated :: StreamId -> Bool Source #

Checking if the stream identifier is from a server. 

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

isRequest :: StreamId -> Bool Source #

Deprecated: Use isClientInitiated instead

Checking if the stream identifier for request. 

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

isResponse :: StreamId -> Bool Source #

Deprecated: Use isServerInitiated instead

Checking if the stream identifier for response. 

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

Stream identifier related

testExclusive :: StreamId -> Bool Source #

Checking if the exclusive flag is set.

setExclusive :: StreamId -> StreamId Source #

Setting the exclusive flag.

clearExclusive :: StreamId -> StreamId Source #

Clearing the exclusive flag.

Flags

type FrameFlags = Word8 Source #

The type for flags.

defaultFlags :: FrameFlags Source #

The initial value of flags. No flags are set. 

>>> defaultFlags
0

testEndStream :: FrameFlags -> Bool Source #

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

testAck :: FrameFlags -> Bool Source #

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

testEndHeader :: FrameFlags -> Bool Source #

Checking if the END_HEADERS flag is set. 

>>> testEndHeader 0x4
True

testPadded :: FrameFlags -> Bool Source #

Checking if the PADDED flag is set. 

>>> testPadded 0x8
True

testPriority :: FrameFlags -> Bool Source #

Checking if the PRIORITY flag is set. 

>>> testPriority 0x20
True

setEndStream :: FrameFlags -> FrameFlags Source #

Setting the END_STREAM flag. 

>>> setEndStream 0
1

setAck :: FrameFlags -> FrameFlags Source #

Setting the ACK flag. 

>>> setAck 0
1

setEndHeader :: FrameFlags -> FrameFlags Source #

Setting the END_HEADERS flag. 

>>> setEndHeader 0
4

setPadded :: FrameFlags -> FrameFlags Source #

Setting the PADDED flag. 

>>> setPadded 0
8

setPriority :: FrameFlags -> FrameFlags Source #

Setting the PRIORITY flag. 

>>> setPriority 0
32

SettingsList

type SettingsList = [( SettingsKeyId , SettingsValue )] Source #

Association list of SETTINGS.

data SettingsKeyId Source #

The type for SETTINGS key.

Constructors

SettingsHeaderTableSize
SettingsEnablePush
SettingsMaxConcurrentStreams
SettingsInitialWindowSize
SettingsMaxFrameSize
SettingsMaxHeaderBlockSize

Instances

Instances details
Bounded SettingsKeyId Source #
Instance details

Defined in Network.HTTP2.Frame.Types

Methods

minBound :: SettingsKeyId Source #

maxBound :: SettingsKeyId Source #

Enum SettingsKeyId Source #
Instance details

Defined in Network.HTTP2.Frame.Types

Methods

succ :: SettingsKeyId -> SettingsKeyId Source #

pred :: SettingsKeyId -> SettingsKeyId Source #

toEnum :: Int -> SettingsKeyId Source #

fromEnum :: SettingsKeyId -> Int Source #

enumFrom :: SettingsKeyId -> [ SettingsKeyId ] Source #

enumFromThen :: SettingsKeyId -> SettingsKeyId -> [ SettingsKeyId ] Source #

enumFromTo :: SettingsKeyId -> SettingsKeyId -> [ SettingsKeyId ] Source #

enumFromThenTo :: SettingsKeyId -> SettingsKeyId -> SettingsKeyId -> [ SettingsKeyId ] Source #

Eq SettingsKeyId Source #
Instance details

Defined in Network.HTTP2.Frame.Types

Methods

(==) :: SettingsKeyId -> SettingsKeyId -> Bool Source #

(/=) :: SettingsKeyId -> SettingsKeyId -> Bool Source #

Ord SettingsKeyId Source #
Instance details

Defined in Network.HTTP2.Frame.Types

Methods

compare :: SettingsKeyId -> SettingsKeyId -> Ordering Source #

(<) :: SettingsKeyId -> SettingsKeyId -> Bool Source #

(<=) :: SettingsKeyId -> SettingsKeyId -> Bool Source #

(>) :: SettingsKeyId -> SettingsKeyId -> Bool Source #

(>=) :: SettingsKeyId -> SettingsKeyId -> Bool Source #

max :: SettingsKeyId -> SettingsKeyId -> SettingsKeyId Source #

min :: SettingsKeyId -> SettingsKeyId -> SettingsKeyId Source #

Read SettingsKeyId Source #
Instance details

Defined in Network.HTTP2.Frame.Types

Methods

readsPrec :: Int -> ReadS SettingsKeyId Source #

readList :: ReadS [ SettingsKeyId ] Source #

readPrec :: ReadPrec SettingsKeyId Source #

readListPrec :: ReadPrec [ SettingsKeyId ] Source #

Show SettingsKeyId Source #
Instance details

Defined in Network.HTTP2.Frame.Types

Methods

showsPrec :: Int -> SettingsKeyId -> ShowS Source #

show :: SettingsKeyId -> String Source #

showList :: [ SettingsKeyId ] -> ShowS Source #

type SettingsValue = Int Source #

The type for raw SETTINGS value.

fromSettingsKeyId :: SettingsKeyId -> Word16 Source #

Converting SettingsKeyId to raw value. 

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

toSettingsKeyId :: Word16 -> Maybe SettingsKeyId Source #

Converting raw value to SettingsKeyId . 

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

Instances

Instances details
Show Settings Source #
Instance details

Defined in Network.HTTP2.Frame.Types

Methods

showsPrec :: Int -> Settings -> ShowS Source #

show :: Settings -> String Source #

showList :: [ Settings ] -> ShowS Source #

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}

Window

type WindowSize = Int Source #

The type for window size.

defaultInitialWindowSize :: WindowSize Source #

The default initial window size. 

>>> defaultInitialWindowSize
65535

maxWindowSize :: WindowSize Source #

The maximum window size. 

>>> maxWindowSize
2147483647

isWindowOverflow :: WindowSize -> Bool Source #

Checking if a window size exceeds the maximum window size. 

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

Error code

type ErrorCode = Word32 Source #

The type for raw error code.

data ErrorCodeId Source #

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

Constructors

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

Instances

Instances details
Eq ErrorCodeId Source #
Instance details

Defined in Network.HTTP2.Frame.Types

Methods

(==) :: ErrorCodeId -> ErrorCodeId -> Bool Source #

(/=) :: ErrorCodeId -> ErrorCodeId -> Bool Source #

Ord ErrorCodeId Source #
Instance details

Defined in Network.HTTP2.Frame.Types

Methods

compare :: ErrorCodeId -> ErrorCodeId -> Ordering Source #

(<) :: ErrorCodeId -> ErrorCodeId -> Bool Source #

(<=) :: ErrorCodeId -> ErrorCodeId -> Bool Source #

(>) :: ErrorCodeId -> ErrorCodeId -> Bool Source #

(>=) :: ErrorCodeId -> ErrorCodeId -> Bool Source #

max :: ErrorCodeId -> ErrorCodeId -> ErrorCodeId Source #

min :: ErrorCodeId -> ErrorCodeId -> ErrorCodeId Source #

Read ErrorCodeId Source #
Instance details

Defined in Network.HTTP2.Frame.Types

Methods

readsPrec :: Int -> ReadS ErrorCodeId Source #

readList :: ReadS [ ErrorCodeId ] Source #

readPrec :: ReadPrec ErrorCodeId Source #

readListPrec :: ReadPrec [ ErrorCodeId ] Source #

Show ErrorCodeId Source #
Instance details

Defined in Network.HTTP2.Frame.Types

Methods

showsPrec :: Int -> ErrorCodeId -> ShowS Source #

show :: ErrorCodeId -> String Source #

showList :: [ ErrorCodeId ] -> ShowS Source #

fromErrorCodeId :: ErrorCodeId -> ErrorCode Source #

Converting ErrorCodeId to ErrorCode . 

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

toErrorCodeId :: ErrorCode -> ErrorCodeId Source #

Converting ErrorCode to ErrorCodeId . 

>>> 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 StreamId

Instances

Instances details
Eq HTTP2Error Source #
Instance details

Defined in Network.HTTP2.Frame.Types

Methods

(==) :: HTTP2Error -> HTTP2Error -> Bool Source #

(/=) :: HTTP2Error -> HTTP2Error -> Bool Source #

Read HTTP2Error Source #
Instance details

Defined in Network.HTTP2.Frame.Types

Methods

readsPrec :: Int -> ReadS HTTP2Error Source #

readList :: ReadS [ HTTP2Error ] Source #

readPrec :: ReadPrec HTTP2Error Source #

readListPrec :: ReadPrec [ HTTP2Error ] Source #

Show HTTP2Error Source #
Instance details

Defined in Network.HTTP2.Frame.Types

Methods

showsPrec :: Int -> HTTP2Error -> ShowS Source #

show :: HTTP2Error -> String Source #

showList :: [ HTTP2Error ] -> ShowS Source #

Exception HTTP2Error Source #
Instance details

Defined in Network.HTTP2.Frame.Types

Methods

toException :: HTTP2Error -> SomeException Source #

fromException :: SomeException -> Maybe HTTP2Error Source #

displayException :: HTTP2Error -> String Source #

errorCodeId :: HTTP2Error -> ErrorCodeId Source #

Obtaining ErrorCodeId from HTTP2Error .

Predefined values

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

recommendedConcurrency :: Int Source #

Default concurrency. 

>>> recommendedConcurrency
100