Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.Network.NodeToNode

Contents

Handlers
Codecs
Tracers
Applications
- Projections
Re-exports

Description

Intended for qualified import

Synopsis

data Handlers m peer blk = Handlers {
- hChainSyncClient :: NodeToNodeVersion -> ControlMessageSTM m -> StrictTVar m (AnchoredFragment (Header blk)) -> ChainSyncClientPipelined (Header blk) (Point blk) (Tip blk) m ChainSyncClientResult
- hChainSyncServer :: NodeToNodeVersion -> ResourceRegistry m -> ChainSyncServer (SerialisedHeader blk) (Point blk) (Tip blk) m ()
- hBlockFetchClient :: NodeToNodeVersion -> ControlMessageSTM m -> BlockFetchClient (Header blk) blk m ()
- hBlockFetchServer :: NodeToNodeVersion -> ResourceRegistry m -> BlockFetchServer (Serialised blk) (Point blk) m ()
- hTxSubmissionClient :: NodeToNodeVersion -> ControlMessageSTM m -> peer -> TxSubmissionClient (GenTxId blk) (GenTx blk) m ()
- hTxSubmissionServer :: NodeToNodeVersion -> peer -> TxSubmissionServerPipelined (GenTxId blk) (GenTx blk) m ()
- hKeepAliveClient :: NodeToNodeVersion -> ControlMessageSTM m -> peer -> StrictTVar m (Map peer PeerGSV) -> KeepAliveInterval -> KeepAliveClient m ()
- hKeepAliveServer :: NodeToNodeVersion -> peer -> KeepAliveServer m ()
}
mkHandlers :: forall m blk remotePeer localPeer. (IOLike m, MonadTimer m, LedgerSupportsMempool blk, HasTxId (GenTx blk), LedgerSupportsProtocol blk, Ord remotePeer) => NodeArgs m remotePeer localPeer blk -> NodeKernel m remotePeer localPeer blk -> Handlers m remotePeer blk
data Codecs blk e m bCS bSCS bBF bSBF bTX bKA = Codecs {
- cChainSyncCodec :: Codec (ChainSync (Header blk) (Point blk) (Tip blk)) e m bCS
- cChainSyncCodecSerialised :: Codec (ChainSync (SerialisedHeader blk) (Point blk) (Tip blk)) e m bSCS
- cBlockFetchCodec :: Codec (BlockFetch blk (Point blk)) e m bBF
- cBlockFetchCodecSerialised :: Codec (BlockFetch (Serialised blk) (Point blk)) e m bSBF
- cTxSubmissionCodec :: Codec (TxSubmission (GenTxId blk) (GenTx blk)) e m bTX
- cKeepAliveCodec :: Codec KeepAlive e m bKA
}
defaultCodecs :: forall m blk. (IOLike m, SerialiseNodeToNodeConstraints blk) => CodecConfig blk -> BlockNodeToNodeVersion blk -> Codecs blk DeserialiseFailure m ByteString ByteString ByteString ByteString ByteString ByteString
identityCodecs :: Monad m => Codecs blk CodecFailure m (AnyMessage (ChainSync (Header blk) (Point blk) (Tip blk))) (AnyMessage (ChainSync (SerialisedHeader blk) (Point blk) (Tip blk))) (AnyMessage (BlockFetch blk (Point blk))) (AnyMessage (BlockFetch (Serialised blk) (Point blk))) (AnyMessage (TxSubmission (GenTxId blk) (GenTx blk))) (AnyMessage KeepAlive)
type Tracers m peer blk e = Tracers' peer blk e (Tracer m)
data Tracers' peer blk e f = Tracers {
- tChainSyncTracer :: f (TraceLabelPeer peer (TraceSendRecv (ChainSync (Header blk) (Point blk) (Tip blk))))
- tChainSyncSerialisedTracer :: f (TraceLabelPeer peer (TraceSendRecv (ChainSync (SerialisedHeader blk) (Point blk) (Tip blk))))
- tBlockFetchTracer :: f (TraceLabelPeer peer (TraceSendRecv (BlockFetch blk (Point blk))))
- tBlockFetchSerialisedTracer :: f (TraceLabelPeer peer (TraceSendRecv (BlockFetch (Serialised blk) (Point blk))))
- tTxSubmissionTracer :: f (TraceLabelPeer peer (TraceSendRecv (TxSubmission (GenTxId blk) (GenTx blk))))
}
nullTracers :: Monad m => Tracers m peer blk e
showTracers :: (Show blk, Show peer, Show (Header blk), Show (GenTx blk), Show (GenTxId blk), HasHeader blk, HasNestedContent Header blk) => Tracer m String -> Tracers m peer blk e
type ClientApp m peer bytes a = NodeToNodeVersion -> ControlMessageSTM m -> peer -> Channel m bytes -> m (a, Maybe bytes)
type ServerApp m peer bytes a = NodeToNodeVersion -> peer -> Channel m bytes -> m (a, Maybe bytes)
data Apps m peer bCS bBF bTX bKA a = Apps {
- aChainSyncClient :: ClientApp m peer bCS a
- aChainSyncServer :: ServerApp m peer bCS a
- aBlockFetchClient :: ClientApp m peer bBF a
- aBlockFetchServer :: ServerApp m peer bBF a
- aTxSubmissionClient :: ClientApp m peer bTX a
- aTxSubmissionServer :: ServerApp m peer bTX a
- aKeepAliveClient :: ClientApp m peer bKA a
- aKeepAliveServer :: ServerApp m peer bKA a
}
mkApps :: forall m remotePeer localPeer blk e bCS bBF bTX bKA. (IOLike m, MonadTimer m, Ord remotePeer, Exception e, LedgerSupportsProtocol blk, ShowProxy blk, ShowProxy (Header blk), ShowProxy (TxId (GenTx blk)), ShowProxy (GenTx blk)) => NodeKernel m remotePeer localPeer blk -> Tracers m remotePeer blk e -> Codecs blk e m bCS bCS bBF bBF bTX bKA -> m ChainSyncTimeout -> Handlers m remotePeer blk -> Apps m remotePeer bCS bBF bTX bKA ()
initiator :: MiniProtocolParameters -> NodeToNodeVersion -> Apps m (ConnectionId peer) b b b b a -> OuroborosApplication 'InitiatorMode peer b m a Void
responder :: MiniProtocolParameters -> NodeToNodeVersion -> Apps m (ConnectionId peer) b b b b a -> OuroborosApplication 'ResponderMode peer b m Void a
data ChainSyncTimeout = ChainSyncTimeout {
- canAwaitTimeout :: Maybe DiffTime
- mustReplyTimeout :: Maybe DiffTime
}

Handlers

data Handlers m peer blk Source #

Protocol handlers for node-to-node (remote) communication

Constructors

Handlers

Fields

hChainSyncClient :: NodeToNodeVersion -> ControlMessageSTM m -> StrictTVar m (AnchoredFragment (Header blk)) -> ChainSyncClientPipelined (Header blk) (Point blk) (Tip blk) m ChainSyncClientResult
hChainSyncServer :: NodeToNodeVersion -> ResourceRegistry m -> ChainSyncServer (SerialisedHeader blk) (Point blk) (Tip blk) m ()
hBlockFetchClient :: NodeToNodeVersion -> ControlMessageSTM m -> BlockFetchClient (Header blk) blk m ()
hBlockFetchServer :: NodeToNodeVersion -> ResourceRegistry m -> BlockFetchServer (Serialised blk) (Point blk) m ()
hTxSubmissionClient :: NodeToNodeVersion -> ControlMessageSTM m -> peer -> TxSubmissionClient (GenTxId blk) (GenTx blk) m ()
hTxSubmissionServer :: NodeToNodeVersion -> peer -> TxSubmissionServerPipelined (GenTxId blk) (GenTx blk) m ()
hKeepAliveClient :: NodeToNodeVersion -> ControlMessageSTM m -> peer -> StrictTVar m (Map peer PeerGSV) -> KeepAliveInterval -> KeepAliveClient m ()
hKeepAliveServer :: NodeToNodeVersion -> peer -> KeepAliveServer m ()

mkHandlers :: forall m blk remotePeer localPeer. (IOLike m, MonadTimer m, LedgerSupportsMempool blk, HasTxId (GenTx blk), LedgerSupportsProtocol blk, Ord remotePeer) => NodeArgs m remotePeer localPeer blk -> NodeKernel m remotePeer localPeer blk -> Handlers m remotePeer blk Source #

Codecs

data Codecs blk e m bCS bSCS bBF bSBF bTX bKA Source #

Node-to-node protocol codecs needed to run Handlers.

Constructors

Codecs

Fields

cChainSyncCodec :: Codec (ChainSync (Header blk) (Point blk) (Tip blk)) e m bCS
cChainSyncCodecSerialised :: Codec (ChainSync (SerialisedHeader blk) (Point blk) (Tip blk)) e m bSCS
cBlockFetchCodec :: Codec (BlockFetch blk (Point blk)) e m bBF
cBlockFetchCodecSerialised :: Codec (BlockFetch (Serialised blk) (Point blk)) e m bSBF
cTxSubmissionCodec :: Codec (TxSubmission (GenTxId blk) (GenTx blk)) e m bTX
cKeepAliveCodec :: Codec KeepAlive e m bKA

defaultCodecs :: forall m blk. (IOLike m, SerialiseNodeToNodeConstraints blk) => CodecConfig blk -> BlockNodeToNodeVersion blk -> Codecs blk DeserialiseFailure m ByteString ByteString ByteString ByteString ByteString ByteString Source #

Protocol codecs for the node-to-node protocols

identityCodecs :: Monad m => Codecs blk CodecFailure m (AnyMessage (ChainSync (Header blk) (Point blk) (Tip blk))) (AnyMessage (ChainSync (SerialisedHeader blk) (Point blk) (Tip blk))) (AnyMessage (BlockFetch blk (Point blk))) (AnyMessage (BlockFetch (Serialised blk) (Point blk))) (AnyMessage (TxSubmission (GenTxId blk) (GenTx blk))) (AnyMessage KeepAlive) Source #

