Struct Mailbox 

pub struct Mailbox<S, V>
where
    S: Scheme,
    V: Variant,
{ /* private fields */ }

Handle to the mailbox of the Probe.

Implementations

impl<S, V> Mailbox<S, V>

where S: Scheme, V: Variant,

pub fn subscribe(&self) -> Receiver<Finalization<S, V::Commitment>>

Open a subscription to the receipt of the floor finalization from peers.

While the actor is still discovering, this requests discovery if no floor has been selected yet. Dropping the receiver cancels this subscription; if all subscribers are dropped before a floor is selected, discovery may be abandoned. If marshal is later attached, the actor transitions to service without a cached floor and later subscriptions will not restart discovery.

Callers that need a floor must keep the receiver alive until it resolves and should attach only after consuming that floor.

If a floor has already been selected, the receiver resolves immediately.

pub fn attach(&self, marshal: MarshalMailbox<S, V>)

Attach a marshal mailbox so the actor can serve the latest finalization to peers.

This moves the actor from discovery to service. It is applied only after any discovered floor has been delivered to its subscribers. If no floor was ever requested, or every pending subscriber was dropped before a floor was selected, the actor serves without a cached floor.

Trait Implementations

impl<S, V> Clone for Mailbox<S, V>

where S: Scheme + Clone, V: Variant + Clone,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.