Safe Haskell	None
Language	Haskell2010

Network.HTTP2

Contents

Decoding and Encoding
Settings
Error code
Frame type
Frame
Stream identifier
Flags
Payload length
Types

Synopsis

Decoding and Encoding

decodeFrame Source

Arguments

:: Settings	HTTP/2 settings
-> ByteString	Input byte-stream
-> Either ErrorCodeId (Frame, ByteString)	(Decoded frame, leftover byte-stream)

Parsing byte stream to make an HTTP/2 frame.

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

Instances

Read EncodeInfo
Show EncodeInfo

encodeFrame :: EncodeInfo -> FramePayload -> ByteString Source

Encoding an HTTP/2 frame to byte stream.

Settings

type SettingsKey = Word16 Source

type SettingsValue = Word32 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

type Settings = Array SettingsKeyId (Maybe SettingsValue) Source

defaultSettings :: Settings Source

Default settings. All values are Nothing.

toSettings :: [(SettingsKeyId, SettingsValue)] -> Settings Source

>>> toSettings [(SettingsHeaderTableSize,10),(SettingsInitialWindowSize,20),(SettingsHeaderTableSize,30)]
array (SettingsHeaderTableSize,SettingsMaxHeaderBlockSize) [(SettingsHeaderTableSize,Just 30),(SettingsEnablePush,Nothing),(SettingsMaxConcurrentStreams,Nothing),(SettingsInitialWindowSize,Just 20),(SettingsMaxFrameSize,Nothing),(SettingsMaxHeaderBlockSize,Nothing)]

fromSettings :: Settings -> [(SettingsKeyId, SettingsValue)] Source

>>> fromSettings $ toSettings [(SettingsHeaderTableSize,10),(SettingsInitialWindowSize,20),(SettingsHeaderTableSize,30)]
[(SettingsHeaderTableSize,30),(SettingsInitialWindowSize,20)]

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 0xd
UnknownErrorCode 13

Frame type

type FrameType = Word8 Source

fromFrameTypeId :: FrameTypeId -> FrameType Source

>>> fromFrameTypeId FrameData
0
>>> fromFrameTypeId FrameContinuation
9

toFrameTypeId :: FrameType -> Maybe FrameTypeId Source

>>> toFrameTypeId 0
Just FrameData
>>> toFrameTypeId 9
Just FrameContinuation
>>> toFrameTypeId 10
Nothing

Frame

data Frame Source

Constructors

Frame
Fields frameHeader :: FrameHeader framePayload :: FramePayload

Instances

Eq Frame
Read Frame
Show Frame

data FrameHeader Source

Constructors

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

Instances

Eq FrameHeader
Read FrameHeader
Show FrameHeader

framePayloadToFrameType :: FramePayload -> FrameType Source

Stream identifier

newtype StreamIdentifier Source

Constructors

StreamIdentifier Word32

Instances

Eq StreamIdentifier
Read StreamIdentifier
Show StreamIdentifier

type StreamDependency = StreamIdentifier Source

type PromisedStreamId = StreamIdentifier Source

type LastStreamId = StreamIdentifier Source

fromStreamIdentifier :: StreamIdentifier -> Word32 Source

toStreamIdentifier :: Word32 -> StreamIdentifier Source

streamIdentifierForSeetings :: StreamIdentifier Source

testExclusive :: Word32 -> Bool Source

setExclusive :: Word32 -> Word32 Source

Flags

type FrameFlags = Word8 Source

defaultFlags :: FrameFlags Source

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

Payload length

type PayloadLength = Int Source

maxPayloadLength :: PayloadLength Source

Types

type WindowSizeIncrement = Word32 Source

type HeaderBlockFragment = ByteString Source

data Priority Source

Constructors

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

Instances

Eq Priority
Read Priority
Show Priority

type Padding = ByteString Source

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

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

Eq ErrorCodeId
Ord ErrorCodeId
Read ErrorCodeId
Show ErrorCodeId

FrameData
FrameHeaders
FramePriority
FrameRSTStream
FrameSettings
FramePushPromise
FramePing
FrameGoAway
FrameWindowUpdate
FrameContinuation

Bounded FrameTypeId
Enum FrameTypeId
Eq FrameTypeId
Ord FrameTypeId
Show FrameTypeId
Ix FrameTypeId

SettingsHeaderTableSize
SettingsEnablePush
SettingsMaxConcurrentStreams
SettingsInitialWindowSize
SettingsMaxFrameSize
SettingsMaxHeaderBlockSize

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