:: a typeCtrl KGHC 9.10.3 · lts/ghc-9.10.x · 248f8f0 · 2026-10-05
Modulehttp-semantics-0.3.0Haskell2010
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.
Request from client.
Getting the method from a request.
Getting the path from a request.
Getting the authority from a request.
Getting the scheme from a request.
Getting the headers from a request.
Getting the body size from a request.
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.
Additional information.
Time handle for the worker processing this request and response.
Local socket address copied from Config.
Remove socket address copied from Config.
Response from server.
Creating response without body.
Creating response with file.
Creating response with streaming.
Creating response with builder.
OutBodyIfaceoutBodyUnmask :: forall x. IO x -> IO xUnmask exceptions in the thread spawned for the request body
This is used in the client: we spawn the new thread for the request body with exceptions masked, and provide the body of OutBodyStreamingIface with a callback to unmask them again (typically after installing an exception handler).
Unmasking in the server is a no-op, as here the scope of the thread that is spawned for the server is the entire handler, not just the response streaming body.
outBodyPush :: Builder -> IO ()Push a new chunk
In http2, there is no direct correspondence between chunks and the
resulting DATA frames sent: the chunks are collected (written to an
internal write buffer) until we can fill a frame.
See also outBodyFlush.
outBodyPushFinal :: Builder -> IO ()Push the final chunk
Using this function instead of outBodyPush can be used to guarantee that the final HTTP2 DATA frame is marked end-of-stream; with outBodyPush it may happen that an additional empty DATA frame is used for this purpose. Additionally, after calling this function, outBodyCancel will be a no-op.
outBodyCancel :: Maybe SomeException -> IO ()Cancel the stream
Sends a RST_STREAM to the peer. If cancelling as the result of an
exception, a Just should be provided which specifies the exception
which will be stored locally as the reason for cancelling the stream; in
this case, the error code sent with the RST_STREAM will be
INTERNAL_ERROR (see
https://datatracker.ietf.org/doc/html/rfc7540#section-7). If Nothing
is given, the error code will be CANCEL.
If there is a partially constructed DATA frame at the time of
cancellation, this frame is discarded. If this is undesirable, you should
call outBodyFlush prior to cancelling.
outBodyFlush :: IO ()Flush
This can be used to emit a DATA frame with the data collected so far (using outBodyPush), even if that DATA frame has not yet reached the maximum frame size. Calling outBodyFlush unnecessarily can therefore result in excessive overhead from frame headers.
If no data is available to send, this is a no-op.
Generalization of responseStreaming.
Getter for response body size. This value is available for file body.
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 bsUsage example:
let h2rsp = responseFile ...
maker = trailersMaker (CH.hashInit :: Context SHA1)
h2rsp' = setResponseTrailersMaker h2rsp makerEither the next trailers maker or final trailers.
TrailersMake to create no trailers.
Setting TrailersMaker to Response.
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.
PushPromisepromiseRequestPath :: ByteStringAccessor for a URL path in a push promise (a virtual request from a server). E.g. "/style/default.css".
promiseResponse :: ResponseAccessor for response actually pushed from a server.
Creating push promise. The third argument is traditional, not used.
Path.
Authority.
"http" or "https".
File specification.
Offset for file.
How many bytes to read
Reading n bytes.
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.)
Position read for files.
Making a position read and its closer.
Position read based on Handle.