A condition variable and associated lock. More...
#include <condition.h>
Inheritance diagram for lunchbox::Condition:
Collaboration diagram for lunchbox::Condition:
Public Member Functions | |
| Condition () | |
| Construct a new condition variable. | |
| ~Condition () | |
| Destruct this condition variable. | |
| void | lock () |
| Lock the mutex. | |
| void | unlock () |
| Unlock the mutex. | |
| void | signal () |
| Signal the condition. | |
| void | broadcast () |
| Broadcast the condition. | |
| void | wait () |
| Atomically unlock the mutex, wait for a signal and relock the mutex. | |
| bool | timedWait (const uint32_t timeout) |
| Atomically unlock the mutex, wait for a signal and relock the mutex. | |
Detailed Description
A condition variable and associated lock.
Follows closely pthread_condition and mutex
Definition at line 33 of file condition.h.
Constructor & Destructor Documentation
| lunchbox::Condition::Condition | ( | ) |
Construct a new condition variable.
- Version
- 1.0
| lunchbox::Condition::~Condition | ( | ) |
Destruct this condition variable.
- Version
- 1.0
Member Function Documentation
| void lunchbox::Condition::broadcast | ( | ) |
Broadcast the condition.
- Version
- 1.0
Referenced by lunchbox::Monitor< T >::operator&=(), lunchbox::Monitor< T >::operator++(), lunchbox::Monitor< T >::operator--(), lunchbox::Monitor< T >::operator|=(), and lunchbox::Monitor< T >::set().
Here is the caller graph for this function:
| void lunchbox::Condition::lock | ( | ) |
Lock the mutex.
- Version
- 1.0
Referenced by lunchbox::MTQueue< T, S >::operator=().
Here is the caller graph for this function:
| void lunchbox::Condition::signal | ( | ) |
Signal the condition.
- Version
- 1.0
| bool lunchbox::Condition::timedWait | ( | const uint32_t | timeout | ) |
Atomically unlock the mutex, wait for a signal and relock the mutex.
The operation is aborted after the given timeout and false is returned.
- Parameters
-
timeout the timeout in milliseconds to wait for the signal.
- Returns
- true on success, false on timeout.
- Version
- 1.0
Referenced by lunchbox::Monitor< T >::timedWaitEQ(), lunchbox::Monitor< T >::timedWaitGE(), and lunchbox::Monitor< T >::timedWaitNE().
Here is the caller graph for this function:
| void lunchbox::Condition::unlock | ( | ) |
Unlock the mutex.
- Version
- 1.0
Referenced by lunchbox::MTQueue< T, S >::operator=().
Here is the caller graph for this function:
| void lunchbox::Condition::wait | ( | ) |
Atomically unlock the mutex, wait for a signal and relock the mutex.
- Version
- 1.0
Referenced by lunchbox::Monitor< T >::waitEQ(), lunchbox::Monitor< T >::waitGE(), lunchbox::Monitor< T >::waitLE(), and lunchbox::Monitor< T >::waitNE().
Here is the caller graph for this function:
The documentation for this class was generated from the following file:
