Struct Multiplexer

pub struct Multiplexer<T>
where
    T: Clone + Send + Sync + 'static,
{
    pub channels: Arc<Mutex<HashMap<Id, Arc<Sender<T>>>>>,
    /* private fields */
}

A simple MPMC (one to many) channel Multiplexer that broadcasts to multiple registered receivers. Multiplexer<T> itself can be cloned and used to broadcast using Multiplexer::broadcast() or Multiplexer::try_broadcast(). To create a receiving channel, you can call MultiplexerChannel<T>::from() and supply the desired Multiplexer instance, or simply call Multiplexer::channel() to create a new MultiplexerChannel instance. The receiving channel gets unregistered when MultiplexerChannel is dropped or the underlying Receiver is closed.

Fields

channels: Arc<Mutex<HashMap<Id, Arc<Sender<T>>>>>

Implementations

impl<T> Multiplexer<T>

where T: Clone + Send + Sync + 'static,

pub fn new() -> Multiplexer<T>

Create a new Multiplexer instance

pub fn channel(&self) -> MultiplexerChannel<T>

Create a new multiplexer receiving channel

pub async fn broadcast(&self, event: T) -> Result<(), ChannelError<T>>

Async Multiplexer::broadcast function that calls Sender::send() on all registered MultiplexerChannel instances.

pub fn try_broadcast(&self, event: T) -> Result<(), ChannelError<T>>

A synchronous Multiplexer::try_broadcast function that calls Sender::try_send() on all registered MultiplexerChannel instances. This function holds a mutex for the duration of the broadcast.

Trait Implementations

impl<T> Clone for Multiplexer<T>

where T: Clone + Send + Sync + 'static,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Default for Multiplexer<T>

where T: Clone + Send + Sync + 'static,

fn default() -> Multiplexer<T>

Returns the “default value” for a type.

impl<T> From<&Multiplexer<T>> for MultiplexerChannel<T>

where T: Clone + Send + Sync + 'static,

Create a MultiplexerChannel from Multiplexer by reference.

fn from(multiplexer: &Multiplexer<T>) -> MultiplexerChannel<T>

Converts to this type from the input type.