G3D::GMutex Class Reference

Mutual exclusion lock used for synchronization. More...

#include <GMutex.h>

Public Member Functions
	GMutex ()
	~GMutex ()
void	lock ()
bool	tryLock ()
void	unlock ()

Private Member Functions
	GMutex (const GMutex &mlock)
GMutex &	operator= (const GMutex &)
bool	operator== (const GMutex &)

Private Attributes
pthread_mutex_t	m_handle
pthread_mutexattr_t	m_attr

Detailed Description

Mutual exclusion lock used for synchronization.

See also

G3D::GThread, G3D::AtomicInt32, G3D::Spinlock

Constructor & Destructor Documentation

G3D::GMutex::GMutex ( const GMutex &  mlock )

private

G3D::GMutex::GMutex

(

)

 {
#ifdef G3D_WINDOWS
 ::InitializeCriticalSection(&m_handle);
#else
 int ret = pthread_mutexattr_init(&m_attr);
 debugAssert(ret == 0);
 ret = pthread_mutexattr_settype(&m_attr, PTHREAD_MUTEX_RECURSIVE);
 debugAssert(ret == 0);
 ret = pthread_mutex_init(&m_handle, &m_attr);
 debugAssert(ret == 0);
#endif
}

G3D::GMutex::~GMutex

(

)

 {
 //TODO: Debug check for locked
#ifdef G3D_WINDOWS
 ::DeleteCriticalSection(&m_handle);
#else
 int ret = pthread_mutex_destroy(&m_handle);
 debugAssert(ret == 0);
 ret = pthread_mutexattr_destroy(&m_attr);
 debugAssert(ret == 0);
#endif
}

Member Function Documentation

void G3D::GMutex::lock

(

)

Locks the mutex or blocks until available.

 {
#ifdef G3D_WINDOWS
 ::EnterCriticalSection(&m_handle);
#else
 pthread_mutex_lock(&m_handle);
#endif
}

Here is the caller graph for this function:

GMutex& G3D::GMutex::operator= ( const GMutex &  )

private

bool G3D::GMutex::operator== ( const GMutex &  )

private

bool G3D::GMutex::tryLock

(

)

Locks the mutex if it not already locked. Returns true if lock successful, false otherwise.

 {
#ifdef G3D_WINDOWS
 return (::TryEnterCriticalSection(&m_handle) != 0);
#else
 return (pthread_mutex_trylock(&m_handle) == 0);
#endif
}

void G3D::GMutex::unlock

(

)

Unlocks the mutex.

 {
#ifdef G3D_WINDOWS
 ::LeaveCriticalSection(&m_handle);
#else
 pthread_mutex_unlock(&m_handle);
#endif
}

Here is the caller graph for this function:

Member Data Documentation

pthread_mutexattr_t G3D::GMutex::m_attr

private

pthread_mutex_t G3D::GMutex::m_handle

private

---

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

• dep/g3dlite/include/G3D/GMutex.h
• dep/g3dlite/source/GThread.cpp