Struct Timeout

pub struct Timeout { /* private fields */ }

Register a timeout operation.

A timeout will trigger a wakeup event on the completion ring for anyone waiting for events. A timeout condition is met when either the specified timeout expires, or the specified number of events have completed. Either condition will trigger the event. The request will complete with -ETIME if the timeout got completed through expiration of the timer, or 0 if the timeout got completed through requests completing on their own. If the timeout was cancelled before it expired, the request will complete with -ECANCELED.

Implementations

impl Timeout

pub const CODE: u8 = 11u8

The opcode of the operation. This can be passed to Probe::is_supported to check if this operation is supported with the current kernel.

pub fn new(timespec: *const Timespec) -> Self

pub const fn count(self, count: u32) -> Self

count may contain a completion event count. If [TimeoutFlags::TIMEOUT] is set in flags, this is the number of repeats. A value of 0 means the timeout is indefinite and can only be stopped by a removal request.

pub const fn flags(self, flags: TimeoutFlags) -> Self

pub fn build(self) -> Entry

Trait Implementations

impl Debug for Timeout

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

Formats the value using the given formatter.