TC::MT::ObjectLevelLockable< CLASS_TO_LOCK > Class Template Reference
[Multithreading]

This template offers the basic mechanism for an object level locking mechanism. More...

#include <TCMTLockable.h>

Inheritance diagram for TC::MT::ObjectLevelLockable< CLASS_TO_LOCK >:

[legend]

Collaboration diagram for TC::MT::ObjectLevelLockable< CLASS_TO_LOCK >:

[legend]

List of all members.

Public Types
typedef LockerPtr< const CLASS_TO_LOCK * >	Locker
	Provides a typedef for locking this object.
Public Member Functions
	ObjectLevelLockable ()
	~ObjectLevelLockable ()
bool	Lock () const
	Lock the object.
bool	UnLock () const
	Unlock the object.
Private Attributes
MutexPtr	m_mutex

---

Detailed Description

template<class CLASS_TO_LOCK>
class TC::MT::ObjectLevelLockable< CLASS_TO_LOCK >

This template offers the basic mechanism for an object level locking mechanism.

Definition at line 61 of file TCMTLockable.h.

---

Member Typedef Documentation

template<class CLASS_TO_LOCK >

typedef LockerPtr< const CLASS_TO_LOCK* > TC::MT::ObjectLevelLockable< CLASS_TO_LOCK >::Locker

Provides a typedef for locking this object.

Definition at line 86 of file TCMTLockable.h.

---

Constructor & Destructor Documentation

template<class CLASS_TO_LOCK >

TC::MT::ObjectLevelLockable< CLASS_TO_LOCK >::ObjectLevelLockable

(

)

[inline]

Definition at line 64 of file TCMTLockable.h.

References TC::MT::Factory::CreateMutex(), and TC::MT::ObjectLevelLockable< CLASS_TO_LOCK >::m_mutex.

Here is the call graph for this function:

template<class CLASS_TO_LOCK >

TC::MT::ObjectLevelLockable< CLASS_TO_LOCK >::~ObjectLevelLockable

(

)

[inline]

Definition at line 68 of file TCMTLockable.h.

References TC::MT::ObjectLevelLockable< CLASS_TO_LOCK >::m_mutex.

---

Member Function Documentation

template<class CLASS_TO_LOCK >

bool TC::MT::ObjectLevelLockable< CLASS_TO_LOCK >::Lock

(

)

const [inline]

Lock the object.

Definition at line 74 of file TCMTLockable.h.

References TC::MT::ObjectLevelLockable< CLASS_TO_LOCK >::m_mutex.

template<class CLASS_TO_LOCK >

bool TC::MT::ObjectLevelLockable< CLASS_TO_LOCK >::UnLock

(

)

const [inline]

Unlock the object.

Definition at line 80 of file TCMTLockable.h.

References TC::MT::ObjectLevelLockable< CLASS_TO_LOCK >::m_mutex.

---

Member Data Documentation

template<class CLASS_TO_LOCK >

MutexPtr TC::MT::ObjectLevelLockable< CLASS_TO_LOCK >::m_mutex [mutable, private]

Definition at line 89 of file TCMTLockable.h.

Referenced by TC::MT::ObjectLevelLockable< CLASS_TO_LOCK >::Lock(), TC::MT::ObjectLevelLockable< CLASS_TO_LOCK >::ObjectLevelLockable(), TC::MT::ObjectLevelLockable< CLASS_TO_LOCK >::UnLock(), and TC::MT::ObjectLevelLockable< CLASS_TO_LOCK >::~ObjectLevelLockable().

---

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

• TCMTLockable.h