Network.QPACK

Thread-safe QPACK encoder/decoder.

Encoder

data QEncoderConfig

Configuration for QPACK encoder.

Constructors

QEncoderConfig

Fields

• ecDynamicTableSize :: Size
• ecHeaderBlockBufferSize :: Size
• ecPrefixBufferSize :: Size
• ecInstructionBufferSize :: Size
• encStrategy :: EncodeStrategy

Instances

Show QEncoderConfig

Defined in Network.QPACK

Methods

showsPrec :: Int -> QEncoderConfig -> ShowS

show :: QEncoderConfig -> String

showList :: [QEncoderConfig] -> ShowS

defaultQEncoderConfig :: QEncoderConfig

Default configuration for QPACK encoder.

>>> defaultQEncoderConfig
QEncoderConfig {ecDynamicTableSize = 4096, ecHeaderBlockBufferSize = 4096, ecPrefixBufferSize = 128, ecInstructionBufferSize = 4096, encStrategy = EncodeStrategy {compressionAlgo = Static, useHuffman = True}}

type QEncoder = TokenHeaderList -> IO (EncodedFieldSection, EncodedEncoderInstruction)

QPACK encoder.

newQEncoder :: QEncoderConfig -> IO (QEncoder, DecoderInstructionHandler)

Creating a new QPACK encoder.

Decoder

data QDecoderConfig

Configuration for QPACK decoder.

Constructors

QDecoderConfig

Fields

• dcDynamicTableSize :: Size
• dcHuffmanBufferSize :: Size

Instances

Show QDecoderConfig

Defined in Network.QPACK

Methods

showsPrec :: Int -> QDecoderConfig -> ShowS

show :: QDecoderConfig -> String

showList :: [QDecoderConfig] -> ShowS

defaultQDecoderConfig :: QDecoderConfig

Default configuration for QPACK decoder.

>>> defaultQDecoderConfig
QDecoderConfig {dcDynamicTableSize = 4096, dcHuffmanBufferSize = 4096}

type QDecoder = EncodedFieldSection -> IO TokenHeaderTable

QPACK decoder.

newQDecoder :: QDecoderConfig -> IO (QDecoder, EncoderInstructionHandler)

Creating a new QPACK decoder.

Decoder for debugging

type QDecoderS = EncodedFieldSection -> IO [Header]

QPACK simple decoder.

newQDecoderS :: QDecoderConfig -> Bool -> IO (QDecoderS, EncoderInstructionHandlerS)

Creating a new simple QPACK decoder.

Types

type EncodedEncoderInstruction = ByteString

Encoded encoder instruction.

type EncoderInstructionHandler = (Int -> IO EncodedEncoderInstruction) -> IO ()

Encoder instruction handler.

type EncoderInstructionHandlerS = EncodedEncoderInstruction -> IO ()

Simple encoder instruction handler.

type EncodedDecoderInstruction = ByteString

Encoded decoder instruction.

type DecoderInstructionHandler = (Int -> IO EncodedDecoderInstruction) -> IO ()

Decoder instruction handler.

type InstructionHandler = (Int -> IO ByteString) -> IO ()

A type to integrating handlers.

type Size = Int

Size in bytes.

Strategy

data EncodeStrategy

Strategy for HPACK encoding.

Constructors

EncodeStrategy

Fields

• compressionAlgo :: CompressionAlgo

  Which compression algorithm is used.

• useHuffman :: Bool

  Whether or not to use Huffman encoding for strings.

Instances

Show EncodeStrategy

Defined in Network.HPACK.Types

Methods

showsPrec :: Int -> EncodeStrategy -> ShowS

show :: EncodeStrategy -> String

showList :: [EncodeStrategy] -> ShowS

Eq EncodeStrategy

Defined in Network.HPACK.Types

Methods

(==) :: EncodeStrategy -> EncodeStrategy -> Bool

(/=) :: EncodeStrategy -> EncodeStrategy -> Bool

data CompressionAlgo

Compression algorithms for HPACK encoding.

Constructors

Naive

No compression

Static

Using indices in the static table only

Linear

Using indices

Instances

Show CompressionAlgo

Defined in Network.HPACK.Types

Methods

showsPrec :: Int -> CompressionAlgo -> ShowS

show :: CompressionAlgo -> String

showList :: [CompressionAlgo] -> ShowS

Eq CompressionAlgo

Defined in Network.HPACK.Types

Methods

(==) :: CompressionAlgo -> CompressionAlgo -> Bool

(/=) :: CompressionAlgo -> CompressionAlgo -> Bool

Re-exports

type TokenHeaderTable = (TokenHeaderList, ValueTable)

A pair of token list and value table.

type TokenHeaderList = [TokenHeader]

TokenBased header list.

type ValueTable = Array Int (Maybe FieldValue)

An array to get FieldValue quickly. getHeaderValue should be used. Internally, the key is tokenIx.

type Header = (HeaderName, ByteString)

A full HTTP header field with the name and value separated.

E.g. "Content-Length: 28" parsed into a Header would turn into ("Content-Length", "28")

getFieldValue :: Token -> ValueTable -> Maybe FieldValue

Accessing FieldValue with Token.

toTokenHeaderTable :: [Header] -> IO TokenHeaderTable

Converting a header list of the http-types style to TokenHeaderList and ValueTable.

original :: CI s -> s

Retrieve the original string-like value.

foldedCase :: CI s -> s

Retrieve the case folded string-like value. (Also see foldCase).

mk :: FoldCase s => s -> CI s

Make the given string-like value case insensitive.