Struct mpmc_scheduler::Controller

pub struct Controller<K, V, R> where
    K: Sync + Send + Hash + Eq,
    V: Sync + Send + 'static,
    R: 'static,  { /* fields omitted */ }

The Controller is a non-producing handle to the scheduler. It allows creation of new channels as well as clearing of queues.

Methods

impl<K, V, R> Controller<K, V, R> where
    K: Sync + Send + Hash + Eq,
    V: Sync + Send + 'static,
    R: 'static, 

pub fn channel(&self, key: K, bound: usize) -> Sender<V>

Create a new channel, returns the producer site. See below for bound. May block if clearing or scheduling tick is currently running.

Bound

Is the next power of two for the handed value

pub fn cancel_channel(&self, key: &K) -> Result<(), ()>

Clear queue for specific channel & running jobs if supported.

May block if channel is called or a schedule is running. Note that for a queue with bounds n, it has a O(n) worst case complexity.

Returns Err if the specified channel is invalid.

pub fn gc(&self)

Manually trigger schedule. Normaly not required but if you should drop a lot of channels and don't insert/complete a job in the next time, you may call this.

pub fn set_worker_max(&self, max_workers: usize)

Change maximum amount of workers.
Takes effect on next schedule.

pub fn get_worker_max(&self) -> usize

Returns currently set max amount of workers.

Trait Implementations

impl<K: Clone, V: Clone, R: Clone> Clone for Controller<K, V, R> where
    K: Sync + Send + Hash + Eq,
    V: Sync + Send + 'static,
    R: 'static, 

fn clone(&self) -> Controller<K, V, R>

Returns a copy of the value.

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

Performs copy-assignment from source.