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 # show ∷ ClientHasAgency st → String # showList ∷ [ClientHasAgency st] → ShowS #
Show (ServerHasAgency st) Source #
Instance details Defined in Ouroboros.Network.Protocol.ChainSync.Type Methods showsPrec ∷ Int → ServerHasAgency st → ShowS # show ∷ ServerHasAgency st → String # showList ∷ [ServerHasAgency st] → ShowS #
NFData (ClientHasAgency st) Source #
Instance details Defined in Ouroboros.Network.Protocol.ChainSync.Type Methods rnf ∷ ClientHasAgency st → () #
NFData (NobodyHasAgency st) Source #
Instance details Defined in Ouroboros.Network.Protocol.ChainSync.Type Methods rnf ∷ NobodyHasAgency st → () #
NFData (ServerHasAgency st) Source #
Instance details Defined in Ouroboros.Network.Protocol.ChainSync.Type Methods rnf ∷ ServerHasAgency st → () #
(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 # show ∷ Message (ChainSync header point tip) from to → String # showList ∷ [Message (ChainSync header point tip) from to] → ShowS #
(NFData header, NFData point, NFData tip) ⇒ NFData (Message (ChainSync header point tip) from to) Source #
Instance details Defined in Ouroboros.Network.Protocol.ChainSync.Type Methods rnf ∷ Message (ChainSync header point tip) from to → () #
NFData (PeerHasAgency pr st) Source #
Instance details Defined in Ouroboros.Network.Protocol.ChainSync.Type Methods rnf ∷ PeerHasAgency pr st → () #
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 ∷ ∀ (st ∷ ChainSync header point tip). ClientHasAgency st → ServerHasAgency st → Void Source # exclusionLemma_NobodyAndClientHaveAgency ∷ ∀ (st ∷ ChainSync header point tip). NobodyHasAgency st → ClientHasAgency st → Void Source # exclusionLemma_NobodyAndServerHaveAgency ∷ ∀ (st ∷ ChainSync header point tip). NobodyHasAgency st → ServerHasAgency st → Void Source #
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 ∷ ∀ {k} {k1} {k2} {header ∷ k} {point ∷ k1} {tip ∷ k2}. ClientHasAgency ('StIdle ∷ ChainSync header point tip)
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 ∷ ∀ {k} {k1} {k2} (header ∷ k) (point ∷ k1) (tip ∷ k2). Message (ChainSync header point tip) ('StIdle ∷ ChainSync header point tip) ('StNext 'StCanAwait ∷ ChainSync header point tip) MsgAwaitReply ∷ ∀ {k} {k1} {k2} (header ∷ k) (point ∷ k1) (tip ∷ k2). Message (ChainSync header point tip) ('StNext 'StCanAwait ∷ ChainSync header point tip) ('StNext 'StMustReply ∷ ChainSync header point tip) MsgRollForward ∷ ∀ {k1} header1 tip1 (point ∷ k1) (any ∷ StNextKind). header1 → tip1 → Message (ChainSync header1 point tip1) ('StNext any ∷ ChainSync header1 point tip1) ('StIdle ∷ ChainSync header1 point tip1) MsgRollBackward ∷ ∀ {k} point1 tip1 (header ∷ k) (any ∷ StNextKind). point1 → tip1 → Message (ChainSync header point1 tip1) ('StNext any ∷ ChainSync header point1 tip1) ('StIdle ∷ ChainSync header point1 tip1) MsgFindIntersect ∷ ∀ {k} {k2} point1 (header ∷ k) (tip ∷ k2). [point1] → Message (ChainSync header point1 tip) ('StIdle ∷ ChainSync header point1 tip) ('StIntersect ∷ ChainSync header point1 tip) MsgIntersectFound ∷ ∀ {k} point1 tip1 (header ∷ k). point1 → tip1 → Message (ChainSync header point1 tip1) ('StIntersect ∷ ChainSync header point1 tip1) ('StIdle ∷ ChainSync header point1 tip1) MsgIntersectNotFound ∷ ∀ {k} {k1} tip1 (header ∷ k) (point ∷ k1). tip1 → Message (ChainSync header point tip1) ('StIntersect ∷ ChainSync header point tip1) ('StIdle ∷ ChainSync header point tip1) MsgDone ∷ ∀ {k} {k1} {k2} (header ∷ k) (point ∷ k1) (tip ∷ k2). Message (ChainSync header point tip) ('StIdle ∷ ChainSync header point tip) ('StDone ∷ 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 ∷ ∀ {k} {k1} {k2} {header ∷ k} {point ∷ k1} {tip ∷ k2}. NobodyHasAgency ('StDone ∷ 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 ∷ ∀ {k} {k1} {k2} {header ∷ k} {point ∷ k1} {tip ∷ k2} (k3 ∷ StNextKind). TokNextKind k3 → ServerHasAgency ('StNext k3 ∷ ChainSync header point tip) TokIntersect ∷ ∀ {k} {k1} {k2} {header ∷ k} {point ∷ k1} {tip ∷ k2}. ServerHasAgency ('StIntersect ∷ 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

Instances

Instances details

NFData (TokNextKind k) Source #
Instance details Defined in Ouroboros.Network.Protocol.ChainSync.Type Methods rnf ∷ TokNextKind k → () #