Struct TimerFd 

pub struct TimerFd {
    inner: AsyncFd<Wrapper>,
}

A timer file descriptor.

See the module level documentation for more details.

Fields

inner: AsyncFd<Wrapper>

Implementations

impl TimerFd

pub fn new(clock: ClockId) -> Result<Self>

Creates a new timer file descriptor.

fn as_inner(&self) -> &InnerTimerFd

pub fn get(&self) -> Result<Option<Expiration>>

Returns the current expiration time of the timer.

pub fn set( &self, expiration: Expiration, flags: TimerSetTimeFlags, ) -> Result<()>

Sets the expiration time of the timer.

pub fn set_one_shot( &self, duration: Duration, flags: TimerSetTimeFlags, ) -> Result<()>

Sets the timer to expire once after the given duration.

This is a convenience method calling set with a OneShot expiration.

pub fn set_interval( &self, duration: Duration, flags: TimerSetTimeFlags, ) -> Result<()>

Sets the timer to expire repeatedly with the given interval.

This is a convenience method calling set with an Interval expiration.

pub fn unset(&self) -> Result<()>

Disarms the timer.

pub async fn wait(&self) -> Result<u64>

Waits for the timer to expire.

If not set, the timer will never expire and this function waits forever.

Returns the number of expirations that have occurred since the last call to this method.