eq::base::Monitor< T > Class Template Reference

A monitor primitive. More...

#include <monitor.h>

Inheritance diagram for eq::base::Monitor< T >:

[legend]

Collaboration diagram for eq::base::Monitor< T >:

[legend]

List of all members.

Public Member Functions
	Monitor ()
	Constructs a new monitor with a default value of 0.
	Monitor (const T &value)
	Constructs a new monitor with a given default value.
	~Monitor ()
	Destructs the monitor.
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.
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 &	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.
Comparison Operators.
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 &	get () const
T	operator+ (const T &value) const

---

Detailed Description

template<typename T>
class eq::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.

Template instantiations are at the end of monitor.cpp.

Definition at line 43 of file monitor.h.

---

Constructor & Destructor Documentation

template<typename T>

eq::base::Monitor< T >::Monitor

(

)

[inline]

Constructs a new monitor with a default value of 0.

Definition at line 47 of file monitor.h.

template<typename T>

eq::base::Monitor< T >::Monitor

(

const T &

value

)

[inline]

Constructs a new monitor with a given default value.

Definition at line 49 of file monitor.h.

template<typename T>

eq::base::Monitor< T >::~Monitor

(

)

Destructs the monitor.

---

Member Function Documentation

template<typename T>

Monitor& eq::base::Monitor< T >::operator=

(

const T &

value

)

[inline]

Assign a new value.

Definition at line 62 of file monitor.h.

template<typename T>

void eq::base::Monitor< T >::set

(

const T &

value

)

Set a new value.

template<typename T>

const T& eq::base::Monitor< T >::waitEQ

(

const T &

value

)

const

Block until the monitor has the given value.

Returns:

the value when reaching the condition.

Referenced by eq::net::Barrier::enter(), and eq::Pipe::waitExited().

Here is the caller graph for this function:

template<typename T>

const T& eq::base::Monitor< T >::waitNE

(

const T &

value

)

const

Block until the monitor has not the given value.

Returns:

the value when reaching the condition.

template<typename T>

const T& eq::base::Monitor< T >::waitGE

(

const T &

value

)

const

Block until the monitor has a value greater or equal to the given value.

Returns:

the value when reaching the condition.

Referenced by eq::Compositor::assembleFramesUnsorted(), eq::Config::finishFrame(), eq::Pipe::waitFrameFinished(), eq::Pipe::waitFrameLocal(), eq::Node::waitFrameStarted(), eq::Node::waitInitialized(), and eq::FrameData::waitReady().

Here is the caller graph for this function:

template<typename T>

const T& eq::base::Monitor< T >::waitLE

(

const T &

value

)

const

Block until the monitor has a value less or equal to the given value.

Returns:

the value when reaching the condition.

template<typename T>

const T& eq::base::Monitor< T >::get

(

)

const [inline]

Returns:

the current value.

Definition at line 127 of file monitor.h.

Referenced by eq::net::Barrier::enter(), eq::server::Window::getState(), eq::server::Pipe::getState(), eq::server::Node::getState(), eq::server::Channel::getState(), eq::Config::getStatistics(), and eq::Pipe::releaseFrameLocal().

Here is the caller graph for this function:

template<typename T>

T eq::base::Monitor< T >::operator+

(

const T &

value

)

const [inline]

Returns:

the current plus given value.

Definition at line 130 of file monitor.h.

---

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

• monitor.h