Safe Haskell	Safe-Inferred
Language	Haskell2010

Ouroboros.Network.Protocol.LocalStateQuery.Server

Contents

Synopsis

newtype LocalStateQueryServer block point (query :: Type -> Type ) m a = LocalStateQueryServer {
- runLocalStateQueryServer :: m ( ServerStIdle block point query m a)
}
data ServerStIdle block point query m a = ServerStIdle {
- recvMsgAcquire :: Maybe point -> m ( ServerStAcquiring block point query m a)
- recvMsgDone :: m a
}
data ServerStAcquiring block point query m a where
- SendMsgAcquired :: ServerStAcquired block point query m a -> ServerStAcquiring block point query m a
- SendMsgFailure :: AcquireFailure -> ServerStIdle block point query m a -> ServerStAcquiring block point query m a
data ServerStAcquired block point query m a = ServerStAcquired {
- recvMsgQuery :: forall result. query result -> m ( ServerStQuerying block point query m a result)
- recvMsgReAcquire :: Maybe point -> m ( ServerStAcquiring block point query m a)
- recvMsgRelease :: m ( ServerStIdle block point query m a)
}
data ServerStQuerying block point query m a result where
- SendMsgResult :: result -> ServerStAcquired block point query m a -> ServerStQuerying block point query m a result
localStateQueryServerPeer :: forall block point (query :: Type -> Type ) m a. Monad m => LocalStateQueryServer block point query m a -> Peer ( LocalStateQuery block point query) AsServer StIdle m a

Protocol type for the server

The protocol states from the point of view of the server.

newtype LocalStateQueryServer block point (query :: Type -> Type ) m a Source #

Constructors

LocalStateQueryServer
Fields runLocalStateQueryServer :: m ( ServerStIdle block point query m a)

data ServerStIdle block point query m a Source #

In the StIdle protocol state, the server does not have agency. Instead it is waiting for:

It must be prepared to handle either.

Constructors

ServerStIdle
Fields recvMsgAcquire :: Maybe point -> m ( ServerStAcquiring block point query m a) recvMsgDone :: m a

data ServerStAcquiring block point query m a where Source #

In the StAcquiring protocol state, the server has agency and must send either:

Constructors

SendMsgAcquired :: ServerStAcquired block point query m a -> ServerStAcquiring block point query m a
SendMsgFailure :: AcquireFailure -> ServerStIdle block point query m a -> ServerStAcquiring block point query m a

data ServerStAcquired block point query m a Source #

In the StAcquired protocol state, the server does not have agency. Instead it is waiting for:

It must be prepared to handle either.

Constructors

ServerStAcquired
Fields recvMsgQuery :: forall result. query result -> m ( ServerStQuerying block point query m a result) recvMsgReAcquire :: Maybe point -> m ( ServerStAcquiring block point query m a) recvMsgRelease :: m ( ServerStIdle block point query m a)

data ServerStQuerying block point query m a result where Source #

In the StQuerying protocol state, the server has agency and must send:

Constructors

SendMsgResult :: result -> ServerStAcquired block point query m a -> ServerStQuerying block point query m a result

Execution as a typed protocol

localStateQueryServerPeer :: forall block point (query :: Type -> Type ) m a. Monad m => LocalStateQueryServer block point query m a -> Peer ( LocalStateQuery block point query) AsServer StIdle m a Source #

Interpret a LocalStateQueryServer action sequence as a Peer on the server side of the LocalStateQuery protocol.