Network.HPACK

HPACK: encoding and decoding a header set.

Encoding and decoding

type HPACKEncoding = Context -> HeaderSet -> IO (Context, ByteStream)

HPACK encoding, from HeaderSet to ByteStream.

type HPACKDecoding = Context -> ByteStream -> IO (Context, HeaderSet)

HPACK decoding, from ByteStream to HeaderSet.

Request

encodeRequestHeader :: HPACKEncoding

Converting HeaderSet for HTTP request to the low level format.

decodeRequestHeader :: HPACKDecoding

Converting the low level format for HTTP request to HeaderSet. DecodeError would be thrown.

Response

encodeResponseHeader :: HPACKEncoding

Converting HeaderSet for HTTP response to the low level format.

decodeResponseHeader :: HPACKDecoding

Converting the low level format for HTTP response to HeaderSet. DecodeError would be thrown.

Contenxt

data Context

Context for HPACK encoding/decoding.

newContext :: Size -> IO Context

Creating a new Context. The first argument is the size of a header table.

Errors for decoding

data DecodeError

Errors for decoder.

Constructors

IndexOverrun Index

Index is out of range

EosInTheMiddle

Eos appears in the middle of huffman string

IllegalEos

Non-eos appears in the end of huffman string

TooLongEos

Eos of huffman string is more than 7 bits

EmptyEncodedString

Encoded string has no length

EmptyBlock

Header block is empty

Instances

Eq DecodeError

Show DecodeError

Typeable DecodeError

Exception DecodeError

Headers

type HeaderSet = [Header]

Header set.

type Header = (HeaderName, HeaderValue)

Header.

type HeaderName = ByteString

Header name.

type HeaderValue = ByteString

Header value.

Basic types

type ByteStream = ByteString

Byte stream in HTTP request/response.

type Size = Int

Size in bytes.

type Index = Int

Index for table.