Mailbox

commonware_p2p::authenticated

Struct Mailbox 

Source 
pub struct Mailbox<T>(/* private fields */);
Expand description

A mailbox wraps a sender for messages of type T.

Implementations§

Source§

impl<C: PublicKey> Mailbox<Message<C>>

Source

pub async fn bit_vec(&mut self, bit_vec: BitVec)

Source

pub async fn peers(&mut self, peers: Vec<Info<C>>)

Source

pub async fn kill(&mut self)

Source§

impl<P: PublicKey> Mailbox<Message<P>>

Source

pub async fn ready(&mut self, peer: P, relay: Relay<Data>) -> Channels<P>

Notify the router that a peer is ready to communicate.

Source

pub async fn release(&mut self, peer: P)

Notify the router that a peer is no longer available.

This may fail during shutdown if the router has already exited, which is harmless since the router no longer tracks any peers.

Source§

impl<P: PublicKey, O: Sink, I: Stream> Mailbox<Message<O, I, P>>

Source

pub async fn spawn( &mut self, connection: (Sender<O>, Receiver<I>), reservation: Reservation<P>, )

Send a message to the actor to spawn a new task for the given peer.

Source§

impl Mailbox<Message>

Source

pub async fn kill(&mut self)

Source§

impl<P: PublicKey> Mailbox<Message<P>>

Source

pub async fn ready(&mut self, peer: P, relay: Relay<Data>) -> Channels<P>

Notify the router that a peer is ready to communicate.

Source

pub async fn release(&mut self, peer: P)

Notify the router that a peer is no longer available.

This may fail during shutdown if the router has already exited, which is harmless since the router no longer tracks any peers.

Source§

impl<Si: Sink, St: Stream, P: PublicKey> Mailbox<Message<Si, St, P>>

Source

pub async fn spawn( &mut self, connection: (Sender<Si>, Receiver<St>), reservation: Reservation<P>, )

Send a message to the actor to spawn a new task for the given peer.

Source§

impl<T> Mailbox<T>

Source

pub fn new(size: usize) -> (Self, Receiver<T>)

Returns a new mailbox with the given sender.

Source§

impl<T> Mailbox<T>

Source

pub async fn send(&mut self, message: T) -> Result<(), SendError>

Sends a message to the corresponding receiver.

Source

pub fn is_closed(&self) -> bool

Returns true if the mailbox is closed.

Trait Implementations§

Source§

impl<T> Clone for Mailbox<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for Mailbox<T>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for Mailbox<T>

§

impl<T> !RefUnwindSafe for Mailbox<T>

§

impl<T> Send for Mailbox<T>
where T: Send,

§

impl<T> Sync for Mailbox<T>
where T: Send,

§

impl<T> Unpin for Mailbox<T>

§

impl<T> !UnwindSafe for Mailbox<T>

Blanket Implementations§

§

impl<T> Any for T
where T: 'static + ?Sized,

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Borrow<T> for T
where T: ?Sized,

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

impl<T> BorrowMut<T> for T
where T: ?Sized,

§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> CloneToUninit for T
where T: Clone,

§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
§

impl<T, U> Into<U> for T
where U: From<T>,

§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,