Struct WaitQueue 

pub struct WaitQueue(/* private fields */);

A list of waiters waiting for some event.

For events that are generated inside Starnix, we walk the wait queue on the thread that triggered the event to notify the waiters that the event has occurred. The waiters will then wake up on their own thread to handle the event.

Implementations

impl WaitQueue

pub fn wait_async_value(&self, waiter: &Waiter, value: u64) -> WaitCanceler

Establish a wait for the given value event.

The waiter will be notified when an event with the same value occurs.

This function does not actually block the waiter. To block the waiter, call the Waiter::wait function on the waiter.

Returns a WaitCanceler that can be used to cancel the wait.

pub fn wait_async_fd_events( &self, waiter: &Waiter, events: FdEvents, handler: EventHandler, ) -> WaitCanceler

Establish a wait for the given FdEvents.

The waiter will be notified when an event matching the events occurs.

This function does not actually block the waiter. To block the waiter, call the Waiter::wait function on the waiter.

Returns a WaitCanceler that can be used to cancel the wait.

pub fn wait_async_signal_mask( &self, waiter: &Waiter, mask: SigSet, handler: EventHandler, ) -> WaitCanceler

Establish a wait for a particular signal mask.

The waiter will be notified when a signal in the mask is received.

This function does not actually block the waiter. To block the waiter,

Returns a WaitCanceler that can be used to cancel the wait.

pub fn wait_async(&self, waiter: &Waiter) -> WaitCanceler

Establish a wait for any event.

The waiter will be notified when any event occurs.

This function does not actually block the waiter. To block the waiter, call the Waiter::wait function on the waiter.

Returns a WaitCanceler that can be used to cancel the wait.

pub fn wait_async_simple(&self, waiter: &mut SimpleWaiter)

pub fn notify_fd_events(&self, events: FdEvents)

pub fn notify_signal(&self, signal: &Signal)

pub fn notify_value(&self, value: u64)

pub fn notify_unordered_count(&self, limit: usize)

pub fn notify_all(&self)

pub fn is_empty(&self) -> bool

Returns whether there is no active waiters waiting on this WaitQueue.

Trait Implementations

impl Debug for WaitQueue

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for WaitQueue

fn default() -> WaitQueue

Returns the “default value” for a type.