Struct Mailbox 

pub struct Mailbox<P: PublicKey, M: Committable + Digestible + Codec> { /* private fields */ }

Ingress mailbox for super::Engine.

Implementations

impl<P: PublicKey, M: Committable + Digestible + Codec> Mailbox<P, M>

pub async fn subscribe( &mut self, peer: Option<P>, commitment: M::Commitment, digest: Option<M::Digest>, ) -> Receiver<M>

Subscribe to a message by peer (optionally), commitment, and digest (optionally).

The responder will be sent the first message for an commitment when it is available; either instantly (if cached) or when it is received from the network. The request can be canceled by dropping the responder.

If the engine has shut down, the returned receiver will resolve to Canceled.

pub async fn subscribe_prepared( &mut self, peer: Option<P>, commitment: M::Commitment, digest: Option<M::Digest>, responder: Sender<M>, )

Subscribe to a message by peer (optionally), commitment, and digest (optionally) with an externally prepared responder.

The responder will be sent the first message for an commitment when it is available; either instantly (if cached) or when it is received from the network. The request can be canceled by dropping the responder.

If the engine has shut down, this is a no-op.

pub async fn get( &mut self, peer: Option<P>, commitment: M::Commitment, digest: Option<M::Digest>, ) -> Vec<M>

Get all messages for an commitment.

If the engine has shut down, returns an empty vector.

Trait Implementations

impl<P: PublicKey, M: Committable + Digestible + Codec> Broadcaster for Mailbox<P, M>

async fn broadcast( &mut self, recipients: Self::Recipients, message: Self::Message, ) -> Receiver<Self::Response>

Broadcast a message to recipients.

If the engine has shut down, the returned receiver will resolve to Canceled.

type Recipients = Recipients<P>

The type of recipients that can receive messages.

type Message = M

Message is the type of data that can be broadcasted.

type Response = Vec<P>

The type of data that is returned once the message is broadcasted.

impl<P: Clone + PublicKey, M: Clone + Committable + Digestible + Codec> Clone for Mailbox<P, M>

fn clone(&self) -> Mailbox<P, M>

Returns a duplicate of the value.

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

Performs copy-assignment from source.