-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | HTTP/2.0 library including HPACK
--   
@package http2
@version 0.6.0

module Network.HTTP2

-- | Parsing byte stream to make an HTTP/2 frame.
decodeFrame :: Settings -> ByteString -> Either ErrorCodeId (Frame, ByteString)

-- | Auxiliary information for frame encoding.
data EncodeInfo
EncodeInfo :: FrameFlags -> StreamIdentifier -> Maybe Padding -> EncodeInfo

-- | Flags to be set in a frame header
encodeFlags :: EncodeInfo -> FrameFlags

-- | Stream id to be set in a frame header
encodeStreamId :: EncodeInfo -> StreamIdentifier

-- | Padding if any
encodePadding :: EncodeInfo -> Maybe Padding

-- | Encoding an HTTP/2 frame to byte stream.
encodeFrame :: EncodeInfo -> FramePayload -> ByteString
type SettingsKey = Word16
data SettingsKeyId
SettingsHeaderTableSize :: SettingsKeyId
SettingsEnablePush :: SettingsKeyId
SettingsMaxConcurrentStreams :: SettingsKeyId
SettingsInitialWindowSize :: SettingsKeyId
SettingsMaxFrameSize :: SettingsKeyId
SettingsMaxHeaderBlockSize :: SettingsKeyId
type SettingsValue = Word32

-- | <pre>
--   &gt;&gt;&gt; fromSettingsKeyId SettingsHeaderTableSize
--   1
--   
--   &gt;&gt;&gt; fromSettingsKeyId SettingsMaxHeaderBlockSize
--   6
--   </pre>
fromSettingsKeyId :: SettingsKeyId -> Word16

-- | <pre>
--   &gt;&gt;&gt; toSettingsKeyId 0
--   Nothing
--   
--   &gt;&gt;&gt; toSettingsKeyId 1
--   Just SettingsHeaderTableSize
--   
--   &gt;&gt;&gt; toSettingsKeyId 6
--   Just SettingsMaxHeaderBlockSize
--   
--   &gt;&gt;&gt; toSettingsKeyId 7
--   Nothing
--   </pre>
toSettingsKeyId :: Word16 -> Maybe SettingsKeyId
type Settings = Array SettingsKeyId (Maybe SettingsValue)

-- | Default settings. All values are <a>Nothing</a>.
defaultSettings :: Settings

-- | <pre>
--   &gt;&gt;&gt; toSettings [(SettingsHeaderTableSize,10),(SettingsInitialWindowSize,20),(SettingsHeaderTableSize,30)]
--   array (SettingsHeaderTableSize,SettingsMaxHeaderBlockSize) [(SettingsHeaderTableSize,Just 30),(SettingsEnablePush,Nothing),(SettingsMaxConcurrentStreams,Nothing),(SettingsInitialWindowSize,Just 20),(SettingsMaxFrameSize,Nothing),(SettingsMaxHeaderBlockSize,Nothing)]
--   </pre>
toSettings :: [(SettingsKeyId, SettingsValue)] -> Settings

-- | <pre>
--   &gt;&gt;&gt; fromSettings $ toSettings [(SettingsHeaderTableSize,10),(SettingsInitialWindowSize,20),(SettingsHeaderTableSize,30)]
--   [(SettingsHeaderTableSize,30),(SettingsInitialWindowSize,20)]
--   </pre>
fromSettings :: Settings -> [(SettingsKeyId, SettingsValue)]
type ErrorCode = Word32
data ErrorCodeId
NoError :: ErrorCodeId
ProtocolError :: ErrorCodeId
InternalError :: ErrorCodeId
FlowControlError :: ErrorCodeId
SettingsTimeout :: ErrorCodeId
StreamClosed :: ErrorCodeId
FrameSizeError :: ErrorCodeId
RefusedStream :: ErrorCodeId
Cancel :: ErrorCodeId
CompressionError :: ErrorCodeId
ConnectError :: ErrorCodeId
EnhanceYourCalm :: ErrorCodeId
InadequateSecurity :: ErrorCodeId
UnknownErrorCode :: ErrorCode -> ErrorCodeId
UnknownError :: String -> ErrorCodeId

