mds::sys::CExitHandler Class Reference

Class implementing an exit handler functions. More...

#include <mdsExitHandler.h>

Inheritance diagram for mds::sys::CExitHandler:

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
	CExitHandler ()
	Default constructor.
void	exit ()
	Sets the exit event to the signalled state.
int	getReferencesCount () const
	Returns the number of references.
bool	isCanceled ()
	True if the exit event is already signaled.
bool	isOnHeap () const
	Returns true if the object is allocated on the heap.
	MDS_SHAREDPTR (CExitHandler)
	Smart pointer type.
bool	wait (unsigned uTimeout=MDS_WAIT_INFINITE)
	Waits for the exit event.
virtual	~CExitHandler ()
	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 implementing an exit handler functions.

---

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

(

)

Default constructor.

virtual mds::sys::CExitHandler::~CExitHandler

(

)

[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::CExitHandler::exit

(

)

Sets the exit event to the signalled state.

int mds::base::CObject::getReferencesCount

(

)

const [inherited]

Returns the number of references.

bool mds::sys::CExitHandler::isCanceled

(

)

True if the exit event is already signaled.

bool mds::base::CObject::isOnHeap

(

)

const [inherited]

Returns true if the object is allocated on the heap.

mds::sys::CExitHandler::MDS_SHAREDPTR

(

CExitHandler

)

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::CExitHandler::wait

(

unsigned

uTimeout = MDS_WAIT_INFINITE

)

Waits for the exit event.

• If timeout elapses it return false.

---

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

• mdsExitHandler.h
• mdsExitHandler.cpp