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