-- | <pre>
--   &gt;&gt;&gt; fromErrorCodeId NoError
--   0
--   
--   &gt;&gt;&gt; fromErrorCodeId InadequateSecurity
--   12
--   </pre>
fromErrorCodeId :: ErrorCodeId -> ErrorCode

-- | <pre>
--   &gt;&gt;&gt; toErrorCodeId 0
--   NoError
--   
--   &gt;&gt;&gt; toErrorCodeId 0xc
--   InadequateSecurity
--   
--   &gt;&gt;&gt; toErrorCodeId 0xd
--   UnknownErrorCode 13
--   </pre>
toErrorCodeId :: ErrorCode -> ErrorCodeId
type FrameType = Word8
data FrameTypeId
FrameData :: FrameTypeId
FrameHeaders :: FrameTypeId
FramePriority :: FrameTypeId
FrameRSTStream :: FrameTypeId
FrameSettings :: FrameTypeId
FramePushPromise :: FrameTypeId
FramePing :: FrameTypeId
FrameGoAway :: FrameTypeId
FrameWindowUpdate :: FrameTypeId
FrameContinuation :: FrameTypeId

-- | <pre>
--   &gt;&gt;&gt; fromFrameTypeId FrameData
--   0
--   
--   &gt;&gt;&gt; fromFrameTypeId FrameContinuation
--   9
--   </pre>
fromFrameTypeId :: FrameTypeId -> FrameType

-- | <pre>
--   &gt;&gt;&gt; toFrameTypeId 0
--   Just FrameData
--   
--   &gt;&gt;&gt; toFrameTypeId 9
--   Just FrameContinuation
--   
--   &gt;&gt;&gt; toFrameTypeId 10
--   Nothing
--   </pre>
toFrameTypeId :: FrameType -> Maybe FrameTypeId
data Frame
Frame :: FrameHeader -> FramePayload -> Frame
frameHeader :: Frame -> FrameHeader
framePayload :: Frame -> FramePayload
data FrameHeader
FrameHeader :: PayloadLength -> FrameFlags -> StreamIdentifier -> FrameHeader
payloadLength :: FrameHeader -> PayloadLength
flags :: FrameHeader -> FrameFlags
streamId :: FrameHeader -> StreamIdentifier
data FramePayload
DataFrame :: ByteString -> FramePayload
HeadersFrame :: (Maybe Priority) -> HeaderBlockFragment -> FramePayload
PriorityFrame :: Priority -> FramePayload
RSTStreamFrame :: ErrorCodeId -> FramePayload
SettingsFrame :: Settings -> FramePayload
PushPromiseFrame :: PromisedStreamId -> HeaderBlockFragment -> FramePayload
PingFrame :: ByteString -> FramePayload
GoAwayFrame :: LastStreamId -> ErrorCodeId -> ByteString -> FramePayload
WindowUpdateFrame :: WindowSizeIncrement -> FramePayload
ContinuationFrame :: HeaderBlockFragment -> FramePayload
UnknownFrame :: FrameType -> ByteString -> FramePayload
framePayloadToFrameType :: FramePayload -> FrameType
newtype StreamIdentifier
StreamIdentifier :: Word32 -> StreamIdentifier
type StreamDependency = StreamIdentifier
type PromisedStreamId = StreamIdentifier
type LastStreamId = StreamIdentifier
fromStreamIdentifier :: StreamIdentifier -> Word32
toStreamIdentifier :: Word32 -> StreamIdentifier
streamIdentifierForSeetings :: StreamIdentifier
testExclusive :: Word32 -> Bool
setExclusive :: Word32 -> Word32
type FrameFlags = Word8
defaultFlags :: FrameFlags

-- | <pre>
--   &gt;&gt;&gt; testEndStream 0x1
--   True
--   </pre>
testEndStream :: FrameFlags -> Bool

-- | <pre>
--   &gt;&gt;&gt; testAck 0x1
--   True
--   </pre>
testAck :: FrameFlags -> Bool

-- | <pre>
--   &gt;&gt;&gt; testEndHeader 0x4
--   True
--   </pre>
testEndHeader :: FrameFlags -> Bool

-- | <pre>
--   &gt;&gt;&gt; testPadded 0x8
--   True
--   </pre>
testPadded :: FrameFlags -> Bool

