Running HTTP/2 client.

"http" or "https".

Authority.

Client configuration

The default client config.

The authority field will be used to set the HTTP2 :authority pseudo-header. In most cases you will want to override it to be equal to host.

Further background on authority: RFC 3986 also allows host:port, and most servers will accept this too. However, when using TLS, many servers will expect the TLS SNI server name and the :authority pseudo-header to be equal, and for TLS SNI the server name should not include the port. Note that HTTP2 explicitly disallows using userinfo@ as part of the authority.

>>> defaultClientConfig
ClientConfig {scheme = "http", authority = "localhost", cacheLimit = 64, connectionWindowSize = 1048576, settings = Settings {headerTableSize = 4096, enablePush = True, maxConcurrentStreams = Just 64, initialWindowSize = 262144, maxFrameSize = 16384, maxHeaderListSize = Nothing}}

https or http

Server name

The maximum number of incoming streams on the net

The window size of connection.

Settings

HTTP/2 settings. See https://datatracker.ietf.org/doc/html/rfc9113#name-defined-settings.

The default settings.

>>> defaultSettings
Settings {headerTableSize = 4096, enablePush = True, maxConcurrentStreams = Just 64, initialWindowSize = 262144, maxFrameSize = 16384, maxHeaderListSize = Nothing}

SETTINGS_HEADER_TABLE_SIZE

SETTINGS_ENABLE_PUSH

SETTINGS_MAX_CONCURRENT_STREAMS

SETTINGS_INITIAL_WINDOW_SIZE

SETTINGS_MAX_FRAME_SIZE

SETTINGS_MAX_HEADER_LIST_SIZE

HTTP/2 configuration.

Making simple configuration whose IO is not efficient. A write buffer is allocated internally.

Deallocating the resource of the simple configuration.

Client type.

Request from client.

Creating request without body.

Creating request with file.

Creating request with streaming.

Like requestStreaming, but run the action with exceptions masked

Creating request with builder.

Trailers maker. A chunks of the response body is passed with Just. The maker should update internal state with the ByteString and return the next trailers maker. When response body reaches its end, Nothing is passed and the maker should generate trailers. An example:

{-# LANGUAGE BangPatterns #-}
import Data.ByteString (ByteString)
import qualified Data.ByteString.Char8 as C8
import Crypto.Hash (Context, SHA1) -- cryptonite
import qualified Crypto.Hash as CH

-- Strictness is important for Context.
trailersMaker :: Context SHA1 -> Maybe ByteString -> IO NextTrailersMaker
trailersMaker ctx Nothing = return $ Trailers [("X-SHA1", sha1)]
  where
    !sha1 = C8.pack $ show $ CH.hashFinalize ctx
trailersMaker ctx (Just bs) = return $ NextTrailersMaker $ trailersMaker ctx'
  where
    !ctx' = CH.hashUpdate ctx bs

Usage example:

let h2rsp = responseFile ...
    maker = trailersMaker (CH.hashInit :: Context SHA1)
    h2rsp' = setResponseTrailersMaker h2rsp maker

Either the next trailers maker or final trailers.

TrailersMake to create no trailers.

Setting TrailersMaker to Response.

Response from server.

Getting the status of a response.

Getting the headers from a response.

Getting the body size from a response.

Reading a chunk of the response body. An empty ByteString returned when finished.

Reading response trailers. This function must be called after getResponseBodyChunk returns an empty.

Additional information.

How many streams can be created without blocking.

HTTP method (flat ByteString type).

Path.

File specification.

Offset for file.

How many bytes to read

The connection error or the stream error. Stream errors are treated as connection errors since there are no good recovery ways. ErrorCode in connection errors should be the highest stream identifier but in this implementation it identifies the stream that caused this error.

The type for raw error code.

Naive implementation for readN.

Making a position read and its closer.

Position read for files.

Manipulating a file resource.

Position read based on Handle.