Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | List of all members
ola::thread::ConditionVariable Class Reference

Detailed Description

A condition variable

Public Member Functions

 ConditionVariable ()
 
 ~ConditionVariable ()
 
void Wait (Mutex *mutex)
 
bool TimedWait (Mutex *mutex, const ola::TimeStamp &wake_up_time)
 
void Signal ()
 
void Broadcast ()
 

Constructor & Destructor Documentation

ola::thread::ConditionVariable::ConditionVariable ( )
ola::thread::ConditionVariable::~ConditionVariable ( )

Clean up

Member Function Documentation

void ola::thread::ConditionVariable::Broadcast ( )

Wake up all listeners

void ola::thread::ConditionVariable::Signal ( )

Wake up a single listener

bool ola::thread::ConditionVariable::TimedWait ( Mutex mutex,
const ola::TimeStamp wake_up_time 
)

Timed Wait

Parameters
mutexthe mutex that is locked
wake_up_timethe time to wait up.
Returns
true if we received a signal, false if the timeout expired.
void ola::thread::ConditionVariable::Wait ( Mutex mutex)

Wait on a condition variable

Parameters
mutexthe mutex that is locked

The documentation for this class was generated from the following files: