Struct swap::worker::Channel

pub struct Channel<T> {
    state: Mutex<ChannelState<T>>,
    consumer_wait: Condvar,
    producer_wait: Condvar,
    n_consumers: usize,
}

MPMC (Multi Producers Multi Consumers) queue integrated with Worker.

Channel offers Channel::wait_complete() to guarantee all the tasks are executed.

This only exposes methods for producers.

Fields

state: Mutex<ChannelState<T>>

consumer_wait: Condvar

producer_wait: Condvar

n_consumers: usize

Implementations

impl<T> Channel<T>

fn new(len: usize, n_consumers: usize) -> Self

fn close(&self)

fn pop(&self) -> Option<T>

Pops a task from the channel.

If the queue is closed and also empty, this returns None. This returns all the tasks in the queue even while this is closed.

pub fn push(&self, item: T) -> bool

Push a task.

This blocks if the channel is full.

If the channel is closed, this returns false.

pub fn wait_complete(&self)

Wait until all the tasks have been executed.

This guarantees that all the tasks in this channel are not only consumed but also executed.