---

rwil::Mutex Class Reference

A mutex class. More...

#include <Synchronization.h>

List of all members.

Public Methods
	Mutex ()
	Create a mutex. More...
	~Mutex ()
	Destroy a mutex. More...
void	Wait ()
	Wait on a mutex until it is available. More...
bool	TryWait ()
	Try to wait on a mutex. More...
void	Release ()
	Release the mutex. More...

---

Detailed Description

A mutex class.

This is intended to be a cross-platform class; however, only the linux implementation has been used. Therefore the windows version probably doesn't actually work or compile so it needs to be worked on. This is a recursive mutex.

Definition at line 14 of file Synchronization.h.

---

Constructor & Destructor Documentation

rwil::Mutex::Mutex (    )

Create a mutex. Creates a mutex that is not already held. Definition at line 19 of file Synchronization.cpp. References NULL. { #ifdef _WIN32 m_mutex = CreateMutex(NULL, TRUE, NULL); if(m_mutex = NULL) { throw "Unable to create mutex"; } #endif #ifdef LINUX //m_mutex = PTHREAD_RECURSIVE_MUTEX_INITIALIZER; pthread_mutexattr_t attr; pthread_mutexattr_init(&attr); attr.__mutexkind= PTHREAD_MUTEX_RECURSIVE_NP; // pthread_mutexattr_setkind(&attr, PTHREAD_MUTEX_RECURSIVE); pthread_mutex_init(&m_mutex, &attr); #endif }

rwil::Mutex::~Mutex (    )

Destroy a mutex. Release all resources associated with this mutex. Definition at line 37 of file Synchronization.cpp. { #ifdef _WIN32 CloseHandle(m_mutex); #endif #ifdef LINUX //while(pthread_mutex_destroy(&m_mutex) == EBUSY) // pthread_mutex_unlock(&m_mutex); #endif }

---

Member Function Documentation

void rwil::Mutex::Release (    )

Release the mutex. Unpredictable results occur when the mutex is not held before this call.

bool rwil::Mutex::TryWait (    )

Try to wait on a mutex. This returns immediately. Returns: True if the mutex is acquired, false if not

void rwil::Mutex::Wait (    )

Wait on a mutex until it is available. This is a blocking call. If a different thread has the mutex, then this will wait until that thread releases.

---

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

• Synchronization.h
• Synchronization.cpp

---