chsv_event_reset()

int Chusov::ExecutionControl::chsv_event_reset ( chsv_event_t *  pEvent )

noexcept

Sets the specified event to a nonsignalled state.

Parameters

[in]

pEvent

is an identifier of the event created by chsv_event_init.

Returns

The function returns chsv_thrd_success on success and chsv_thrd_error on failure. In the last case the function also sets the corresponding errno code.

The state of an event object remains nonsignalled until it is explicitly set to signalled by the chsv_event_set or chsv_event_pulse function. This nonsignalled state blocks the execution of any threads waiting for the signal using either chsv_event_wait or chsv_event_timedwait or chsv_event_timedwaitfor.

The chsv_event_reset function is used primarily for manual-reset event objects, which must be set explicitly to the nonsignalled state. Auto-reset event objects automatically change from signalled to nonsignalled after a single waiting thread is released.

Resetting an event that is already reset has no effect.

The function does not correspond to any of the C11 functions but partially corresponds to Win32 ResetEvent function.

See also

chsv_event_set;
chsv_event_pulse;
chsv_event_wait;
chsv_event_timedwait;
chsv_event_timedwaitfor.