http2-0.7.0: HTTP/2.0 library including frames and HPACK

Safe HaskellNone
LanguageHaskell2010

Network.HTTP2

Contents

Synopsis

Magic

connectionPreface :: ByteString Source

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

connectionPrefaceLength :: Int Source

Length of the preface

Encoding and decoding

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

encodeInfo :: (FrameFlags -> FrameFlags) -> Int -> EncodeInfo Source

A smart builder of EncodeInfo.

encodeFrame :: EncodeInfo -> FramePayload -> ByteString Source

Encoding an HTTP/2 frame to byte stream.

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.

Settings

type SettingsKey = Word16 Source

data SettingsKeyId Source

Constructors

SettingsHeaderTableSize 
SettingsEnablePush 
SettingsMaxConcurrentStreams 
SettingsInitialWindowSize 
SettingsMaxFrameSize 
SettingsMaxHeaderBlockSize 

Instances

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

data Settings Source

Constructors

Settings 

Fields

headerTableSize :: Int
 
establishPush :: Bool
 
maxConcurrentStreams :: Int
 
initialWindowSize :: Int
 
maxFrameSize :: Int
 
maxHeaderBlockSize :: Maybe Int
 

Instances

type SettingsList = [(SettingsKeyId, SettingsValue)] Source

defaultSettings :: Settings Source

The default settings.

updateSettings :: Settings -> SettingsList -> Settings Source

Updating settings.

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

Error code

type ErrorCode = Word32 Source

data ErrorCodeId Source

Constructors

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

Instances

fromErrorCodeId :: ErrorCodeId -> ErrorCode Source

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

toErrorCodeId :: ErrorCode -> ErrorCodeId Source

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

Frame type

type FrameType = Word8 Source

data FrameTypeId Source

Constructors

FrameData 
FrameHeaders 
FramePriority 
FrameRSTStream 
FrameSettings 
FramePushPromise 
FramePing 
FrameGoAway 
FrameWindowUpdate 
FrameContinuation 

Instances

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

data FrameHeader Source

Constructors

FrameHeader 

Fields

payloadLength :: PayloadLength
 
flags :: FrameFlags
 
streamId :: StreamIdentifier
 

Instances

data FramePayload Source

Constructors

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 

Instances

framePayloadToFrameType :: FramePayload -> FrameType Source

Stream identifier

newtype StreamIdentifier Source

Constructors

StreamIdentifier Int 

Instances

type StreamDependency = StreamIdentifier Source

type PromisedStreamId = StreamIdentifier Source

type LastStreamId = StreamIdentifier Source

fromStreamIdentifier :: StreamIdentifier -> Int Source

toStreamIdentifier :: Int -> StreamIdentifier Source

streamIdentifierForSeetings :: StreamIdentifier Source

testExclusive :: Int -> Bool Source

setExclusive :: Int -> Int 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

type Padding = ByteString Source