http-semantics-0.0.0: HTTP senmatics libarry
Safe HaskellNone
LanguageHaskell2010

Network.HTTP.Semantics.Server

Synopsis

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

data Request #

Request from client.

Instances

Instances details
Show Request # 
Instance details

Defined in Network.HTTP.Semantics.Server.Internal

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

data Aux #

Additional information.

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

data Response #

Response from server.

Instances

Instances details
Show Response # 
Instance details

Defined in Network.HTTP.Semantics.Server.Internal

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.

defaultTrailersMaker :: TrailersMaker #

TrailersMake to create no trailers.

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 Authority = String #

Authority.

type Scheme = ByteString #

"http" or "https".

data FileSpec #

File specification.

Instances

Instances details
Show FileSpec # 
Instance details

Defined in Network.HTTP.Semantics.Types

Eq FileSpec # 
Instance details

Defined in Network.HTTP.Semantics.Types

type FileOffset = Int64 #

Offset for file.

type ByteCount = Int64 #

How many bytes to read

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.

data Sentinel #

Constructors

Closer (IO ())

Closing a file resource. Its refresher is automatiaclly generated by the internal timer.

Refresher (IO ())

Refreshing a file resource while reading. Closing the file must be done by its own timer or something.