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 fn proposed(&self, round: Round, block: CodedBlock<B, C, H>)

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

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

Inform the engine of an externally proposed Commitment.

pub fn notarized(&self, commitment: Commitment, round: Round)

Inform the engine that a Commitment was notarized.

This is the leaderless reconstruction signal used by certification. It lets the engine drain sender-indexed gossip shards from its peer buffers for the commitment. Leader-specific validation and assigned shard verification still require a later Self::discovered call.

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

Request a reconstructed block by its Commitment.

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

Request a reconstructed block by its digest.

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

Subscribe to assigned shard verification for a commitment.

For participants, this resolves once the leader-delivered shard for the local participant index has been verified. Reconstructing the full block from gossiped shards does not resolve this subscription: that block may still be used for later certification, but it is not enough to claim the participant received the shard it is expected to echo.

For proposers, this resolves immediately after the locally built block is cached because they trivially have all shards.

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

Subscribe to the reconstruction of a CodedBlock by its Commitment.

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

Subscribe to the reconstruction of a CodedBlock by its digest.

pub 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 PublicKey = P

The public key type used to identify peers.

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

Attempt to find a block by its digest.

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

Attempt to find a block by its commitment.

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

Subscribe to a block’s availability by its digest.

fn subscribe_by_commitment( &self, commitment: Commitment, ) -> Option<Receiver<CodedBlock<B, C, H>>>

Subscribe to a block’s availability by its commitment.

fn finalized(&self, commitment: Commitment)

Notify the buffer that a block has been finalized.

fn send( &self, round: Round, block: CodedBlock<B, C, H>, _recipients: Recipients<P>, )

Send a 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.