Struct cardano_chain_follower::follow::task::FollowTask

pub(super) struct FollowTask {
    connect_info: ClientConnectInfo,
    mithril_snapshot: Option<MithrilSnapshot>,
    request_rx: Receiver<SetReadPointerRequest>,
    chain_update_tx: Sender<Result<ChainUpdate>>,
}

Holds state for a follow task.

Fields

connect_info: ClientConnectInfo

Client connection info.

mithril_snapshot: Option<MithrilSnapshot>

Optional Mithril Snapshot that will be used by the follow task when fetching chain updates.

request_rx: Receiver<SetReadPointerRequest>

Request receiver.

chain_update_tx: Sender<Result<ChainUpdate>>

Chain update sender.

Implementations

impl FollowTask

pub(super) fn spawn( client: PeerClient, connect_info: ClientConnectInfo, mithril_snapshot: Option<MithrilSnapshot>, buffer_size: usize, follow_from: Point, ) -> (Sender<SetReadPointerRequest>, Receiver<Result<ChainUpdate>>, JoinHandle<()>)

Spawn a follow task.

async fn run(self, client: PeerClient, from: Point)

Runs the follow task.

It keeps asking the connected node for new chain updates. Every update and communication errors are sent through the channel to the follower.

Backpressure is achieved with the chain update channel’s limited size.

async fn fetch_chain_updates( client: PeerClient, mithril_snapshot: Option<&MithrilSnapshot>, chain_update_tx: Sender<Result<ChainUpdate>>, from: Point, )

Sends the next chain update to the follower. This can be either read from the Mithril snapshot (if configured) or from the N2N remote client.

async fn next_from_client( client: &mut PeerClient, ) -> Result<Option<ChainUpdate>>

Waits for the next update from the node the client is connected to.

Is cancelled by closing the chain_update_tx receiver end (explicitly or by dropping it).

async fn send_next_chain_update( client: &mut PeerClient, chain_update_tx: Sender<Result<ChainUpdate>>, ) -> bool

Sends the next chain update through the follower’s chain update channel.