#include <ArMutex.h>
Public Types | |
enum | Status { STATUS_FAILED_INIT = 1, STATUS_FAILED, STATUS_ALREADY_LOCKED } |
Public Methods | |
ArMutex () | |
Constructor. | |
virtual | ~ArMutex () |
Destructor. | |
virtual int | lock () |
Lock the mutex. More... | |
virtual int | tryLock () |
Try to lock the mutex, but do not block. More... | |
virtual int | unlock () |
Unlock the mutex, allowing another thread to obtain the lock. | |
virtual std::string | getError (int messageNumber) |
Get a human readable error message from an error code. | |
virtual MutexType & | getMutex () |
Get a reference to the underlying mutex variable. |
This class wraps the operating systems mutex functions. It allows mutualy exclusive access to a critical section. This is extremely usefull for multiple threads which want to use the same variable. ArMutex simply uses the POSIX pthread interface in an object oriented manner. It also applies the same concept to Windows using Windows own abilities to restrict access to critical sections.
|
|
|
Lock the mutex. Lock the mutex. This function will block until no other thread has this mutex locked. If it returns 0, then it obtained the lock and the thread is free to use the critical section that this mutex protects. Else it returns an error code. See getError(). |
|
Try to lock the mutex, but do not block. Try to lock the mutex. This function will not block if another thread has the mutex locked. It will return instantly if that is the case. It will return STATUS_ALREADY_LOCKED if another thread has the mutex locked. If it obtains the lock, it will return 0. |