SConditionVariable Class Reference
[Utility Classes and Functions]

#include <support/ConditionVariable.h>

List of all members.


Detailed Description

Lightweight condition variable synchronization.


Public Member Functions

void Broadcast ()
 Pulse the condition.
void Close ()
 Close the condition.
void Open ()
 Open the condition.
 SConditionVariable (const char *name)
 SConditionVariable ()
void Wait (SLocker &locker)
 Block until this condition is open, protected by 'locker'.
void Wait ()
 Block until this condition is open.
 ~SConditionVariable ()


Constructor & Destructor Documentation

SConditionVariable  ) 
 

SConditionVariable const char *  name  ) 
 

~SConditionVariable  ) 
 


Member Function Documentation

void Broadcast  ) 
 

Pulse the condition.

Allow all waiting threads to run, be return with the condition closed.

void Close  ) 
 

Close the condition.

Any future threads that call Wait() will block until it opens.

void Open  ) 
 

Open the condition.

All waiting threads will be allowed to run. Any future threads that call Wait() will not block.

void Wait SLocker locker  ) 
 

Block until this condition is open, protected by 'locker'.

The SLocker must be held when this method is called. It will be atomically released if/when the thread blocks, and returns with the lock again held.

void Wait  ) 
 

Block until this condition is open.


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