Identity codecs used in tests.

Tracers

type Tracers m peer blk e = Tracers' peer blk e (Tracer m) Source #

A record of Tracers for the different protocols.

data Tracers' peer blk e f Source #

Constructors

Tracers

Fields

tChainSyncTracer :: f (TraceLabelPeer peer (TraceSendRecv (ChainSync (Header blk) (Point blk) (Tip blk))))
tChainSyncSerialisedTracer :: f (TraceLabelPeer peer (TraceSendRecv (ChainSync (SerialisedHeader blk) (Point blk) (Tip blk))))
tBlockFetchTracer :: f (TraceLabelPeer peer (TraceSendRecv (BlockFetch blk (Point blk))))
tBlockFetchSerialisedTracer :: f (TraceLabelPeer peer (TraceSendRecv (BlockFetch (Serialised blk) (Point blk))))
tTxSubmissionTracer :: f (TraceLabelPeer peer (TraceSendRecv (TxSubmission (GenTxId blk) (GenTx blk))))

Instances

Instances details

(forall a. Semigroup (f a)) => Semigroup (Tracers' peer blk e f) Source #
Instance details Defined in Ouroboros.Consensus.Network.NodeToNode Methods (<>) :: Tracers' peer blk e f -> Tracers' peer blk e f -> Tracers' peer blk e f # sconcat :: NonEmpty (Tracers' peer blk e f) -> Tracers' peer blk e f # stimes :: Integral b => b -> Tracers' peer blk e f -> Tracers' peer blk e f #

nullTracers :: Monad m => Tracers m peer blk e Source #

Use a nullTracer for each protocol.

showTracers :: (Show blk, Show peer, Show (Header blk), Show (GenTx blk), Show (GenTxId blk), HasHeader blk, HasNestedContent Header blk) => Tracer m String -> Tracers m peer blk e Source #

Applications

type ClientApp m peer bytes a = NodeToNodeVersion -> ControlMessageSTM m -> peer -> Channel m bytes -> m (a, Maybe bytes) Source #

A node-to-node application

type ServerApp m peer bytes a = NodeToNodeVersion -> peer -> Channel m bytes -> m (a, Maybe bytes) Source #

data Apps m peer bCS bBF bTX bKA a Source #

Applications for the node-to-node protocols

See MuxApplication

Constructors

Apps

Fields

aChainSyncClient :: ClientApp m peer bCS a
Start a chain sync client that communicates with the given upstream node.
aChainSyncServer :: ServerApp m peer bCS a
Start a chain sync server.
aBlockFetchClient :: ClientApp m peer bBF a
Start a block fetch client that communicates with the given upstream node.
aBlockFetchServer :: ServerApp m peer bBF a
Start a block fetch server.
aTxSubmissionClient :: ClientApp m peer bTX a
Start a transaction submission client that communicates with the given upstream node.
aTxSubmissionServer :: ServerApp m peer bTX a
Start a transaction submission server.
aKeepAliveClient :: ClientApp m peer bKA a
Start a keep-alive client.
aKeepAliveServer :: ServerApp m peer bKA a
Start a keep-alive server.

mkApps Source #

Arguments

:: forall m remotePeer localPeer blk e bCS bBF bTX bKA. (IOLike m, MonadTimer m, Ord remotePeer, Exception e, LedgerSupportsProtocol blk, ShowProxy blk, ShowProxy (Header blk), ShowProxy (TxId (GenTx blk)), ShowProxy (GenTx blk))
=> NodeKernel m remotePeer localPeer blk	Needed for bracketing only
-> Tracers m remotePeer blk e
-> Codecs blk e m bCS bCS bBF bBF bTX bKA
-> m ChainSyncTimeout
-> Handlers m remotePeer blk
-> Apps m remotePeer bCS bBF bTX bKA ()

Construct the NetworkApplication for the node-to-node protocols

Projections

initiator :: MiniProtocolParameters -> NodeToNodeVersion -> Apps m (ConnectionId peer) b b b b a -> OuroborosApplication 'InitiatorMode peer b m a Void Source #

A projection from NetworkApplication to a client-side OuroborosApplication for the node-to-node protocols.

Implementation note: network currently doesn't enable protocols conditional on the protocol version, but it eventually may; this is why _version is currently unused.

responder :: MiniProtocolParameters -> NodeToNodeVersion -> Apps m (ConnectionId peer) b b b b a -> OuroborosApplication 'ResponderMode peer b m Void a Source #

A projection from NetworkApplication to a server-side OuroborosApplication for the node-to-node protocols.

See initiatorNetworkApplication for rationale for the _version arg.

Re-exports

data ChainSyncTimeout #

Constructors

ChainSyncTimeout
Fields canAwaitTimeout :: Maybe DiffTime mustReplyTimeout :: Maybe DiffTime