Safe Haskell	Safe-Inferred
Language	Haskell2010

Test.Mux.ReqResp

Description

A simple ReqResp protocol, togetether with an incremental decoder. Mux is chopping messages into MuxSDUs of a fixed size, for that reasone the peer awaiting for messages needs an incremental decoder to assemple messages back.

Synopsis

data MsgReqResp req resp
- = MsgReq req
- | MsgResp resp
- | MsgDone
data ReqRespClient req resp m a where
- SendMsgReq ∷ req → (resp → m (ReqRespClient req resp m a)) → ReqRespClient req resp m a
- SendMsgDone ∷ m a → ReqRespClient req resp m a
- EarlyExit ∷ a → ReqRespClient req resp m a
data TraceSendRecv msg
- = TraceSend msg
- | TraceRecv msg
- | TraceEarlyExit
- | TraceFailure DeserialiseFailure
runDecoderWithChannel ∷ ∀ m a. MonadST m ⇒ Channel m → Maybe ByteString → Decoder (PrimState m) a → m (Either DeserialiseFailure (a, Maybe ByteString))
runClient ∷ ∀ req resp m a. (MonadST m, Serialise req, Serialise resp, Show req, Show resp) ⇒ Tracer m (TraceSendRecv (MsgReqResp req resp)) → Channel m → ReqRespClient req resp m a → m (a, Maybe ByteString)
data ReqRespServer req resp m a = ReqRespServer {
- recvMsgReq ∷ req → m (resp, ReqRespServer req resp m a)
- recvMsgDone ∷ m a
}
runServer ∷ ∀ req resp m a. (MonadST m, Serialise req, Serialise resp, Show req, Show resp) ⇒ Tracer m (TraceSendRecv (MsgReqResp req resp)) → Channel m → ReqRespServer req resp m a → m (a, Maybe ByteString)

Documentation

data MsgReqResp req resp Source #

Protocol messages.

Constructors

MsgReq req	Client request.
MsgResp resp	Server response.
MsgDone	Client finishes the protocol exchange.

Instances

Instances details

(Show req, Show resp) ⇒ Show (MsgReqResp req resp) Source #
Instance details Defined in Test.Mux.ReqResp Methods showsPrec ∷ Int → MsgReqResp req resp → ShowS # show ∷ MsgReqResp req resp → String # showList ∷ [MsgReqResp req resp] → ShowS #
(Eq req, Eq resp) ⇒ Eq (MsgReqResp req resp) Source #
Instance details Defined in Test.Mux.ReqResp Methods (==) ∷ MsgReqResp req resp → MsgReqResp req resp → Bool # (/=) ∷ MsgReqResp req resp → MsgReqResp req resp → Bool #
(Ord req, Ord resp) ⇒ Ord (MsgReqResp req resp) Source #
Instance details Defined in Test.Mux.ReqResp Methods compare ∷ MsgReqResp req resp → MsgReqResp req resp → Ordering # (<) ∷ MsgReqResp req resp → MsgReqResp req resp → Bool # (<=) ∷ MsgReqResp req resp → MsgReqResp req resp → Bool # (>) ∷ MsgReqResp req resp → MsgReqResp req resp → Bool # (>=) ∷ MsgReqResp req resp → MsgReqResp req resp → Bool # max ∷ MsgReqResp req resp → MsgReqResp req resp → MsgReqResp req resp # min ∷ MsgReqResp req resp → MsgReqResp req resp → MsgReqResp req resp #
(Serialise req, Serialise resp) ⇒ Serialise (MsgReqResp req resp) Source #
Instance details Defined in Test.Mux.ReqResp Methods encode ∷ MsgReqResp req resp → Encoding Source # decode ∷ Decoder s (MsgReqResp req resp) Source # encodeList ∷ [MsgReqResp req resp] → Encoding Source # decodeList ∷ Decoder s [MsgReqResp req resp] Source #

data ReqRespClient req resp m a where Source #

A Client which requests req data and receives resp.

Constructors

SendMsgReq ∷ req → (resp → m (ReqRespClient req resp m a)) → ReqRespClient req resp m a
SendMsgDone ∷ m a → ReqRespClient req resp m a
EarlyExit ∷ a → ReqRespClient req resp m a

data TraceSendRecv msg Source #

Constructors

TraceSend msg
TraceRecv msg
TraceEarlyExit
TraceFailure DeserialiseFailure

Instances

Instances details

Show msg ⇒ Show (TraceSendRecv msg) Source #
Instance details Defined in Test.Mux.ReqResp Methods showsPrec ∷ Int → TraceSendRecv msg → ShowS # show ∷ TraceSendRecv msg → String # showList ∷ [TraceSendRecv msg] → ShowS #

runDecoderWithChannel ∷ ∀ m a. MonadST m ⇒ Channel m → Maybe ByteString → Decoder (PrimState m) a → m (Either DeserialiseFailure (a, Maybe ByteString)) Source #

runClient ∷ ∀ req resp m a. (MonadST m, Serialise req, Serialise resp, Show req, Show resp) ⇒ Tracer m (TraceSendRecv (MsgReqResp req resp)) → Channel m → ReqRespClient req resp m a → m (a, Maybe ByteString) Source #

Run a client using a byte Channel.

data ReqRespServer req resp m a Source #

Server which receives req and responds with resp.

Constructors

ReqRespServer
Fields recvMsgReq ∷ req → m (resp, ReqRespServer req resp m a) The client sent us a ping message. We have no choices here, and the response is nullary, all we have are local effects. recvMsgDone ∷ m a The client terminated. Here we have a pure return value, but we could have done another action in `m` if we wanted to.

runServer ∷ ∀ req resp m a. (MonadST m, Serialise req, Serialise resp, Show req, Show resp) ⇒ Tracer m (TraceSendRecv (MsgReqResp req resp)) → Channel m → ReqRespServer req resp m a → m (a, Maybe ByteString) Source #