Struct TimerFd

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

Represents a timerfd.

See also timerfd_create(2).

Implementations

impl TimerFd

pub fn new_custom( clock: ClockId, nonblocking: bool, cloexec: bool, ) -> IoResult<TimerFd>

Creates a new TimerFd.

By default, it uses the monotonic clock, is blocking and does not close on exec. The parameters allow you to change that.

Errors

On Linux 2.6.26 and earlier, nonblocking and cloexec are not supported and setting them will return an error of kind ErrorKind::InvalidInput.

This can also fail in various cases of resource exhaustion. Please check timerfd_create(2) for details.

pub fn new() -> IoResult<TimerFd>

Creates a new TimerFd with default settings.

Use new_custom to specify custom settings.

pub fn set_state( &mut self, state: TimerState, sflags: SetTimeFlags, ) -> TimerState

Sets this timerfd to a given TimerState and returns the old state.

pub fn get_state(&self) -> TimerState

Returns the current TimerState.

pub fn read(&self) -> u64

Read from this timerfd.

Returns the number of timer expirations since the last read. If this timerfd is operating in blocking mode (the default), it will not return zero but instead block until the timer has expired at least once.

Trait Implementations

impl AsFd for TimerFd

fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor.

impl AsRawFd for TimerFd

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Debug for TimerFd

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

Formats the value using the given formatter.

impl From<TimerFd> for OwnedFd

fn from(fd: TimerFd) -> OwnedFd

Converts to this type from the input type.

impl FromRawFd for TimerFd

unsafe fn from_raw_fd(fd: RawFd) -> Self

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