Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
Synopsis
- type Server = Request -> Aux -> (Response -> [PushPromise] -> IO ()) -> IO ()
- data Request
- requestMethod :: Request -> Maybe Method
- requestPath :: Request -> Maybe Path
- requestAuthority :: Request -> Maybe Authority
- requestScheme :: Request -> Maybe Scheme
- requestHeaders :: Request -> TokenHeaderTable
- requestBodySize :: Request -> Maybe Int
- getRequestBodyChunk :: Request -> IO ByteString
- getRequestTrailers :: Request -> IO (Maybe TokenHeaderTable)
- data Aux
- auxTimeHandle :: Aux -> Handle
- auxMySockAddr :: Aux -> SockAddr
- auxPeerSockAddr :: Aux -> SockAddr
- data Response
- responseNoBody :: Status -> ResponseHeaders -> Response
- responseFile :: Status -> ResponseHeaders -> FileSpec -> Response
- responseStreaming :: Status -> ResponseHeaders -> ((Builder -> IO ()) -> IO () -> IO ()) -> Response
- responseBuilder :: Status -> ResponseHeaders -> Builder -> Response
- responseBodySize :: Response -> Maybe Int
- type TrailersMaker = Maybe ByteString -> IO NextTrailersMaker
- data NextTrailersMaker
- defaultTrailersMaker :: TrailersMaker
- setResponseTrailersMaker :: Response -> TrailersMaker -> Response
- data PushPromise = PushPromise {}
- pushPromise :: ByteString -> Response -> Int -> PushPromise
- type Path = ByteString
- type Authority = String
- type Scheme = ByteString
- data FileSpec = FileSpec FilePath FileOffset ByteCount
- type FileOffset = Int64
- type ByteCount = Int64
- type ReadN = Int -> IO ByteString
- defaultReadN :: Socket -> IORef (Maybe ByteString) -> ReadN
- type PositionRead = FileOffset -> ByteCount -> Buffer -> IO ByteCount
- type PositionReadMaker = FilePath -> IO (PositionRead, Sentinel)
- data Sentinel
- defaultPositionReadMaker :: PositionReadMaker
HTTP server
type Server = Request -> Aux -> (Response -> [PushPromise] -> IO ()) -> IO () Source #
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.
Request
Request from client.
Accessing request
requestHeaders :: Request -> TokenHeaderTable Source #
Getting the headers from a request.
getRequestBodyChunk :: Request -> IO ByteString Source #
Reading a chunk of the request body.
An empty ByteString
returned when finished.
getRequestTrailers :: Request -> IO (Maybe TokenHeaderTable) Source #
Reading request trailers.
This function must be called after getRequestBodyChunk
returns an empty.
Aux
auxTimeHandle :: Aux -> Handle Source #
Time handle for the worker processing this request and response.
auxMySockAddr :: Aux -> SockAddr Source #
Local socket address copied from Config
.
auxPeerSockAddr :: Aux -> SockAddr Source #
Remove socket address copied from Config
.
Response
Response from server.
Creating response
responseNoBody :: Status -> ResponseHeaders -> Response Source #
Creating response without body.
responseFile :: Status -> ResponseHeaders -> FileSpec -> Response Source #
Creating response with file.
responseStreaming :: Status -> ResponseHeaders -> ((Builder -> IO ()) -> IO () -> IO ()) -> Response Source #
Creating response with streaming.
responseBuilder :: Status -> ResponseHeaders -> Builder -> Response Source #
Creating response with builder.
Accessing response
responseBodySize :: Response -> Maybe Int Source #
Getter for response body size. This value is available for file body.
Trailers maker
type TrailersMaker = Maybe ByteString -> IO NextTrailersMaker Source #
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
data NextTrailersMaker Source #
Either the next trailers maker or final trailers.
defaultTrailersMaker :: TrailersMaker Source #
TrailersMake to create no trailers.
setResponseTrailersMaker :: Response -> TrailersMaker -> Response Source #
Setting TrailersMaker
to Response
.
Push promise
data PushPromise Source #
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
.
PushPromise | |
|
pushPromise :: ByteString -> Response -> Int -> PushPromise Source #
Creating push promise. The third argument is traditional, not used.
Types
type Path = ByteString Source #
Path.
type Scheme = ByteString Source #
"http" or "https".
type FileOffset = Int64 Source #
Offset for file.
Reading n bytes
defaultReadN :: Socket -> IORef (Maybe ByteString) -> ReadN Source #
Naive implementation for readN.
Position read
type PositionRead = FileOffset -> ByteCount -> Buffer -> IO ByteCount Source #
Position read for files.
type PositionReadMaker = FilePath -> IO (PositionRead, Sentinel) Source #
Making a position read and its closer.
defaultPositionReadMaker :: PositionReadMaker Source #
Position read based on Handle
.