Mutex Class Reference
A mutual-exclusion lock. More...
#include <Mutex.h++>
Public Member Functions | |
| Mutex (bool recursive=false) throw () | |
| Construct a new Mutex. | |
| ~Mutex () throw () | |
| Destructor. | |
| void | lock () throw () |
| Lock the mutex, blocking until the lock is acquired. | |
| bool | tryLock (timespan_ms_t timeout=0) throw () |
| Try to lock the mutex, returning if it could not be acquired within the given amount of time. | |
| void | unlock () throw () |
| Unlock the mutex. | |
| bool | isRecursive () const throw () |
| Determine if this mutex is recursive. | |
Static Public Member Functions | |
| static bool | supportsTimedLocks () throw () |
| Determine if the host system supports timed mutex locks. | |
Friends | |
| class | CondVar |
Detailed Description
A mutual-exclusion lock.
Only one thread may have a Mutex locked at any one time.
A Mutex may be created as recursive; such a Mutex can be re-locked by a thread that already holds the lock on that Mutex. However, the thread must unlock the Mutex the same number of times that it has locked it in order for it to become available for locking by other threads.
See also ScopedLock.
Constructor & Destructor Documentation
| Mutex | ( | bool | recursive = false |
) | throw () |
Construct a new Mutex.
- Parameters:
-
recursive A flag indicating whether the mutex will be recursive. A recursive mutex can be re-entered by a thread that already holds the mutex.
| ~Mutex | ( | ) | throw () |
Destructor.
Note that destroying a locked mutex could lead to deadlock.
Member Function Documentation
| bool isRecursive | ( | ) | const throw () [inline] |
Determine if this mutex is recursive.
| void lock | ( | ) | throw () [virtual] |
Lock the mutex, blocking until the lock is acquired.
Implements Lock.
| bool supportsTimedLocks | ( | ) | throw () [static] |
Determine if the host system supports timed mutex locks.
| bool tryLock | ( | timespan_ms_t | timeout = 0 |
) | throw () |
Try to lock the mutex, returning if it could not be acquired within the given amount of time.
On platforms that do not support timed mutex locks, the method returns immediately if the lock could not be acquired. On some platforms (notably Linux), recursive mutexes do not support timed locks; on these platforms, tryLock() behaves identically to lock() when applied to a recursive mutex.
- Parameters:
-
timeout The timeout, in milliseconds.
- Returns:
- true if the lock was acquired, false otherwise.
| void unlock | ( | ) | throw () [virtual] |
Unlock the mutex.
Implements Lock.
Friends And Related Function Documentation
friend class CondVar [friend] |
The documentation for this class was generated from the following files:
