Network.SCGI

Documentation

data SCGIT m a

Instances

MonadTrans SCGIT

Monad m => MonadState Headers (SCGIT m)

Monad m => Monad (SCGIT m)

MonadCatchIO m => MonadCatchIO (SCGIT m)

MonadIO m => MonadIO (SCGIT m)

Monad m => MonadReader (Headers, Body) (SCGIT m)

type SCGI = SCGIT IO

runRequest

Arguments

:: MonadCatchIO m

=> Handle

the handle connected to the web server (from accept)

-> SCGIT m Response

the action to run in the SCGI monad

-> m ()

nothing is returned, the result of the action is written back to the server

Run a request in the SCGI monad.

header

Arguments

:: Monad m

=> ByteString

the header name (key)

-> SCGIT m (Maybe ByteString)

the header value if found

Look up a request header.

allHeaders

Arguments

:: Monad m

=> SCGIT m [(ByteString, ByteString)]

an association list of header: value pairs

Return all request headers as a list in the format they were received from the web server.

body :: Monad m => SCGIT m ByteString

Return the request body.

method

Arguments

:: Monad m

=> SCGIT m (Maybe ByteString)

the method if found

Get the request method (GET, POST, etc.). You could look the header up yourself, but this normalizes the method name to uppercase.

path

Arguments

:: Monad m

=> SCGIT m (Maybe ByteString)

the path if found

Get the requested path. According to the spec, this can be complex, and actual CGI implementations diverge from the spec. I've found this to work, even though it doesn't seem correct or intuitive.

setHeader

Arguments

:: Monad m

=> ByteString

the header name (key)

-> ByteString

the header value

-> SCGIT m ()

Set a response header.

responseHeader

Arguments

:: Monad m

=> ByteString

the header name (key)

-> SCGIT m (Maybe ByteString)

Look up a response header (one set during this request). This is useful when you need to check if a header has been set already (in case you want to modify it, for example).

type Headers = Map (CI ByteString) ByteString

type Body = ByteString

type Status = ByteString

data Response

Constructors

Response Status Body

negotiate :: Monad m => [ByteString] -> SCGIT m [ByteString]