Safe Haskell	None
Language	Haskell2010

Ouroboros.Network.Protocol.BlockFetch.Client

Synopsis

newtype BlockFetchClient block point m a = BlockFetchClient {
- runBlockFetchClient :: m ( BlockFetchRequest block point m a)
}
data BlockFetchRequest block point m a where
- SendMsgRequestRange :: ChainRange point -> BlockFetchResponse block m a -> BlockFetchClient block point m a -> BlockFetchRequest block point m a
- SendMsgClientDone :: a -> BlockFetchRequest block point m a
data BlockFetchResponse block m a = BlockFetchResponse {
- handleStartBatch :: m ( BlockFetchReceiver block m)
- handleNoBlocks :: m ()
}
data BlockFetchReceiver block m = BlockFetchReceiver {
- handleBlock :: block -> m ( BlockFetchReceiver block m)
- handleBatchDone :: m ()
}
blockFetchClientPeer :: forall block point m a. Monad m => BlockFetchClient block point m a -> Peer ( BlockFetch block point) AsClient BFIdle m a
data BlockFetchClientPipelined block point m a where
- BlockFetchClientPipelined :: BlockFetchSender Z c block point m a -> BlockFetchClientPipelined block point m a
data BlockFetchSender n c block point m a where
- SendMsgRequestRangePipelined :: ChainRange point -> c -> ( Maybe block -> c -> m c) -> BlockFetchSender ( S n) c block point m a -> BlockFetchSender n c block point m a
- CollectBlocksPipelined :: Maybe ( BlockFetchSender ( S n) c block point m a) -> (c -> BlockFetchSender n c block point m a) -> BlockFetchSender ( S n) c block point m a
- SendMsgDonePipelined :: a -> BlockFetchSender Z c block point m a
blockFetchClientPeerPipelined :: forall block point m a. Monad m => BlockFetchClientPipelined block point m a -> PeerPipelined ( BlockFetch block point) AsClient BFIdle m a
blockFetchClientPeerSender :: forall n block point c m a. Monad m => BlockFetchSender n c block point m a -> PeerSender ( BlockFetch block point) AsClient BFIdle n c m a

Documentation

newtype BlockFetchClient block point m a Source #

Block fetch client type for requesting ranges of blocks and handling responses.

Constructors

BlockFetchClient
Fields runBlockFetchClient :: m ( BlockFetchRequest block point m a)

data BlockFetchRequest block point m a where Source #

Constructors

SendMsgRequestRange :: ChainRange point -> BlockFetchResponse block m a -> BlockFetchClient block point m a -> BlockFetchRequest block point m a	Request a chain range, supply handler for incoming blocks and a continuation.
SendMsgClientDone :: a -> BlockFetchRequest block point m a	Client terminating the block-fetch protocol.

data BlockFetchResponse block m a Source #

Constructors

BlockFetchResponse
Fields handleStartBatch :: m ( BlockFetchReceiver block m) handleNoBlocks :: m ()

data BlockFetchReceiver block m Source #

Blocks are streamed and block receiver will handle each one when it comes, it also needs to handle errors sent back from the server.

Constructors

BlockFetchReceiver
Fields handleBlock :: block -> m ( BlockFetchReceiver block m) handleBatchDone :: m ()

blockFetchClientPeer :: forall block point m a. Monad m => BlockFetchClient block point m a -> Peer ( BlockFetch block point) AsClient BFIdle m a Source #

data BlockFetchClientPipelined block point m a where Source #

A BlockFetch client designed for running the protcol in a pipelined way.

Constructors

BlockFetchClientPipelined :: BlockFetchSender Z c block point m a -> BlockFetchClientPipelined block point m a

A BlockFetchSender , but starting with zero outstanding pipelined responses, and for any internal collect type c .

data BlockFetchSender n c block point m a where Source #

A BlockFetchSender with n outstanding stream of block bodies.

Constructors

SendMsgRequestRangePipelined :: ChainRange point -> c -> ( Maybe block -> c -> m c) -> BlockFetchSender ( S n) c block point m a -> BlockFetchSender n c block point m a	Send a `MsgRequestRange` but do not wait for response. Supply a monadic action which runs on each received block and which updates the internal received value `c` . `c` could be a Monoid, though it's more general this way.
CollectBlocksPipelined :: Maybe ( BlockFetchSender ( S n) c block point m a) -> (c -> BlockFetchSender n c block point m a) -> BlockFetchSender ( S n) c block point m a	Collect the result of a previous pipelined receive action
SendMsgDonePipelined :: a -> BlockFetchSender Z c block point m a	Termination of the block-fetch protocol.

blockFetchClientPeerPipelined :: forall block point m a. Monad m => BlockFetchClientPipelined block point m a -> PeerPipelined ( BlockFetch block point) AsClient BFIdle m a Source #

blockFetchClientPeerSender :: forall n block point c m a. Monad m => BlockFetchSender n c block point m a -> PeerSender ( BlockFetch block point) AsClient BFIdle n c m a Source #