Struct zircon_object::signal::Timer

pub struct Timer { /* fields omitted */ }

An object that may be signaled at some point in the future

SYNOPSIS

A timer is used to wait until a specified point in time has occurred or the timer has been canceled.

Implementations

impl Timer

pub fn new() -> Arc<Self>

Create a new Timer.

pub fn with_slack(slack: Slack) -> Arc<Self>

Create a new Timer with slack.

pub fn one_shot(deadline: Duration) -> Arc<Self>

Create a one-shot timer.

pub fn set(self: &Arc<Self>, deadline: Duration, _slack: Duration)

Starts a one-shot timer that will fire when deadline passes.

If a previous call to set was pending, the previous timer is canceled and Signal::SIGNALED is de-asserted as needed.

pub fn cancel(&self)

Cancel the pending timer started by set.

Trait Implementations

impl Debug for Timer

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

Formats the value using the given formatter.

impl KernelObject for Timer

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 get_child(&self, _id: KoID) -> ZxResult<Arc<dyn KernelObject>>

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

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 allowed_signals(&self) -> Signal

Get object’s allowed signals.