UniqueLock< Mutex, Base > Class Template Reference

Wrapper around std::unique_lock style lock for Mutex. More...

#include <sync.h>

Inheritance diagram for UniqueLock< Mutex, Base >:

Collaboration diagram for UniqueLock< Mutex, Base >:

Public Member Functions
	UniqueLock (Mutex &mutexIn, const char *pszName, const char *pszFile, int nLine, bool fTry=false) EXCLUSIVE_LOCK_FUNCTION(mutexIn)
	UniqueLock (Mutex *pmutexIn, const char *pszName, const char *pszFile, int nLine, bool fTry=false) EXCLUSIVE_LOCK_FUNCTION(pmutexIn)
	~UniqueLock () UNLOCK_FUNCTION()
	operator bool ()

Private Member Functions
void	Enter (const char *pszName, const char *pszFile, int nLine)
bool	TryEnter (const char *pszName, const char *pszFile, int nLine)

Detailed Description

template<typename Mutex, typename Base = typename Mutex::UniqueLock>
class UniqueLock< Mutex, Base >

Wrapper around std::unique_lock style lock for Mutex.

Definition at line 122 of file sync.h.

Constructor & Destructor Documentation

UniqueLock() [1/2]

template<typename Mutex , typename Base = typename Mutex::UniqueLock>

UniqueLock< Mutex, Base >::UniqueLock ( Mutex &  mutexIn, const char *  pszName, const char *  pszFile, int  nLine, bool  fTry = false  )

inline

Definition at line 148 of file sync.h.

UniqueLock() [2/2]

template<typename Mutex , typename Base = typename Mutex::UniqueLock>

UniqueLock< Mutex, Base >::UniqueLock ( Mutex *  pmutexIn, const char *  pszName, const char *  pszFile, int  nLine, bool  fTry = false  )

inline

Definition at line 156 of file sync.h.

~UniqueLock()

template<typename Mutex , typename Base = typename Mutex::UniqueLock>

UniqueLock< Mutex, Base >::~UniqueLock ( )

inline

Definition at line 167 of file sync.h.

Member Function Documentation

Enter()

template<typename Mutex , typename Base = typename Mutex::UniqueLock>

void UniqueLock< Mutex, Base >::Enter ( const char *  pszName, const char *  pszFile, int  nLine  )

inlineprivate

Definition at line 125 of file sync.h.

operator bool()

template<typename Mutex , typename Base = typename Mutex::UniqueLock>

UniqueLock< Mutex, Base >::operator bool ( )

inline

Definition at line 173 of file sync.h.

TryEnter()

template<typename Mutex , typename Base = typename Mutex::UniqueLock>

bool UniqueLock< Mutex, Base >::TryEnter ( const char *  pszName, const char *  pszFile, int  nLine  )

inlineprivate

Definition at line 138 of file sync.h.

---

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

• src/sync.h