Servant.Subscriber.Request

Documentation

type RequestHeader = (Text, Text)

type RequestHeaders = [RequestHeader]

data Request

Any message from the client is a Request:

SetPongRequest: A request that should be issued whenever a websocket pong is received. In addition to every websocket pong the request also gets issued immediately upon receival. Bot SetPongRequest and SetCloseRequest will be confirmed with a Subscribed response, but any return value of the request won't be delivered.

SetCloseRequest: A request that should be issued when the websocket connection closes for whatever reason.

Constructors

Subscribe !HttpRequest

Unsubscribe !HttpRequest

SetPongRequest !HttpRequest

SetCloseRequest !HttpRequest

Instances

Generic Request

Associated Types

type Rep Request :: * -> *

Methods

from :: Request -> Rep Request x

to :: Rep Request x -> Request

FromJSON Request

Methods

parseJSON :: Value -> Parser Request

parseJSONList :: Value -> Parser [Request]

ToJSON Request

Methods

toJSON :: Request -> Value

toEncoding :: Request -> Encoding

toJSONList :: [Request] -> Value

toEncodingList :: [Request] -> Encoding

type Rep Request

type Rep Request = D1 (MetaData "Request" "Servant.Subscriber.Request" "servant-subscriber-0.5.0.3-DCfPTJPPVgEBvHnUamsMHn" False) ((:+:) ((:+:) (C1 (MetaCons "Subscribe" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 HttpRequest))) (C1 (MetaCons "Unsubscribe" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 HttpRequest)))) ((:+:) (C1 (MetaCons "SetPongRequest" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 HttpRequest))) (C1 (MetaCons "SetCloseRequest" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 HttpRequest)))))

data HttpRequest

Constructors

HttpRequest

Fields

• httpMethod :: !Text
• httpPath :: !Path
• httpHeaders :: RequestHeaders
• httpQuery :: QueryText
• httpBody :: RequestBody

Instances

Eq HttpRequest

Methods

(==) :: HttpRequest -> HttpRequest -> Bool

(/=) :: HttpRequest -> HttpRequest -> Bool

Ord HttpRequest

Methods

compare :: HttpRequest -> HttpRequest -> Ordering

(<) :: HttpRequest -> HttpRequest -> Bool

(<=) :: HttpRequest -> HttpRequest -> Bool

(>) :: HttpRequest -> HttpRequest -> Bool

(>=) :: HttpRequest -> HttpRequest -> Bool

max :: HttpRequest -> HttpRequest -> HttpRequest

min :: HttpRequest -> HttpRequest -> HttpRequest

Show HttpRequest

Methods

showsPrec :: Int -> HttpRequest -> ShowS

show :: HttpRequest -> String

showList :: [HttpRequest] -> ShowS

Generic HttpRequest

Associated Types

type Rep HttpRequest :: * -> *

Methods

from :: HttpRequest -> Rep HttpRequest x

to :: Rep HttpRequest x -> HttpRequest

FromJSON HttpRequest

Methods

parseJSON :: Value -> Parser HttpRequest

parseJSONList :: Value -> Parser [HttpRequest]

ToJSON HttpRequest

Methods

toJSON :: HttpRequest -> Value

toEncoding :: HttpRequest -> Encoding

toJSONList :: [HttpRequest] -> Value

toEncodingList :: [HttpRequest] -> Encoding

type Rep HttpRequest

type Rep HttpRequest = D1 (MetaData "HttpRequest" "Servant.Subscriber.Request" "servant-subscriber-0.5.0.3-DCfPTJPPVgEBvHnUamsMHn" False) (C1 (MetaCons "HttpRequest" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "httpMethod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "httpPath") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Path))) ((:*:) (S1 (MetaSel (Just Symbol "httpHeaders") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 RequestHeaders)) ((:*:) (S1 (MetaSel (Just Symbol "httpQuery") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 QueryText)) (S1 (MetaSel (Just Symbol "httpBody") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 RequestBody))))))

newtype RequestBody

Constructors

RequestBody Text

Instances

Eq RequestBody

Methods

(==) :: RequestBody -> RequestBody -> Bool

(/=) :: RequestBody -> RequestBody -> Bool

Ord RequestBody

Methods

compare :: RequestBody -> RequestBody -> Ordering

(<) :: RequestBody -> RequestBody -> Bool

(<=) :: RequestBody -> RequestBody -> Bool

(>) :: RequestBody -> RequestBody -> Bool

(>=) :: RequestBody -> RequestBody -> Bool

max :: RequestBody -> RequestBody -> RequestBody

min :: RequestBody -> RequestBody -> RequestBody

Show RequestBody

Methods

showsPrec :: Int -> RequestBody -> ShowS

show :: RequestBody -> String

showList :: [RequestBody] -> ShowS

Generic RequestBody

Associated Types

type Rep RequestBody :: * -> *

Methods

from :: RequestBody -> Rep RequestBody x

to :: Rep RequestBody x -> RequestBody

FromJSON RequestBody

Methods

parseJSON :: Value -> Parser RequestBody

parseJSONList :: Value -> Parser [RequestBody]

ToJSON RequestBody

Methods

toJSON :: RequestBody -> Value

toEncoding :: RequestBody -> Encoding

toJSONList :: [RequestBody] -> Value

toEncodingList :: [RequestBody] -> Encoding

type Rep RequestBody

type Rep RequestBody = D1 (MetaData "RequestBody" "Servant.Subscriber.Request" "servant-subscriber-0.5.0.3-DCfPTJPPVgEBvHnUamsMHn" True) (C1 (MetaCons "RequestBody" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

runRequestBody :: RequestBody -> Text

toHTTPHeader :: RequestHeader -> Header

toHTTPHeaders :: RequestHeaders -> RequestHeaders

requestPath :: Request -> Path