Safe Haskell	Safe-Inferred
Language	Haskell2010

Ouroboros.Network.Protocol.ChainSync.Type

Description

The type of the chain synchronisation protocol.

Since we are using a typed protocol framework this is in some sense the definition of the protocol: what is allowed and what is not allowed.

Synopsis

data ChainSync header point tip where
- StIdle :: ChainSync header point tip
- StNext :: StNextKind -> ChainSync header point tip
- StIntersect :: ChainSync header point tip
- StDone :: ChainSync header point tip
data StNextKind where
- StCanAwait :: StNextKind
- StMustReply :: StNextKind
data TokNextKind (k :: StNextKind ) where
- TokCanAwait :: TokNextKind StCanAwait
- TokMustReply :: TokNextKind StMustReply

Documentation

data ChainSync header point tip where Source #

A kind to identify our protocol, and the types of the states in the state transition diagram of the protocol.

Constructors

StIdle :: ChainSync header point tip	Both client and server are idle. The client can send a request and the server is waiting for a request.
StNext :: StNextKind -> ChainSync header point tip	The client has sent a next update request. The client is now waiting for a response, and the server is busy getting ready to send a response. There are two possibilities here, since the server can send a reply immediately or it can send an initial await message followed later by the normal reply.
StIntersect :: ChainSync header point tip	The client has sent an intersection request. The client is now waiting for a response, and the server is busy getting ready to send a response.
StDone :: ChainSync header point tip	Both the client and server are in the terminal state. They're done.

Instances

Instances details

( ShowProxy header, ShowProxy tip) => ShowProxy ( ChainSync header point tip :: Type ) Source #
Instance details Defined in Ouroboros.Network.Protocol.ChainSync.Type Methods showProxy :: Proxy ( ChainSync header point tip) -> String Source #
Show ( ClientHasAgency st) Source #
Instance details Defined in Ouroboros.Network.Protocol.ChainSync.Type Methods showsPrec :: Int -> ClientHasAgency st -> ShowS Source # show :: ClientHasAgency st -> String Source # showList :: [ ClientHasAgency st] -> ShowS Source #
Show ( ServerHasAgency st) Source #
Instance details Defined in Ouroboros.Network.Protocol.ChainSync.Type Methods showsPrec :: Int -> ServerHasAgency st -> ShowS Source # show :: ServerHasAgency st -> String Source # showList :: [ ServerHasAgency st] -> ShowS Source #
( Show header, Show point, Show tip) => Show ( Message ( ChainSync header point tip) from to) Source #
Instance details Defined in Ouroboros.Network.Protocol.ChainSync.Type Methods showsPrec :: Int -> Message ( ChainSync header point tip) from to -> ShowS Source # show :: Message ( ChainSync header point tip) from to -> String Source # showList :: [ Message ( ChainSync header point tip) from to] -> ShowS Source #
Protocol ( ChainSync header point tip) Source #
Instance details Defined in Ouroboros.Network.Protocol.ChainSync.Type Associated Types data Message ( ChainSync header point tip) st st' Source # data ClientHasAgency st Source # data ServerHasAgency st Source # data NobodyHasAgency st Source # Methods exclusionLemma_ClientAndServerHaveAgency :: forall (st :: ChainSync header point tip). ClientHasAgency st -> ServerHasAgency st -> Void Source # exclusionLemma_NobodyAndClientHaveAgency :: forall (st :: ChainSync header point tip). NobodyHasAgency st -> ClientHasAgency st -> Void Source # exclusionLemma_NobodyAndServerHaveAgency :: forall (st :: ChainSync header point tip). NobodyHasAgency st -> ServerHasAgency st -> Void Source #
data Message ( ChainSync header point tip) (from :: ChainSync header point tip) (to :: ChainSync header point tip) Source #
Instance details Defined in Ouroboros.Network.Protocol.ChainSync.Type data Message ( ChainSync header point tip) (from :: ChainSync header point tip) (to :: ChainSync header point tip) where MsgRequestNext :: forall k k k (header :: k) (point :: k) (tip :: k). Message ( ChainSync header point tip) (' StIdle :: ChainSync header point tip) (' StNext ' StCanAwait :: ChainSync header point tip) MsgAwaitReply :: forall k k k (header :: k) (point :: k) (tip :: k). Message ( ChainSync header point tip) (' StNext ' StCanAwait :: ChainSync header point tip) (' StNext ' StMustReply :: ChainSync header point tip) MsgRollForward :: forall k header tip (point :: k) (any :: StNextKind ). header -> tip -> Message ( ChainSync header point tip) (' StNext any :: ChainSync header point tip) (' StIdle :: ChainSync header point tip) MsgRollBackward :: forall k point tip (header :: k) (any :: StNextKind ). point -> tip -> Message ( ChainSync header point tip) (' StNext any :: ChainSync header point tip) (' StIdle :: ChainSync header point tip) MsgFindIntersect :: forall k k point (header :: k) (tip :: k). [point] -> Message ( ChainSync header point tip) (' StIdle :: ChainSync header point tip) (' StIntersect :: ChainSync header point tip) MsgIntersectFound :: forall k point tip (header :: k). point -> tip -> Message ( ChainSync header point tip) (' StIntersect :: ChainSync header point tip) (' StIdle :: ChainSync header point tip) MsgIntersectNotFound :: forall k k tip (header :: k) (point :: k). tip -> Message ( ChainSync header point tip) (' StIntersect :: ChainSync header point tip) (' StIdle :: ChainSync header point tip) MsgDone :: forall k k k (header :: k) (point :: k) (tip :: k). Message ( ChainSync header point tip) (' StIdle :: ChainSync header point tip) (' StDone :: ChainSync header point tip)
data ClientHasAgency (st :: ChainSync header point tip) Source #
Instance details Defined in Ouroboros.Network.Protocol.ChainSync.Type data ClientHasAgency (st :: ChainSync header point tip) where TokIdle :: forall k k k (header :: k) (point :: k) (tip :: k). ClientHasAgency (' StIdle :: ChainSync header point tip)
data ServerHasAgency (st :: ChainSync header point tip) Source #
Instance details Defined in Ouroboros.Network.Protocol.ChainSync.Type data ServerHasAgency (st :: ChainSync header point tip) where TokNext :: forall k k k (header :: k) (point :: k) (tip :: k) (k :: StNextKind ). TokNextKind k -> ServerHasAgency (' StNext k :: ChainSync header point tip) TokIntersect :: forall k k k (header :: k) (point :: k) (tip :: k). ServerHasAgency (' StIntersect :: ChainSync header point tip)
data NobodyHasAgency (st :: ChainSync header point tip) Source #
Instance details Defined in Ouroboros.Network.Protocol.ChainSync.Type data NobodyHasAgency (st :: ChainSync header point tip) where TokDone :: forall k k k (header :: k) (point :: k) (tip :: k). NobodyHasAgency (' StDone :: ChainSync header point tip)

data StNextKind where Source #

Sub-cases of the StNext state. This is needed since the server can either send one reply back, or two.

Constructors

StCanAwait :: StNextKind	The server can reply or send an await msg.
StMustReply :: StNextKind	The server must now reply, having already sent an await message.

data TokNextKind (k :: StNextKind ) where Source #

Constructors

TokCanAwait :: TokNextKind StCanAwait
TokMustReply :: TokNextKind StMustReply