Struct Mailbox 

pub struct Mailbox<S: Scheme, B: Block> { /* private fields */ }

A mailbox for sending messages to the marshal Actor.

Implementations

impl<S: Scheme, B: Block> Mailbox<S, B>

pub async fn get_info( &mut self, identifier: impl Into<Identifier<B::Commitment>>, ) -> Option<(u64, B::Commitment)>

A request to retrieve the information about the highest finalized block.

pub async fn get_block( &mut self, identifier: impl Into<Identifier<B::Commitment>>, ) -> Option<B>

A best-effort attempt to retrieve a given block from local storage. It is not an indication to go fetch the block from the network.

pub async fn get_finalization( &mut self, height: u64, ) -> Option<Finalization<S, B::Commitment>>

A best-effort attempt to retrieve a given Finalization from local storage. It is not an indication to go fetch the Finalization from the network.

pub async fn subscribe( &mut self, round: Option<Round>, commitment: B::Commitment, ) -> Receiver<B>

A request to retrieve a block by its commitment.

If the block is found available locally, the block will be returned immediately.

If the block is not available locally, the request will be registered and the caller will be notified when the block is available. If the block is not finalized, it’s possible that it may never become available.

The oneshot receiver should be dropped to cancel the subscription.

pub async fn broadcast(&mut self, block: B)

Broadcast indicates that a block should be sent to all peers.

pub async fn verified(&mut self, round: Round, block: B)

Notifies the actor that a block has been verified.

Trait Implementations

impl<S: Clone + Scheme, B: Clone + Block> Clone for Mailbox<S, B>

fn clone(&self) -> Mailbox<S, B>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<S: Scheme, B: Block> Reporter for Mailbox<S, B>

type Activity = Activity<S, <B as Committable>::Commitment>

Activity is specified by the underlying consensus implementation and can be interpreted if desired.

async fn report(&mut self, activity: Self::Activity)

Report some activity observed by the consensus implementation.