Safe Haskell	None
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 :: k) (point :: k1) (tip :: k2) where
- StIdle :: forall {k} {k1} {k2} (header :: k) (point :: k1) (tip :: k2). ChainSync header point tip
- StNext :: forall {k} {k1} {k2} (header :: k) (point :: k1) (tip :: k2). StNextKind -> ChainSync header point tip
- StIntersect :: forall {k} {k1} {k2} (header :: k) (point :: k1) (tip :: k2). ChainSync header point tip
- StDone :: forall {k} {k1} {k2} (header :: k) (point :: k1) (tip :: k2). ChainSync header point tip
data SingChainSync (k3 :: ChainSync header point tip) where
- SingIdle :: forall {k} {k1} {k2} {header :: k} {point :: k1} {tip :: k2}. SingChainSync ('StIdle :: ChainSync header point tip)
- SingNext :: forall {k} {k1} {k2} {header :: k} {point :: k1} {tip :: k2} (k4 :: StNextKind). SingNextKind k4 -> SingChainSync ('StNext k4 :: ChainSync header point tip)
- SingIntersect :: forall {k} {k1} {k2} {header :: k} {point :: k1} {tip :: k2}. SingChainSync ('StIntersect :: ChainSync header point tip)
- SingDone :: forall {k} {k1} {k2} {header :: k} {point :: k1} {tip :: k2}. SingChainSync ('StDone :: ChainSync header point tip)
data StNextKind where
- StCanAwait :: StNextKind
- StMustReply :: StNextKind
data SingNextKind (k :: StNextKind) where
- SingCanAwait :: SingNextKind 'StCanAwait
- SingMustReply :: SingNextKind 'StMustReply
data TokNextKind (k :: StNextKind) where
- TokCanAwait :: TokNextKind 'StCanAwait
- TokMustReply :: TokNextKind 'StMustReply

Documentation

data ChainSync (header :: k) (point :: k1) (tip :: k2) where Source #

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

Constructors

StIdle :: forall {k} {k1} {k2} (header :: k) (point :: k1) (tip :: k2). 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 :: forall {k} {k1} {k2} (header :: k) (point :: k1) (tip :: k2). 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 :: forall {k} {k1} {k2} (header :: k) (point :: k1) (tip :: k2). 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 :: forall {k} {k1} {k2} (header :: k) (point :: k1) (tip :: k2). 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 #

(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 -> () #

(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 #

Protocol (ChainSync header point tip) Source #

Instance details

Defined in Ouroboros.Network.Protocol.ChainSync.Type

Associated Types

type StateToken
Instance details Defined in Ouroboros.Network.Protocol.ChainSync.Type type StateToken = SingChainSync :: ChainSync header point tip -> Type

StateTokenI ('StDone :: ChainSync header point tip) Source #

Instance details

Defined in Ouroboros.Network.Protocol.ChainSync.Type

Methods

stateToken :: StateToken ('StDone :: ChainSync header point tip) #

StateTokenI ('StIdle :: ChainSync header point tip) Source #

Instance details

Defined in Ouroboros.Network.Protocol.ChainSync.Type

Methods

stateToken :: StateToken ('StIdle :: ChainSync header point tip) #

StateTokenI ('StIntersect :: ChainSync header point tip) Source #

Instance details

Defined in Ouroboros.Network.Protocol.ChainSync.Type

Methods

stateToken :: StateToken ('StIntersect :: ChainSync header point tip) #

SingI k4 => StateTokenI ('StNext k4 :: ChainSync header point tip) Source #

Instance details

Defined in Ouroboros.Network.Protocol.ChainSync.Type

Methods

stateToken :: StateToken ('StNext k4 :: 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 :: forall {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 :: forall {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 :: forall {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 :: forall {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 :: forall {k} {k2} point1 (header :: k) (tip :: k2). [point1] -> Message (ChainSync header point1 tip) ('StIdle :: ChainSync header point1 tip) ('StIntersect :: ChainSync header point1 tip)
MsgIntersectFound :: forall {k} point1 tip1 (header :: k). point1 -> tip1 -> Message (ChainSync header point1 tip1) ('StIntersect :: ChainSync header point1 tip1) ('StIdle :: ChainSync header point1 tip1)
MsgIntersectNotFound :: forall {k} {k1} tip1 (header :: k) (point :: k1). tip1 -> Message (ChainSync header point tip1) ('StIntersect :: ChainSync header point tip1) ('StIdle :: ChainSync header point tip1)
MsgDone :: forall {k} {k1} {k2} (header :: k) (point :: k1) (tip :: k2). Message (ChainSync header point tip) ('StIdle :: ChainSync header point tip) ('StDone :: ChainSync header point tip)

type StateToken Source #

Instance details

Defined in Ouroboros.Network.Protocol.ChainSync.Type

type StateToken = SingChainSync :: ChainSync header point tip -> Type

type StateAgency ('StDone :: ChainSync header point tip) Source #

Instance details

Defined in Ouroboros.Network.Protocol.ChainSync.Type

type StateAgency ('StDone :: ChainSync header point tip) = 'NobodyAgency

type StateAgency ('StIdle :: ChainSync header point tip) Source #

Instance details

Defined in Ouroboros.Network.Protocol.ChainSync.Type

type StateAgency ('StIdle :: ChainSync header point tip) = 'ClientAgency

type StateAgency ('StIntersect :: ChainSync header point tip) Source #

Instance details

Defined in Ouroboros.Network.Protocol.ChainSync.Type

type StateAgency ('StIntersect :: ChainSync header point tip) = 'ServerAgency

type StateAgency ('StNext _1 :: ChainSync header point tip) Source #

Instance details

Defined in Ouroboros.Network.Protocol.ChainSync.Type

type StateAgency ('StNext _1 :: ChainSync header point tip) = 'ServerAgency

data SingChainSync (k3 :: ChainSync header point tip) where Source #

Singletons for ChainSync state types.

Constructors

SingIdle :: forall {k} {k1} {k2} {header :: k} {point :: k1} {tip :: k2}. SingChainSync ('StIdle :: ChainSync header point tip)
SingNext :: forall {k} {k1} {k2} {header :: k} {point :: k1} {tip :: k2} (k4 :: StNextKind). SingNextKind k4 -> SingChainSync ('StNext k4 :: ChainSync header point tip)
SingIntersect :: forall {k} {k1} {k2} {header :: k} {point :: k1} {tip :: k2}. SingChainSync ('StIntersect :: ChainSync header point tip)
SingDone :: forall {k} {k1} {k2} {header :: k} {point :: k1} {tip :: k2}. SingChainSync ('StDone :: ChainSync header point tip)

Instances

Instances details

Show (SingChainSync k4) Source #
Instance details Defined in Ouroboros.Network.Protocol.ChainSync.Type Methods showsPrec :: Int -> SingChainSync k4 -> ShowS # show :: SingChainSync k4 -> String # showList :: [SingChainSync k4] -> ShowS #

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.

Instances

Instances details

SingI 'StCanAwait Source #
Instance details Defined in Ouroboros.Network.Protocol.ChainSync.Type Methods sing :: Sing 'StCanAwait #
SingI 'StMustReply Source #
Instance details Defined in Ouroboros.Network.Protocol.ChainSync.Type Methods sing :: Sing 'StMustReply #
type Sing Source #
Instance details Defined in Ouroboros.Network.Protocol.ChainSync.Type type Sing = SingNextKind

data SingNextKind (k :: StNextKind) where Source #

Constructors

SingCanAwait :: SingNextKind 'StCanAwait
SingMustReply :: SingNextKind 'StMustReply

Instances

Instances details

Show (SingNextKind k) Source #
Instance details Defined in Ouroboros.Network.Protocol.ChainSync.Type Methods showsPrec :: Int -> SingNextKind k -> ShowS # show :: SingNextKind k -> String # showList :: [SingNextKind k] -> ShowS #

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 -> () #