mds::sys::CCondition Class Reference

Class encapsulating system Condition. More...

#include <mdsCondition.h>

Inheritance diagram for mds::sys::CCondition:

List of all members.

Public Types
enum	{ CLASS_OBJECT }
	Templates that require members of the CObject class can use this enum to check the existence. More...
enum	{ HEAP_OBJECT = 0x70616568 }
	Signature used to recognize objects on the heap. More...
Public Member Functions
void	broadcast ()
	Wakes all waiting threads.
	CCondition ()
	Constructor creates a new condition.
int	getReferencesCount () const
	Returns the number of references.
bool	isOnHeap () const
	Returns true if the object is allocated on the heap.
	MDS_SHAREDPTR (CCondition)
	Smart pointer type.
void	signal ()
	Signals a single waiting thread.
bool	wait (CMutex &Mutex, unsigned uTimeout=MDS_WAIT_INFINITE)
	Waits on a mutex for a given period of time.
virtual	~CCondition ()
	Standard destructor.
Static Public Member Functions
static void *	operator new (std::size_t Size)
	Allocates a new object on the heap.
Protected Member Functions
void	addReference () const
	Increase the reference counter.
bool	delReference () const
	Decrease the reference counter.
Protected Attributes
int	m_iHeapObject
	Flag initialized if the object is on the heap.
int	m_iReferences
	The number of references to the object.

---

Detailed Description

Class encapsulating system Condition.

---

Member Enumeration Documentation

anonymous enum [inherited]

Templates that require members of the CObject class can use this enum to check the existence.

Enumerator:

CLASS_OBJECT

anonymous enum [inherited]

Signature used to recognize objects on the heap.

Enumerator:

HEAP_OBJECT

---

Constructor & Destructor Documentation

mds::sys::CCondition::CCondition

(

)

Constructor creates a new condition.

virtual mds::sys::CCondition::~CCondition

(

)

[virtual]

Standard destructor.

---

Member Function Documentation

void mds::base::CObject::addReference

(

)

const [protected, inherited]

Increase the reference counter.

void mds::sys::CCondition::broadcast

(

)

Wakes all waiting threads.

• Returns true on success.
• The mutex shall be locked before calling this method!

bool mds::base::CObject::delReference

(

)

const [protected, inherited]

Decrease the reference counter.

• Returns true if the decremented number of references is lower or equal to zero and object must be deleted.

int mds::base::CObject::getReferencesCount

(

)

const [inherited]

Returns the number of references.

bool mds::base::CObject::isOnHeap

(

)

const [inherited]

Returns true if the object is allocated on the heap.

mds::sys::CCondition::MDS_SHAREDPTR

(

CCondition

)

Smart pointer type.

static void* mds::base::CObject::operator new

(

std::size_t

Size

)

[static, inherited]

Allocates a new object on the heap.

void mds::sys::CCondition::signal

(

)

Signals a single waiting thread.

• Returns true on success.
• The mutex shall be locked before calling this method!

bool mds::sys::CCondition::wait	(	CMutex &	Mutex,
		unsigned	uTimeout = MDS_WAIT_INFINITE
	)

Waits on a mutex for a given period of time.

• The calling thread should obtain a mutex before it tests the predicate or calls wait(). The implementation guarantees that wait() causes the thread to atomically release the mutex and block! Then, the mutex is reacquired and must be released!

---

Member Data Documentation

int mds::base::CObject::m_iHeapObject [mutable, protected, inherited]

Flag initialized if the object is on the heap.

int mds::base::CObject::m_iReferences [mutable, protected, inherited]

The number of references to the object.

• Zero if there is no reference.

---

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

• mdsCondition.h