Network.HTTP2.Server

Running HTTP/2 server.

Server configuration

The default server config.

>>> defaultServerConfigServerConfig {numberOfWorkers = 8, connectionWindowSize = 16777216, settings = Settings {headerTableSize = 4096, enablePush = True, maxConcurrentStreams = Just 64, initialWindowSize = 262144, maxFrameSize = 16384, maxHeaderListSize = Nothing, pingRateLimit = 10, emptyFrameRateLimit = 4, settingsRateLimit = 4, rstRateLimit = 4}}

Deprecated field.

The window size of incoming streams

Settings

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

The default settings.

>>> defaultSettingsSettings {headerTableSize = 4096, enablePush = True, maxConcurrentStreams = Just 64, initialWindowSize = 262144, maxFrameSize = 16384, maxHeaderListSize = Nothing, pingRateLimit = 10, emptyFrameRateLimit = 4, settingsRateLimit = 4, rstRateLimit = 4}

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.

Default config. This is just a template to modify via field names. Don't use this without modifications.

This is used only by frameSender. This MUST be freed after frameSender is terminated.

The size of the write buffer. We assume that the read buffer is the same size. So, this value is announced via SETTINGS_MAX_FRAME_SIZE to the peer.

This is copied into Aux, if exist, on server.

This is copied into Aux, if exist, on server.

Client only: called when a 1xx informational response (e.g. 103 Early Hints) is received on the given stream, ahead of the final response. No-op by default.

Making simple configuration whose IO is not efficient. A write buffer is allocated internally. WAI timeout manger is initialized with 30_000_000 microseconds.

Making simple configuration whose IO is not efficient. A write buffer is allocated internally. The third argument is microseconds to initialize WAI timeout manager.

Deallocating the resource of the simple configuration.

This does not cancel timeout actions registered with confTimeoutManager. Since time-manager 0.3, a manager holds no registrations, so there is nothing to kill: an action registered with register runs even after this returns unless it is cancelled with cancel. Use withHandle, which cancels it when the scope ends.

Position read based on Handle.

Naive implementation for readN.

NOTE: This function is intended to be used by a single thread only. (It is probably quite rare anyway to want concurrent reads from the same network socket.)

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

Generalization of getRequestBodyChunk which also returns if the ByteString is the final one

Reading request trailers. This function must be called after getRequestBodyChunk returns an empty.

Creating push promise. The third argument is traditional, not used.

Getting the authority from a request.

Getting the body size from a request.

Getting the headers from a request.

Getting the method from a request.

Getting the path from a request.

Getting the scheme from a request.

Getter for response body size. This value is available for file body.

Creating response with builder.

Creating response with file.

Creating response without body.

Creating response with streaming.

Generalization of responseStreaming.

Setting TrailersMaker to Response.

TrailersMake to create no trailers.

Position read for files.

Making a position read and its closer.

Reading n bytes.

HTTP/2 push promise or sever push. Pseudo REQUEST headers in push promise is automatically generated. Then, a server push is sent according to promiseResponse.

Server type. Server takes a HTTP request, should generate a HTTP response and push promises, then should give them to the sending function. The sending function would throw exceptions so that they can be logged.

The sending function must only be called once.

Additional information.

Local socket address copied from Config.

Remove socket address copied from Config.

Send an informational (1xx) response, e.g. 103 Early Hints, on this request's stream before the final response. May be called multiple times. A no-op in defaultAux.

Time handle for the worker processing this request and response.

Request from client.

Response from server.

Either the next trailers maker or final trailers.

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

Authority.

How many bytes to read

Offset for file.

File specification.

Path.

"http" or "https".