DoxigAlpha

wait

Block's the callers thread until the ResetEvent is set(). This is effectively a more efficient version of while (!isSet()) {}. The memory accesses before the set() can be said to happen before wait() returns.

Function parameters

Parameters

#
self:*ResetEvent

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 wait(self: *ResetEvent) void {
    self.impl.wait(null) catch |err| switch (err) {
        error.Timeout => unreachable, // no timeout provided so we shouldn't have timed-out
    };
}