Struct CondVar

pub struct CondVar {
    inner: Mutex<Wakers>,
}

CondVar is an async version of https://doc.rust-lang.org/std/sync/struct.Condvar.html

Example

 use std::sync::Arc;

 use karyon_core::async_util::CondVar;
 use karyon_core::async_runtime::{spawn, lock::Mutex};

  async {
     
     let val = Arc::new(Mutex::new(false));
     let condvar = Arc::new(CondVar::new());

     spawn({
         let val = val.clone();
         let condvar = condvar.clone();
         async move {
             let mut val = val.lock().await;

             // While the boolean flag is false, wait for a signal.
             while !*val {
                 val = condvar.wait(val).await;
             }

             // ...
         }
     });

     spawn({
         let condvar = condvar.clone();
         async move {
             let mut val = val.lock().await;

             // While the boolean flag is false, wait for a signal.
             while !*val {
                 val = condvar.wait(val).await;
             }

             // ...
         }
     });
     
     // Wake up all waiting tasks on this condvar
     condvar.broadcast();
  };

Fields

inner: Mutex<Wakers>

Implementations

impl CondVar

pub fn new() -> Self

Creates a new CondVar

pub async fn wait<'a, T>(&self, g: MutexGuard<'a, T>) -> MutexGuard<'a, T>

Blocks the current task until this condition variable receives a notification.

pub fn signal(&self)

Wakes up one blocked task waiting on this condvar.

pub fn broadcast(&self)

Wakes up all blocked tasks waiting on this condvar.

Trait Implementations

impl Default for CondVar

fn default() -> Self

Returns the “default value” for a type.