Struct greenie::common::condvar::Condvar

pub struct Condvar { /* fields omitted */ }

Synchronization primitive that can be used to block a thread, or multiple threads at the same time, until another thread both modifies a shared variable (the condition), and notifies the condition_variable.

Methods

impl Condvar

pub fn new() -> Self

pub fn wait_for_mutex(&self, m: &Mutex)

wait causes the current thread to block until the condition variable is notified or a spurious wakeup occurs, optionally looping until some predicate is satisfied.

Atomically unlocks lock, blocks the current executing thread, and adds it to the list of threads waiting on self. The thread will be unblocked when notify_all() or notify_one() is executed. It may also be unblocked spuriously. When unblocked, regardless of the reason, lock is reacquired and wait exits.

pub fn wait_pred(&self, m: &Mutex, pred: impl FnMut() -> bool)

Equivalent to

while !pred() {
      self.wait_for_mutex(m);
}

pub fn notify_one(&self)

If any threads are waiting on this condvar, calling notify_one unblocks one of the waiting threads.

pub fn notify_all(&self)

Unblocks all threads currently waiting for this condvar.

Trait Implementations

impl Clone for Condvar

fn clone(&self) -> Condvar

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Drop for Condvar

fn drop(&mut self)

Executes the destructor for this type.