Network.HTTP2.Client.Helpers

Documentation

data TimedOut

Opaque type to express an action which timed out.

Constructors

TimedOut

Instances

Show TimedOut

Methods

showsPrec :: Int -> TimedOut -> ShowS

show :: TimedOut -> String

showList :: [TimedOut] -> ShowS

type PingReply = (UTCTime, UTCTime, Either TimedOut (FrameHeader, FramePayload))

Result for a ping.

ping

Arguments

:: Http2Client

client connection

-> Int

timeout in microseconds

-> ByteString

8-bytes message to uniquely identify the reply

-> IO PingReply

Performs a ping and waits for a reply up to a given timeout (in microseconds).

type StreamResult = (Either ErrorCode HeaderList, [Either ErrorCode ByteString])

Result containing the unpacked headers and all frames received in on a stream. See StreamResponse and fromStreamResult to get a higher-level utility.

type StreamResponse = (HeaderList, ByteString)

An HTTP2 response, once fully received, is made of headers and a payload.

waitStream :: Http2Stream -> IncomingFlowControl -> IO StreamResult

Wait for a stream until completion.

This function is fine if you don't want to consume results in chunks.

fromStreamResult :: StreamResult -> Either ErrorCode StreamResponse

Converts a StreamResult to a StramResponse, stopping at the first error using the `Either HTTP2.ErrorCode` monad.

onPushPromise :: Http2Stream -> PushPromiseHandler -> IO ()

Sequentially wait for every push-promise with a handler.

This function runs forever and you should wrap it with withAsync.