A monitor primitive. More...
#include <monitor.h>
Public Member Functions | |
| Monitor () | |
| Construct a new monitor with a default value of 0. | |
| Monitor (const T &value) | |
| Construct a new monitor with a given default value. | |
| Monitor (const Monitor< T > &from) | |
| Ctor initializing with the given monitor value. | |
| ~Monitor () | |
| Destructs the monitor. | |
| template<> | |
| Monitor< bool > & | operator++ () |
| template<> | |
| Monitor< bool > & | operator-- () |
| template<> | |
| Monitor< bool > & | operator|= (const bool &value) |
Changing the monitored value. | |
| Monitor & | operator++ () |
| Increment the monitored value, prefix only. | |
| Monitor & | operator-- () |
| Decrement the monitored value, prefix only. | |
| Monitor & | operator= (const T &value) |
| Assign a new value. | |
| const Monitor & | operator= (const Monitor< T > &from) |
| Assign a new value. | |
| Monitor & | operator|= (const T &value) |
| Perform an or operation on the value. | |
| void | set (const T &value) |
| Set a new value. | |
Monitor the value. | |
| const T & | waitEQ (const T &value) const |
| Block until the monitor has the given value. | |
| const T | waitNE (const T &value) const |
| Block until the monitor has not the given value. | |
| const T | waitNE (const T &v1, const T &v2) const |
| Block until the monitor has none of the given values. | |
| const T | waitGE (const T &value) const |
| Block until the monitor has a value greater or equal to the given value. | |
| const T | waitLE (const T &value) const |
| Block until the monitor has a value less or equal to the given value. | |
Monitor the value with a timeout. | |
| bool | timedWaitEQ (const T &value, const uint32_t timeout) const |
| Block until the monitor has the given value. | |
| bool | timedWaitGE (const T &value, const uint32_t timeout) const |
| Block until the monitor has a value greater or equal to the given value. | |
Comparison Operators. @version 1.0 | |
| bool | operator== (const T &value) const |
| bool | operator!= (const T &value) const |
| bool | operator< (const T &value) const |
| bool | operator> (const T &value) const |
| bool | operator<= (const T &value) const |
| bool | operator>= (const T &value) const |
| bool | operator== (const Monitor< T > &rhs) const |
| bool | operator!= (const Monitor< T > &rhs) const |
| bool | operator< (const Monitor< T > &rhs) const |
| bool | operator> (const Monitor< T > &rhs) const |
| bool | operator<= (const Monitor< T > &rhs) const |
| bool | operator>= (const Monitor< T > &rhs) const |
Data Access. | |
| const T & | operator-> () const |
| const T & | get () const |
| T | operator+ (const T &value) const |
| T | operator| (const T &value) const |
| T | operator& (const T &value) const |
Detailed Description
template<typename T>
class co::base::Monitor< T >
A monitor primitive.
A monitor has a value, which can be monitored to reach a certain state. The caller is blocked until the condition is fulfilled. The concept is similar to a pthread condition, with more usage convenience.
Constructor & Destructor Documentation
template<typename T>
| co::base::Monitor< T >::Monitor | ( | ) | [inline] |
template<typename T>
| co::base::Monitor< T >::Monitor | ( | const T & | value | ) | [inline, explicit] |
template<typename T>
| co::base::Monitor< T >::Monitor | ( | const Monitor< T > & | from | ) | [inline] |
template<typename T>
| co::base::Monitor< T >::~Monitor | ( | ) | [inline] |
Member Function Documentation
template<typename T>
| const T& co::base::Monitor< T >::get | ( | ) | const [inline] |
- Returns:
- the current value.
- Version:
- 1.0
Definition at line 291 of file monitor.h.
Referenced by eq::Config::getFinishedFrame(), eq::FrameData::isReady(), and co::base::operator<<().
Here is the caller graph for this function:
template<typename T>
| T co::base::Monitor< T >::operator& | ( | const T & | value | ) | const [inline] |
template<typename T>
| T co::base::Monitor< T >::operator+ | ( | const T & | value | ) | const [inline] |
template<typename T>
| Monitor& co::base::Monitor< T >::operator++ | ( | void | ) | [inline] |
template<typename T>
| Monitor& co::base::Monitor< T >::operator-- | ( | void | ) | [inline] |
template<typename T>
| const T& co::base::Monitor< T >::operator-> | ( | ) | const [inline] |
template<typename T>
| Monitor& co::base::Monitor< T >::operator= | ( | const T & | value | ) | [inline] |
template<typename T>
| const Monitor& co::base::Monitor< T >::operator= | ( | const Monitor< T > & | from | ) | [inline] |
template<typename T>
| T co::base::Monitor< T >::operator| | ( | const T & | value | ) | const [inline] |
template<typename T>
| Monitor& co::base::Monitor< T >::operator|= | ( | const T & | value | ) | [inline] |
template<typename T>
| void co::base::Monitor< T >::set | ( | const T & | value | ) | [inline] |
template<typename T>
| bool co::base::Monitor< T >::timedWaitEQ | ( | const T & | value, |
| const uint32_t | timeout | ||
| ) | const [inline] |
template<typename T>
| bool co::base::Monitor< T >::timedWaitGE | ( | const T & | value, |
| const uint32_t | timeout | ||
| ) | const [inline] |
template<typename T>
| const T& co::base::Monitor< T >::waitEQ | ( | const T & | value | ) | const [inline] |
template<typename T>
| const T co::base::Monitor< T >::waitGE | ( | const T & | value | ) | const [inline] |
template<typename T>
| const T co::base::Monitor< T >::waitLE | ( | const T & | value | ) | const [inline] |
template<typename T>
| const T co::base::Monitor< T >::waitNE | ( | const T & | value | ) | const [inline] |
template<typename T>
| const T co::base::Monitor< T >::waitNE | ( | const T & | v1, |
| const T & | v2 | ||
| ) | const [inline] |
The documentation for this class was generated from the following file:
