Struct Mailbox 

pub struct Mailbox<B, C, H, P>
where
    B: CertifiableBlock,
    C: CodingScheme,
    H: Hasher,
    P: PublicKey,
{ /* private fields */ }

A mailbox for sending messages to the Engine.

Implementations

impl<B, C, H, P> Mailbox<B, C, H, P>

where B: CertifiableBlock, C: CodingScheme, H: Hasher, P: PublicKey,

pub const fn new(sender: Sender<Message<B, C, H, P>>) -> Self

Create a new Mailbox with the given sender.

pub async fn proposed(&self, round: Round, block: CodedBlock<B, C, H>)

Broadcast a proposed erasure coded block’s shards to the participants.

pub async fn discovered(&self, commitment: Commitment, leader: P, round: Round)

Inform the engine of an externally proposed Commitment.

pub async fn get( &self, commitment: Commitment, ) -> Option<Arc<CodedBlock<B, C, H>>>

Request a reconstructed block by its Commitment.

pub async fn get_by_digest( &self, digest: B::Digest, ) -> Option<Arc<CodedBlock<B, C, H>>>

Request a reconstructed block by its digest.

pub async fn subscribe_shard(&self, commitment: Commitment) -> Receiver<()>

Subscribe to the receipt of our valid shard from the leader.

pub async fn subscribe( &self, commitment: Commitment, ) -> Receiver<Arc<CodedBlock<B, C, H>>>

Subscribe to the reconstruction of a CodedBlock by its Commitment.

pub async fn subscribe_by_digest( &self, digest: B::Digest, ) -> Receiver<Arc<CodedBlock<B, C, H>>>

Subscribe to the reconstruction of a CodedBlock by its digest.

pub async fn prune(&self, through: Commitment)

Request to prune all caches at and below the given commitment.

Trait Implementations

impl<B, C, H, P> Buffer<Coding<B, C, H, P>> for Mailbox<B, C, H, P>

where B: CertifiableBlock<Context = Context<Commitment, P>>, C: CodingScheme, H: Hasher, P: PublicKey,

type CachedBlock = Arc<CodedBlock<B, C, H>>

The cached block type held internally by the buffer.

async fn find_by_digest( &self, digest: <CodedBlock<B, C, H> as Digestible>::Digest, ) -> Option<Self::CachedBlock>

Attempt to find a block by its digest.

async fn find_by_commitment( &self, commitment: Commitment, ) -> Option<Self::CachedBlock>

Attempt to find a block by its commitment.

async fn subscribe_by_digest( &self, digest: <CodedBlock<B, C, H> as Digestible>::Digest, ) -> Receiver<Self::CachedBlock>

Subscribe to a block’s availability by its digest.

async fn subscribe_by_commitment( &self, commitment: Commitment, ) -> Receiver<Self::CachedBlock>

Subscribe to a block’s availability by its commitment.

async fn finalized(&self, commitment: Commitment)

Notify the buffer that a block has been finalized.

async fn proposed(&self, round: Round, block: CodedBlock<B, C, H>)

Broadcast a proposed block to peers.

impl<B, C, H, P> Clone for Mailbox<B, C, H, P>

where B: CertifiableBlock + Clone, C: CodingScheme + Clone, H: Hasher + Clone, P: PublicKey + Clone,

fn clone(&self) -> Mailbox<B, C, H, P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.