Struct multiqueue::MPMCSender

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

This class is the sending half of the MultiQueue. It supports both single and multi consumer modes with competitive performance in each case. It only supports nonblocking writes (the futures sender being an exception) as well as being the conduit for adding new writers.

Examples

use std::thread;

let (send, recv) = multiqueue::mpmc_queue(4);

let mut handles = vec![];

for i in 0..2 { // or n
    let consumer = recv.clone();
    handles.push(thread::spawn(move || {
        for val in consumer {
            println!("Consumer {} got {}", i, val);
        }
    }));
}

// Take notice that I drop the reader - this removes it from
// the queue, meaning that the readers in the new threads
// won't get starved by the lack of progress from recv
recv.unsubscribe();

for i in 0..10 {
    // Don't do this busy loop in real stuff unless you're really sure
    loop {
        if send.try_send(i).is_ok() {
            break;
        }
    }
}
drop(send);

for t in handles {
    t.join();
}
// prints along the lines of
// Consumer 1 got 2
// Consumer 0 got 0
// Consumer 0 got 1
// etc

Methods

impl<T> MPMCSender<T>

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

Tries to send a value into the queue If there is no space, returns Err(TrySendError::Full(val)) If there are no readers, returns Err(TrySendError::Disconnected(val))

fn unsubscribe(self)

Removes this writer from the queue

Trait Implementations

impl<T: Clone> Clone for MPMCSender<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Send> Send for MPMCSender<T>