Moduleouroboros-consensus-4.2.1.0

Ouroboros.Consensus.MiniProtocol.ChainSync.Client.Jumping

9 types
7 values

Packageouroboros-consensus-4.2.1.0
Exports16
LicenceApache-2.0

valuegetDynamo

:: MonadSTM m
=> ChainSyncClientHandleCollection peer m blk
-> STM m (Maybe (peer, ChainSyncClientHandle m blk))

valuemakeContext

:: MonadSTM m
=> ChainSyncClientHandleCollection peer m blk
-> SlotNo
-> Tracer m (TraceEventCsj peer blk)
-> STM m (Context m peer blk)

valuemkJumping

:: (MonadSTM m, Eq peer, LedgerSupportsProtocol blk)
=> PeerContext m peer blk
-> Jumping m blk

valuenoJumping :: MonadSTM m => Jumping m blk

valueregisterClient

:: (LedgerSupportsProtocol blk, IOLike m)
=> GsmState
-> Context m peer blk
-> peer
-> StrictTVar m (ChainSyncState blk)
-> StrictTVar m (ChainSyncJumpingState m blk) -> ChainSyncClientHandle m blk
-> STM m (PeerContext m peer blk, Maybe (TraceEventCsj peer blk))

valuerotateDynamo

:: (Ord peer, LedgerSupportsProtocol blk, MonadSTM m)
=> Tracer m (TraceEventDbf peer)
-> ChainSyncClientHandleCollection peer m blk
-> peer
-> m ()

valueunregisterClient

:: (MonadSTM m, Ord peer, LedgerSupportsProtocol blk)
=> PeerContext m peer blk
-> STM m (Maybe (TraceEventCsj peer blk))

typetype Context = ContextWith () ()

datadata ContextWith peerField handleField (m :: Type -> Type) peer blk

Constructors

Context
- peer :: !peerField
- handle :: !handleField
- handlesCol :: !ChainSyncClientHandleCollection peer m blk
- jumpSize :: !SlotNo
- tracer :: Tracer m (TraceEventCsj peer blk)

datadata Instruction blk

Instances5Eq, Show, Generic, NoThunks, Rep

(Typeable blk, HasHeader (Header blk), Eq (Header blk)) => Eq (Instruction blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client.Jumping
(Typeable blk, HasHeader (Header blk), Show (Header blk)) => Show (Instruction blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client.Jumping
Generic (Instruction blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client.Jumping
(HasHeader blk, LedgerSupportsProtocol blk, NoThunks (Header blk)) => NoThunks (Instruction blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client.Jumping
type Rep (Instruction blk) = D1 ('MetaData "Instruction" "Ouroboros.Consensus.MiniProtocol.ChainSync.Client.Jumping" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'False) (C1 ('MetaCons "RunNormally" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "Restart" 'PrefixI 'False) U1 :+: C1 ('MetaCons "JumpInstruction" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (JumpInstruction blk)))))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client.Jumping

datadata JumpInstruction blk

Constructors

JumpTo !(JumpInfo blk)
JumpToGoodPoint !(JumpInfo blk)

Instances5Eq, Show, Generic, NoThunks, Rep

(Typeable blk, HasHeader (Header blk), Eq (Header blk)) => Eq (JumpInstruction blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client.Jumping
(Typeable blk, HasHeader (Header blk), Show (Header blk)) => Show (JumpInstruction blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client.Jumping
Generic (JumpInstruction blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client.Jumping
(HasHeader blk, LedgerSupportsProtocol blk, NoThunks (Header blk)) => NoThunks (JumpInstruction blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client.Jumping
type Rep (JumpInstruction blk) = D1 ('MetaData "JumpInstruction" "Ouroboros.Consensus.MiniProtocol.ChainSync.Client.Jumping" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'False) (C1 ('MetaCons "JumpTo" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (JumpInfo blk))) :+: C1 ('MetaCons "JumpToGoodPoint" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (JumpInfo blk))))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client.Jumping

datadata JumpResult blk

Constructors

AcceptedJump !(JumpInstruction blk)
RejectedJump !(JumpInstruction blk)

Instances5Eq, Show, Generic, NoThunks, Rep

(Typeable blk, HasHeader (Header blk), Eq (Header blk)) => Eq (JumpResult blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client.Jumping
(Typeable blk, HasHeader (Header blk), Show (Header blk)) => Show (JumpResult blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client.Jumping
Generic (JumpResult blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client.Jumping
(HasHeader blk, LedgerSupportsProtocol blk, NoThunks (Header blk)) => NoThunks (JumpResult blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client.Jumping
type Rep (JumpResult blk) = D1 ('MetaData "JumpResult" "Ouroboros.Consensus.MiniProtocol.ChainSync.Client.Jumping" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'False) (C1 ('MetaCons "AcceptedJump" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (JumpInstruction blk))) :+: C1 ('MetaCons "RejectedJump" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (JumpInstruction blk))))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client.Jumping

datadata Jumping (m :: Type -> Type) blk

Constructors

Jumping
- jgNextInstruction :: !m (Instruction blk)
- jgOnAwaitReply :: !m ()
- jgOnRollForward :: !Point (Header blk) -> m ()
- jgOnRollBackward :: !WithOrigin SlotNo -> m ()
- jgProcessJumpResult :: !JumpResult blk -> m ()
- jgUpdateJumpInfo :: !JumpInfo blk -> STM m ()

Instances3Generic, NoThunks, Rep

Generic (Jumping m blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client.Jumping
(IOLike m, HasHeader blk, NoThunks (Header blk)) => NoThunks (Jumping m blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client.Jumping
type Rep (Jumping m blk) = D1 ('MetaData "Jumping" "Ouroboros.Consensus.MiniProtocol.ChainSync.Client.Jumping" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'False) (C1 ('MetaCons "Jumping" 'PrefixI 'True) ((S1 ('MetaSel ('Just "jgNextInstruction") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (m (Instruction blk))) :*: (S1 ('MetaSel ('Just "jgOnAwaitReply") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (m ())) :*: S1 ('MetaSel ('Just "jgOnRollForward") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Point (Header blk) -> m ())))) :*: (S1 ('MetaSel ('Just "jgOnRollBackward") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (WithOrigin SlotNo -> m ())) :*: (S1 ('MetaSel ('Just "jgProcessJumpResult") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (JumpResult blk -> m ())) :*: S1 ('MetaSel ('Just "jgUpdateJumpInfo") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (JumpInfo blk -> STM m ()))))))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client.Jumping

datadata TraceCsjReason

BecauseCsjDisengage BecauseCsjDisconnect

Instances1Show

Show TraceCsjReasonDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client.Jumping

datadata TraceEventCsj peer blk

Constructors

BecomingObjector (Maybe peer)
BlockedOnJump
InitializedAsDynamo
NoLongerDynamo (Maybe peer) TraceCsjReason
NoLongerObjector (Maybe peer) TraceCsjReason
SentJumpInstruction (Point blk)

Instances1Show

(StandardHash blk, Show peer) => Show (TraceEventCsj peer blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client.Jumping

datadata TraceEventDbf peer

Constructors

RotatedDynamo peer peer

Instances1Show

Show peer => Show (TraceEventDbf peer)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client.Jumping