-- | <pre>
--   &gt;&gt;&gt; testPriority 0x20
--   True
--   </pre>
testPriority :: FrameFlags -> Bool

-- | <pre>
--   &gt;&gt;&gt; setEndStream 0
--   1
--   </pre>
setEndStream :: FrameFlags -> FrameFlags

-- | <pre>
--   &gt;&gt;&gt; setAck 0
--   1
--   </pre>
setAck :: FrameFlags -> FrameFlags

-- | <pre>
--   &gt;&gt;&gt; setEndHeader 0
--   4
--   </pre>
setEndHeader :: FrameFlags -> FrameFlags

-- | <pre>
--   &gt;&gt;&gt; setPadded 0
--   8
--   </pre>
setPadded :: FrameFlags -> FrameFlags

-- | <pre>
--   &gt;&gt;&gt; setPriority 0
--   32
--   </pre>
setPriority :: FrameFlags -> FrameFlags
type PayloadLength = Int
maxPayloadLength :: PayloadLength
type WindowSizeIncrement = Word32
type HeaderBlockFragment = ByteString
data Priority
Priority :: Bool -> StreamIdentifier -> Int -> Priority
exclusive :: Priority -> Bool
streamDependency :: Priority -> StreamIdentifier
weight :: Priority -> Int
type Padding = ByteString


-- | HPACK: encoding and decoding a header list.
module Network.HPACK

-- | HPACK encoding, from <a>HeaderList</a> to <a>ByteStream</a>.
type HPACKEncoding = Context -> HeaderList -> IO (Context, ByteStream)

-- | HPACK decoding, from <a>ByteStream</a> to <a>HeaderList</a>.
type HPACKDecoding = Context -> ByteStream -> IO (Context, HeaderList)

-- | Converting <a>HeaderList</a> for HTTP request to the low level format.
encodeHeader :: EncodeStrategy -> HPACKEncoding

-- | Converting the low level format for HTTP request to <a>HeaderList</a>.
--   <a>DecodeError</a> would be thrown.
decodeHeader :: HPACKDecoding

-- | Context for HPACK encoding/decoding. This is destructive!
data Context

-- | Creating a new <a>Context</a>. The first argument is the size of a
--   header table.
newContextForEncoding :: Size -> IO Context

-- | Creating a new <a>Context</a>. The first argument is the size of a
--   header table.
newContextForDecoding :: Size -> IO Context

-- | Compression algorithms for HPACK encoding.
data CompressionAlgo

-- | No compression
Naive :: CompressionAlgo

-- | Using the static table only
Static :: CompressionAlgo

-- | Using indices only
Linear :: CompressionAlgo

-- | Strategy for HPACK encoding.
data EncodeStrategy
EncodeStrategy :: CompressionAlgo -> Bool -> EncodeStrategy

-- | Which compression algorithm is used.
compressionAlgo :: EncodeStrategy -> CompressionAlgo

-- | Whether or not to use Huffman encoding for strings.
useHuffman :: EncodeStrategy -> Bool

-- | Default <a>EncodeStrategy</a>. <a>compressionAlgo</a> is <a>Linear</a>
--   and <a>useHuffman</a> is <a>True</a>.
defaultEncodeStrategy :: EncodeStrategy

-- | Errors for decoder.
data DecodeError

-- | Index is out of range
IndexOverrun :: Index -> DecodeError

-- | Eos appears in the middle of huffman string
EosInTheMiddle :: DecodeError

-- | Non-eos appears in the end of huffman string
IllegalEos :: DecodeError

-- | Eos of huffman string is more than 7 bits
TooLongEos :: DecodeError

-- | Encoded string has no length
EmptyEncodedString :: DecodeError

-- | Header block is empty
EmptyBlock :: DecodeError

-- | Header list.
type HeaderList = [Header]

-- | Header.
type Header = (HeaderName, HeaderValue)

-- | Header name.
type HeaderName = ByteString

-- | Header value.
type HeaderValue = ByteString

-- | Byte stream in HTTP request/response.
type ByteStream = ByteString

-- | Size in bytes.
type Size = Int

-- | Index for table.
type Index = Int