CLAM::Hidden::ScopedLock< MutexType > Class Template Reference

#include <Lock.hxx>

List of all members.

Public Types

typedef MutexType mutex_type

Public Member Functions

 ScopedLock (MutexType &mx, bool initially_locked=true)
 ~ScopedLock ()
void Lock ()
void Unlock ()
bool Locked () const
 operator const void * () const

Friends

class CLAM::Condition

Detailed Description

template<typename MutexType>
class CLAM::Hidden::ScopedLock< MutexType >

Definition at line 73 of file Lock.hxx.


Member Typedef Documentation

template<typename MutexType >
typedef MutexType CLAM::Hidden::ScopedLock< MutexType >::mutex_type

Definition at line 76 of file Lock.hxx.


Constructor & Destructor Documentation

template<typename MutexType >
CLAM::Hidden::ScopedLock< MutexType >::ScopedLock ( MutexType &  mx,
bool  initially_locked = true 
) [inline, explicit]

Definition at line 78 of file Lock.hxx.

References CLAM::Hidden::ScopedLock< MutexType >::Lock().

template<typename MutexType >
CLAM::Hidden::ScopedLock< MutexType >::~ScopedLock (  )  [inline]

Definition at line 84 of file Lock.hxx.

References CLAM::Hidden::ScopedLock< MutexType >::Unlock().


Member Function Documentation

template<typename MutexType >
void CLAM::Hidden::ScopedLock< MutexType >::Lock (  )  [inline]

Definition at line 90 of file Lock.hxx.

Referenced by CLAM::Hidden::ScopedLock< MutexType >::ScopedLock().

template<typename MutexType >
bool CLAM::Hidden::ScopedLock< MutexType >::Locked (  )  const [inline]

Definition at line 109 of file Lock.hxx.

template<typename MutexType >
CLAM::Hidden::ScopedLock< MutexType >::operator const void * (  )  const [inline]

Definition at line 114 of file Lock.hxx.

template<typename MutexType >
void CLAM::Hidden::ScopedLock< MutexType >::Unlock (  )  [inline]

Definition at line 99 of file Lock.hxx.

Referenced by CLAM::Hidden::ScopedLock< MutexType >::~ScopedLock().


Friends And Related Function Documentation

template<typename MutexType >
friend class CLAM::Condition [friend]

Definition at line 120 of file Lock.hxx.


The documentation for this class was generated from the following file:
Generated by  doxygen 1.6.3