DoxigAlpha

timedWait

Block's the callers thread until the ResetEvent is set(), or until the corresponding timeout expires. If the timeout expires before the ResetEvent is set, error.Timeout is returned. This is effectively a more efficient version of while (!isSet()) {}. The memory accesses before the set() can be said to happen before timedWait() returns without error.

Function parameters

Parameters

#
self:*ResetEvent
timeout_ns:u64

Returns if the ResetEvent was set().

Functions

#
isSet
Returns if the ResetEvent was set().
wait
Block's the callers thread until the ResetEvent is set().
timedWait
Block's the callers thread until the ResetEvent is set(), or until the corresponding timeout expires.
set
Marks the ResetEvent as "set" and unblocks any threads in `wait()` or `timedWait()` to observe the new state.
reset
Unmarks the ResetEvent from its "set" state if set() was called previously.

Source

Implementation

#
pub fn timedWait(self: *ResetEvent, timeout_ns: u64) error{Timeout}!void {
    return self.impl.wait(timeout_ns);
}