A scoped mutex. More...
#include <scopedMutex.h>
Inheritance diagram for co::base::ScopedMutex< L, T >:
Collaboration diagram for co::base::ScopedMutex< L, T >:
Public Member Functions | |
| ScopedMutex (L *lock) | |
| Construct a new scoped mutex and set the given lock. | |
| ScopedMutex (L &lock) | |
| Construct a new scoped mutex and set the given lock. | |
| template<typename LB > | |
| ScopedMutex (LB &lockable) | |
| Construct a new scoped mutex for the given Lockable data structure. | |
| ~ScopedMutex () | |
| Destruct the scoped mutex and unset the mutex. | |
| void | leave () |
| Leave and unlock the mutex immediately. | |
Detailed Description
template<class L = Lock, class T = WriteOp>
class co::base::ScopedMutex< L, T >
A scoped mutex.
The mutex is automatically set upon creation, and released when the scoped mutex is destroyed, e.g., when the scope is left. The scoped mutex does nothing if a 0 pointer for the lock is passed.
Definition at line 55 of file scopedMutex.h.
Constructor & Destructor Documentation
| co::base::ScopedMutex< L, T >::ScopedMutex | ( | L * | lock | ) | [inline, explicit] |
Construct a new scoped mutex and set the given lock.
Providing no Lock (0) is allowed, in which case the scoped mutex does nothing.
- Parameters:
-
lock the mutex to set and unset, or 0.
- Version:
- 1.0
Definition at line 69 of file scopedMutex.h.
| co::base::ScopedMutex< L, T >::ScopedMutex | ( | L & | lock | ) | [inline, explicit] |
Construct a new scoped mutex and set the given lock.
- Version:
- 1.0
Definition at line 73 of file scopedMutex.h.
| co::base::ScopedMutex< L, T >::ScopedMutex | ( | LB & | lockable | ) | [inline] |
Construct a new scoped mutex for the given Lockable data structure.
- Version:
- 1.0
Definition at line 80 of file scopedMutex.h.
| co::base::ScopedMutex< L, T >::~ScopedMutex | ( | ) | [inline] |
Destruct the scoped mutex and unset the mutex.
- Version:
- 1.0
Definition at line 84 of file scopedMutex.h.
References co::base::ScopedMutex< L, T >::leave().
Here is the call graph for this function:
Member Function Documentation
| void co::base::ScopedMutex< L, T >::leave | ( | ) | [inline] |
Leave and unlock the mutex immediately.
- Version:
- 1.0
Definition at line 87 of file scopedMutex.h.
Referenced by co::base::ScopedMutex< L, T >::~ScopedMutex().
Here is the caller graph for this function:
The documentation for this class was generated from the following file:
