Hails.HttpServer.Types

Requests

data Request

A request sent by the end-user.

Constructors

Request

Fields

requestMethod :: Method

HTTP Request (e.g., GET, POST, etc.).

httpVersion :: HttpVersion

HTTP version (e.g., 1.1 or 1.0).

rawPathInfo :: ByteString

Extra path information sent by the client.

rawQueryString :: ByteString

If no query string was specified, this should be empty. This value will include the leading question mark. Do not modify this raw value- modify queryString instead.

serverName :: ByteString

Generally the host requested by the user via the Host request header. Backends are free to provide alternative values as necessary. This value should not be used to construct URLs.

serverPort :: Int

The listening port that the server received this request on. It is possible for a server to listen on a non-numeric port (i.e., Unix named socket), in which case this value will be arbitrary. Like serverName, this value should not be used in URL construction.

requestHeaders :: RequestHeaders

The request headers.

isSecure :: Bool

Was this request made over an SSL connection?

remoteHost :: SockAddr

The client's host information.

pathInfo :: [Text]

Path info in individual pieces- the url without a hostname/port and without a query string, split on forward slashes,

queryString :: Query

Parsed query string information

requestBody :: ByteString

Lazy ByteString containing the request body.

requestTime :: UTCTime

Time request was received.

Instances

Show Request

Routeable Application

getRequestBodyType :: Request -> Maybe RequestBodyType

Get the request body type (copied from wai-extra).

data RequestBodyType

Constructors

UrlEncoded

Multipart ByteString

addRequestHeader :: Request -> Header -> Request

Add/replace a Header to the Request

removeRequestHeader :: Request -> HeaderName -> Request

Remove a header (if it exists) from the Request

Responses

data Response

A response sent by the app.

Constructors

Response

Fields

respStatus :: Status

Response status

respHeaders :: ResponseHeaders

Response headers

respBody :: ByteString

Response body

Instances

Show Response

Routeable Application

Routeable Response

Routeable (Controller Response)

module Network.HTTP.Types

addResponseHeader :: Response -> Header -> Response

Add/replace a Header to the Response

removeResponseHeader :: Response -> HeaderName -> Response

Remove a header (if it exists) from the Response

Applications and middleware

type Application = RequestConfig -> DCLabeled Request -> DC Response

Base Hails type implemented by untrusted applications.

data RequestConfig

The settings with which the app will run.

Constructors

RequestConfig

Fields

browserLabel :: DCLabel

The label of the browser the reponse will be sent to.

requestLabel :: DCLabel

The label of the incoming request (with the logged in user's integrity).

appPrivilege :: DCPriv

A privilege minted for the app.

Instances

Show RequestConfig

Routeable Application

type Middleware = Application -> Application

Convenience type for middleware components.