chsvlib
chsv helper source code

◆ chsv_cnd_wait()

int Chusov::ExecutionControl::chsv_cnd_wait ( chsv_cnd_t pCnd,
chsv_mtx_t pMtx 
)
noexcept

Atomically unlocks the specified mutex and endeavours to block until the specified condition variable is signalled by a call to chsv_cnd_signal or to chsv_cnd_broadcast.

Parameters
[in]pCndis a pointer to a descriptor of the condition variable object to be waited for.
[in]pMtxis a pointer to a mutex object to be atomically signalled before the waiting for the condition variable. When the condition variable is signalled so that the calling thread becomes unlocked, the thread atomically endeavours to lock the mutex with blocking. The mutex has to be owned by the calling thread before the call. Otherwise the function will abort execution of the whole program by calling the abort function.
Returns
On success the function returns chsv_thrd_success. On failure the function sets the corresponding errno code and returns chsv_thrd_error.

On POSIX systems (see the IEEE Str 1003.1 standard) the implementation sometimes spurious wakeups of threads, blocked while waiting for the condition variable, may occur. The function does not handle these wakeups and it is up to the caller to verify them.

The function implements a behaviour of the cnd_wait function defined in the ISO/IEC 9899:2011 (aka C11) standard.

See also
chsv_cnd_signal;
chsv_cnd_broadcast;
chsv_cnd_timedwait;
chsv_cnd_timedwaitfor.