pub struct Timeout { /* private fields */ }
Expand description
This command will 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§
Source§impl Timeout
impl Timeout
pub const fn new(timespec: *const Timespec) -> Self
Sourcepub const fn count(self, count: u32) -> Self
pub const fn count(self, count: u32) -> Self
count
may contain a completion event count. If not set, this defaults to 1.
Sourcepub const fn flags(self, flags: TimeoutFlags) -> Self
pub const fn flags(self, flags: TimeoutFlags) -> Self
flags
may contain [types::TimeoutFlags::ABS] for an absolutel timeout value, or 0 for a relative timeout.
pub fn build(self) -> Entry
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Timeout
impl RefUnwindSafe for Timeout
impl !Send for Timeout
impl !Sync for Timeout
impl Unpin for Timeout
impl UnwindSafe for Timeout
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more