mds::sys::CCriticalSection Class Reference

Class that encapsulates system critical section. More...

#include <mdsCriticalSection.h>

Inheritance diagram for mds::sys::CCriticalSection:

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
	CCriticalSection ()
	Default constructor.
void	enter ()
	Enters critical section.
int	getReferencesCount () const
	Returns the number of references.
bool	isOnHeap () const
	Returns true if the object is allocated on the heap.
void	leave ()
	Leaves critical section.
	MDS_SHAREDPTR (CCriticalSection)
	Smart pointer type.
bool	tryEnter ()
	Tries to enter critical section.
virtual	~CCriticalSection ()
	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 that encapsulates system critical section.

• Its functionality is similar to a recursive mutex.

---

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::CCriticalSection::CCriticalSection

(

)

Default constructor.

virtual mds::sys::CCriticalSection::~CCriticalSection

(

)

[virtual]

Destructor.

---

Member Function Documentation

void mds::base::CObject::addReference

(

)

const [protected, inherited]

Increase the reference counter.

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.

void mds::sys::CCriticalSection::enter

(

)

Enters critical section.

• If there is a process in the section, execution is suspended.

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.

void mds::sys::CCriticalSection::leave

(

)

Leaves critical section.

mds::sys::CCriticalSection::MDS_SHAREDPTR

(

CCriticalSection

)

Smart pointer type.

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

(

std::size_t

Size

)

[static, inherited]

Allocates a new object on the heap.

bool mds::sys::CCriticalSection::tryEnter

(

)

Tries to enter critical section.

If it's already locked, returns immediately.

• Returns true when section obtained. False otherwise.

---

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:

• mdsCriticalSection.h