Struct backroll_transport::BidirectionalAsyncChannel

pub struct BidirectionalAsyncChannel<T> { /* fields omitted */ }

Implementations

impl<T> BidirectionalAsyncChannel<T>

pub fn create_unbounded_pair() -> (Self, Self)

Creates a pair of connected Peers without limitations on how many messages can be buffered.

pub fn create_bounded_pair(capacity: usize) -> (Self, Self)

Creates a pair of connected Peers with a limited capacity for many messages can be buffered in either direction.

pub fn send(&self, message: T) -> Send<'_, T>

Sends a message to the connected peer.

If the send buffer is full, this method waits until there is space for a message.

If the peer is disconnected, this method returns an error.

pub fn recv(&self) -> Recv<'_, T>

Receives a message from the connected peer.

If there is no pending messages, this method waits until there is a message.

If the peer is disconnected, this method receives a message or returns an error if there are no more messages.

pub fn try_send(&self, message: T) -> Result<(), TrySendError<T>>

Attempts to send a message to the connected peer.

pub fn try_recv(&self) -> Result<T, TryRecvError>

Attempts to receive a message from the connected peer.

pub fn is_connected(&self) -> bool

Returns true if the associated peer is still connected.

pub fn disconnect(&self)

Disconnects the paired Peers from either end. Any future attempts to send messages in either direction will fail, but any messages not yet recieved.

If the Peer, or it’s constituent channels were cloned, all of the cloned instances will appear disconnected.

pub fn sender(&self) -> Sender<T>

Gets the raw sender for the peer.

pub fn reciever(&self) -> Receiver<T>

Gets the raw reciever for the peer.

pub fn pending_send_count(&self) -> usize

The number of messages that are currently buffered in the send queue. Returns 0 if the Peer is disconnected.

pub fn pending_recv_count(&self) -> usize

The number of messages that are currently buffered in the recieve queue. Returns 0 if the Peer is disconnected.

Trait Implementations

impl<T: Clone> Clone for BidirectionalAsyncChannel<T>

fn clone(&self) -> BidirectionalAsyncChannel<T>

Returns a copy of the value.

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

Performs copy-assignment from source.