Network.Web.HTTP

HTTP library for HTTP server.

Documentation

receive :: Handle -> IO (Maybe Request)

Receiving HTTP request from Handle. If request is broken, Nothing is returned.

respond :: Handle -> Version -> Persist -> Response -> IO ()

Sending HTTP response to Handle. If Keep is specified, the HTTP connection will be kept. If Close is specified, the connection will be closed. Version should be copied from Request.

data Request

Abstract data type of HTTP request.

Instances

Show Request

Comm Request

reqMethod :: Request -> Method

Request method

reqURI :: Request -> URI

URI parsed from absolute URL or relative URL with the Host: field

reqVersion :: Request -> Version

HTTP version

reqFields :: Request -> Fields

Key-values of request header

reqBody :: Request -> Maybe ByteString

Entity body if exists

reqLength :: Request -> Integer

Length of entity body from Content-Length:

data Response

Abstract data type of HTTP response.

Instances

Comm Response

rspStatus :: Response -> Status

Response status

rspFields :: Response -> Fields

rspBody :: Response -> Maybe ByteString

rspLength :: Response -> Maybe Integer

rspLogMsg :: Response -> String

makeResponse :: Status -> [(FieldKey, FieldValue)] -> Response

A function to make Response.

makeResponse2 :: Status -> Maybe ByteString -> Maybe Integer -> [(FieldKey, FieldValue)] -> Response

A function to make Response.

makeResponse3 :: Status -> Maybe ByteString -> Maybe Integer -> Fields -> Response

A function to make Response.

class Comm a

A class to abstract Request and Response.

Instances

Comm Response

Comm Request

data Fields

Abstract data type for Key-values of HTTP header.

Instances

Show Fields

lookupField :: Comm a => FieldKey -> a -> Maybe FieldValue

Looking up the HTTP field value.

lookupField' :: FieldKey -> Fields -> Maybe FieldValue

Looking up the HTTP field value.

insertField :: Comm a => FieldKey -> FieldValue -> a -> a

Inserting the HTTP field.

insertField' :: FieldKey -> FieldValue -> Fields -> Fields

Inserting the HTTP field.

receiveFields :: Handle -> IO Fields

Parsing HTTP header from Handle. This function is useful to parse CGI output.

data Method

Methods of HTTP.

Constructors

GET

HEAD

POST

PUT

DELETE

TRACE

CONNECT

UnknownMethod

Instances

Bounded Method

Enum Method

Eq Method

Show Method

toMethod :: ByteString -> Method

data Version

Versions of HTTP.

Constructors

HTTP10

HTTP11

Instances

Eq Version

Show Version

toVersion :: ByteString -> Version

fromVersion :: Version -> ByteString

data Status

Status of HTTP.

Constructors

Continue

SwitchingProtocols

OK

Created

Accepted

NonAuthoritativeInformation

NoContent

ResetContent

PartialContent Integer Integer

MultipleChoices

MovedPermanently

Found

SeeOther

NotModified

UseProxy

TemporaryRedirect

BadRequest

Unauthorized

PaymentRequired

Forbidden

NotFound

MethodNotAllowed

NotAcceptable

ProxyAuthenticationRequired

RequestTimeout

Conflict

Gone

LengthRequired

PreconditionFailed

RequestEntityTooLarge

RequestURITooLarge

UnsupportedMediaType

RequestedRangeNotSatisfiable

ExpectationFailed

InternalServerError

NotImplemented

BadGateway

ServiceUnavailable

GatewayTimeout

HTTPVersionNotSupported

Instances

Show Status

toStatus :: ByteString -> Maybe Status

Converting numeric status to Status.

fromStatus :: Status -> ByteString

badStatus :: Status -> Bool

Returning True for 4xx and 5xx.

data Persist

The type for persist connection or not

Constructors

Close

Keep

PerUnknown

Instances

Eq Persist

Show Persist

toPersist :: ByteString -> Persist

fromPersist :: Persist -> ByteString

data ServerException

Exceptions for Web server

Constructors

TimeOut

TerminatedByClient

Instances

Eq ServerException

Ord ServerException

Show ServerException

Typeable ServerException

Exception ServerException

data FieldKey

Field key of HTTP header.

Constructors

FkAcceptLanguage

FkCacheControl

FkConnection

FkContentLength

FkContentType

FkCookie

FkDate

FkHost

FkIfModifiedSince

FkIfRange

FkIfUnmodifiedSince

FkLastModified

FkLocation

FkRange

FkServer

FkSetCookie2

FkStatus

FkTransferEncoding

FkOther ByteString

Instances

Eq FieldKey

Ord FieldKey

Show FieldKey

type FieldValue = ByteString

Field value of HTTP header.

toFieldKey :: ByteString -> FieldKey

Converting field key to FieldKey.

fromFieldKey :: FieldKey -> ByteString

Converting FieldKey to field key.

type CT = ByteString

The type for Content-Type.

textHtml :: CT

The value for text/html.

selectContentType :: String -> CT

Selecting a value of Content-Type from a file suffix.