Struct TimerFd

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

A safe wrapper around a Linux timerfd (man 2 timerfd_create).

Implementations

impl TimerFd

pub fn new() -> Result<TimerFd>

Creates a new timerfd. The timer is initally disarmed and must be armed by calling reset.

pub fn reset(&mut self, dur: Duration, interval: Option<Duration>) -> Result<()>

Sets the timer to expire after dur. If interval is not None it represents the period for repeated expirations after the initial expiration. Otherwise the timer will expire just once. Cancels any existing duration and repeating interval.

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

Waits until the timer expires. The return value represents the number of times the timer has expired since the last time wait was called. If the timer has not yet expired once this call will block until it does.

pub fn is_armed(&self) -> Result<bool>

Returns true if the timer is currently armed.

pub fn clear(&mut self) -> Result<()>

Disarms the timer.

Trait Implementations

impl AsRawFd for TimerFd

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl FromRawFd for TimerFd

unsafe fn from_raw_fd(fd: RawFd) -> Self

Constructs a new instance of Self from the given raw file descriptor.

impl IntoRawFd for TimerFd

fn into_raw_fd(self) -> RawFd

Consumes this object, returning the raw underlying file descriptor.