SDK Condition Variable API documentation

Version: stable

<dmsdk/dlib/condition_variable.h>

API for platform independent mutex synchronization primitive.

FUNCTION
dmConditionVariable::Broadcast()

broadcast condition variable

dmConditionVariable::Delete()

delete condition variable

dmConditionVariable::New()

create condition variable

dmConditionVariable::Signal()

signal condition variable

dmConditionVariable::Wait()

wait for condition variable

Functions

dmConditionVariable::Broadcast()

dmConditionVariable::Broadcast(condition)

Broadcast condition variable, effectively unblocks all of the waithing threads blocked by the condition variable.

PARAMETERS

condition

dmConditionVariable::HConditionVariable ConditionVariable handle.


dmConditionVariable::Delete()

dmConditionVariable::Delete(mutex)

Deletes a HConditionVariable.

PARAMETERS

mutex

dmConditionVariable::HConditionVariable ConditionVariable handle to delete.


dmConditionVariable::New()

dmConditionVariable::New()

Create a new HConditionVariable

PARAMETERS

RETURNS

condition_variable

dmConditionVariable::HConditionVariable A new ConditionVariable handle.


dmConditionVariable::Signal()

dmConditionVariable::Signal(condition)

Signal condition variable, effectively unblocks at least one of the waithing threads blocked by the condition variable.

PARAMETERS

condition

dmConditionVariable::HConditionVariable ConditionVariable handle.


dmConditionVariable::Wait()

dmConditionVariable::Wait(condition,mutex)

Wait for condition variable. This is a blocking function, and should be called with the mutex being locked.

PARAMETERS

condition

dmConditionVariable::HConditionVariable ConditionVariable handle.

mutex

dmMutex::HMutex Mutex handle.