Struct zircon_object::signal::EventPair

pub struct EventPair { /* fields omitted */ }

Mutually signalable pair of events for concurrent programming

SYNOPSIS

Event Pairs are linked pairs of user-signalable objects. The 8 signal bits reserved for userspace (ZX_USER_SIGNAL_0 through ZX_USER_SIGNAL_7) may be set or cleared on the local or opposing endpoint of an Event Pair.

Implementations

impl EventPair

pub fn create() -> (Arc<Self>, Arc<Self>)

Create a pair of event.

pub fn peer(&self) -> ZxResult<Arc<Self>>

Get the peer event.

Trait Implementations

impl Debug for EventPair

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

Formats the value using the given formatter.

impl Drop for EventPair

fn drop(&mut self)

Executes the destructor for this type.

impl KernelObject for EventPair

fn id(&self) -> KoID

Get object’s KoID.

fn type_name(&self) -> &str

Get the name of the type of the kernel object.

fn name(&self) -> String

Get object’s name.

fn set_name(&self, name: &str)

Set object’s name.

fn signal(&self) -> Signal

Get the signal status.

fn signal_set(&self, signal: Signal)

Assert signal.

fn signal_clear(&self, signal: Signal)

Deassert signal.

fn signal_change(&self, clear: Signal, set: Signal)

Change signal status: first clear then set indicated bits.

fn add_signal_callback(&self, callback: SignalHandler)

Add callback for signal status changes.

fn allowed_signals(&self) -> Signal

Get object’s allowed signals.

fn peer(&self) -> ZxResult<Arc<dyn KernelObject>>

Attempt to get the object’s peer.

fn related_koid(&self) -> KoID

If the object is related to another (such as the other end of a channel, or the parent of a job), returns the KoID of that object, otherwise returns zero.

fn get_child(&self, _id: KoID) -> ZxResult<Arc<dyn KernelObject>>

Attempt to find a child of the object with given KoID.