icl::utils::Lockable Class Reference

Interface for objects, that can be locked using an internal mutex. More...

#include <Lockable.h>

Inheritance diagram for icl::utils::Lockable:

List of all members.

Public Member Functions
	Lockable (bool recursive=false)
	Default constructor.
	Lockable (const Lockable &l)
	copy constructor (does not copy the source mutex)
Lockable &	operator= (const Lockable &l)
	assignment operator (does not copy the source mutex)
	~Lockable ()
	Destructor.
void	lock () const
	lock object
void	unlock () const
	unlock object
Mutex &	getMutex () const
	returns mutex of this object
Private Attributes
Mutex *	m_mutex
	wrapped mutex variable

---

Detailed Description

Interface for objects, that can be locked using an internal mutex.

---

Constructor & Destructor Documentation

icl::utils::Lockable::Lockable

(

bool

recursive = false

)

[inline]

Default constructor.

icl::utils::Lockable::Lockable

(

const Lockable &

l

)

[inline]

copy constructor (does not copy the source mutex)

icl::utils::Lockable::~Lockable

(

)

[inline]

Destructor.

---

Member Function Documentation

Mutex& icl::utils::Lockable::getMutex

(

)

const [inline]

returns mutex of this object

void icl::utils::Lockable::lock

(

)

const [inline]

lock object

Lockable& icl::utils::Lockable::operator=

(

const Lockable &

l

)

[inline]

assignment operator (does not copy the source mutex)

void icl::utils::Lockable::unlock

(

)

const [inline]

unlock object

---

Member Data Documentation

Mutex* icl::utils::Lockable::m_mutex [private]

wrapped mutex variable

---

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

• /home/jenkins/workspace/icl-manual-trunk/icl-manual/ICLUtils/src/ICLUtils/Lockable.h