Documentation

an HTTP request

an HTTP Response

The body of an HTTP Request

a value extract from the QUERY_STRING or Request body

If the input value was a file, then it will be saved to a temporary file on disk and inputValue will contain Left pathToTempFile.

an HTTP header

get the request body from the Request and replace it with Nothing

IMPORTANT: You can really only call this function once. Subsequent calls will return Nothing.

read the request body inputs

This will only work if the body inputs have already been decoded. Otherwise it will return Nothing.

Converts a Request into a String representing the corresponding URL

Takes a list of (key,val) pairs and converts it into Headers. The keys will be converted to lowercase

Lookup header value. Key is case-insensitive.

Lookup header value. Key is a case-insensitive bytestring.

Lookup header value with a case-sensitive key. The key must be lowercase.

Returns True if the associated key is found in the Headers. The lookup is case insensitive.

Acts as hasHeader with ByteStrings

Acts as hasHeaderBS but the key is case sensitive. It should be in lowercase.

Associates the key/value pair in the headers. Forces the key to be lowercase.

Acts as setHeader but with ByteStrings.

Sets the key to the HeaderPair. This is the only way to associate a key with multiple values via the setHeader* functions. Does not force the key to be in lowercase or guarantee that the given key and the key in the HeaderPair will match.

Add a key/value pair to the header. If the key already has a value associated with it, then the value will be appended. Forces the key to be lowercase.

Acts as addHeader except for ByteStrings

Add a key/value pair to the header using the underlying HeaderPair data type. Does not force the key to be in lowercase or guarantee that the given key and the key in the HeaderPair will match.

Sets the Response status code to the provided Int and lifts the computation into a Monad.

function to log access requests (see also: logMAccess) type LogAccess time = ( String -- ^ host -> String -- ^ user -> time -- ^ time -> String -- ^ requestLine -> Int -- ^ responseCode -> Integer -- ^ size -> String -- ^ referer -> String -- ^ userAgent -> IO ())

log access requests using hslogger and apache-style log formatting

see also: Conf

HTTP configuration

Default configuration contains no validator and the port is set to 8000

Creates a Response with the given Int as the status code and the provided String as the body of the Response

Acts as result but works with ByteStrings directly.

By default, Transfer-Encoding: chunked will be used

Sets the Response's status code to the given Int and redirects to the given URI

True if Request is HTTP version 1.0

True if Request is HTTP version 1.1

Result flags

Default RsFlags: automatically use Transfer-Encoding: Chunked.

Automatically add a Content-Length header. Do not use Transfer-Encoding: Chunked

Do not automatically add a Content-Length header. Do automatically use Transfer-Encoding: Chunked

Do not automatically add a Content-Length field to the Response

HTTP version

A flag value set in the Response which controls how the Content-Length header is set, and whether *chunked* output encoding is used.

see also: nullRsFlags, notContentLength, and chunked

HTTP request method

Does the method support a message body?

For extension methods, we assume yes.

a Map of HTTP headers

the Map key is the header converted to lowercase

Should the connection be used for further messages after this. isHTTP1_0 && hasKeepAlive || isHTTP1_1 && hasNotConnectionClose

In addition to this rule All 1xx (informational), 204 (no content), and 304 (not modified) responses MUST NOT include a message-body and therefore are eligible for connection keep-alive.

hostname & port

A MIME media type value. The Show instance is derived automatically. Use showContentType to obtain the standard string representation. See http://www.ietf.org/rfc/rfc2046.txt for more information about MIME media types.

convert a 'ReadS a' result to 'Maybe a'

Read in any monad.

This class is used by path to parse a path component into a value.

The instances for number types (Int, Float, etc) use readM to parse the path component.

The instance for String, on the other hand, returns the unmodified path component.

See the following section of the Happstack Crash Course for detailed instructions using and extending FromReqURI:

http://www.happstack.com/docs/crashcourse/RouteFilters.html#FromReqURI

Escape from the HTTP world and get direct access to the underlying TimeoutIO functions