Network.Warped

Public Module

Documentation

data WaiCtx

WaiCtx

Context containing WAI application.

Constructors

WaiCtx

Fields

• _wcSessionUid :: UUID

  Session Id.

• _wcRequest :: Request

  WAI request.

• _wcRespond :: Respond

  WAI response.

Instances

HasWaiCtx WaiCtx

Defined in Network.Warped.Types.Ctx

Methods

waiCtx :: Lens' WaiCtx WaiCtx

wcRequest :: Lens' WaiCtx Request

wcRespond :: Lens' WaiCtx Respond

wcSessionUid :: Lens' WaiCtx UUID

type MonadWai c m = (MonadIO m, MonadReader c m, HasWaiCtx c)

class HasWaiCtx c where

Minimal complete definition

waiCtx

Methods

waiCtx :: Lens' c WaiCtx

wcRequest :: Lens' c Request

wcRespond :: Lens' c Respond

wcSessionUid :: Lens' c UUID

Instances

HasWaiCtx WaiCtx

Defined in Network.Warped.Types.Ctx

Methods

waiCtx :: Lens' WaiCtx WaiCtx

wcRequest :: Lens' WaiCtx Request

wcRespond :: Lens' WaiCtx Respond

wcSessionUid :: Lens' WaiCtx UUID

type MonadApplication m = Request -> Respond -> m ResponseReceived

MonadApplication

type Respond = Response -> IO ResponseReceived

Respond

flushBuilder :: Monad m => ConduitT ByteString (Flush Builder) m ()

A Conduit for converting a ByteString to a Flush Builder.

requestHeader :: HeaderName -> Request -> Maybe ByteString

Lookup a request header.

requestQuery :: ByteString -> Request -> Maybe ByteString

Look up a query parameter.

warp :: (MonadBaseControl IO m, StM m ResponseReceived ~ ResponseReceived) => Settings -> MonadApplication m -> m ()

Run warp with lifted type.

warpCors :: (MonadBaseControl IO m, StM m ResponseReceived ~ ResponseReceived) => Settings -> CorsResourcePolicy -> MonadApplication m -> m ()

Run warp with lifted type.

route :: (MonadWai c m, Eq a) => (Request -> a) -> m ResponseReceived -> [(a, m ResponseReceived)] -> m ResponseReceived

General purpose router on requests.

routeMethod :: MonadWai c m => m ResponseReceived -> [(Method, m ResponseReceived)] -> m ResponseReceived

Route methods

routePath :: MonadWai c m => m ResponseReceived -> [(ByteString, m ResponseReceived)] -> m ResponseReceived

Route paths.

raceResponse :: MonadBaseControl IO m => m ResponseReceived -> m ResponseReceived -> m ResponseReceived

Race between source and response - return whoever finishes first.

answer :: MonadWai c m => Response -> m ResponseReceived

All responses.

answerStatus :: MonadWai c m => Status -> ResponseHeaders -> m ResponseReceived

Status response.

answerSource :: MonadWai c m => Status -> ResponseHeaders -> ConduitT () (Flush Builder) IO () -> m ResponseReceived

Stream response.

answerJson :: (MonadWai c m, ToJSON a) => Status -> ResponseHeaders -> a -> m ResponseReceived

JSON response.

withHeader :: MonadWai c m => HeaderName -> (HeaderName -> m ResponseReceived) -> (ByteString -> m ResponseReceived) -> m ResponseReceived

Lookup header.