eq::base::ScopedMutex Class Reference
A scoped mutex. More...
#include <scopedMutex.h>
Inheritance diagram for eq::base::ScopedMutex:
Collaboration diagram for eq::base::ScopedMutex:
Public Member Functions | |
| ScopedMutex (Lock *lock) | |
| Constructs a new scoped mutex using the given lock. | |
| ScopedMutex (Lock &lock) | |
| Constructs a new scoped mutex using the given lock. | |
| ~ScopedMutex () | |
| Destructs the scoped mutex and unsets the mutex. | |
Detailed Description
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 35 of file scopedMutex.h.
Constructor & Destructor Documentation
| eq::base::ScopedMutex::ScopedMutex | ( | Lock * | lock | ) | [inline, explicit] |
Constructs a new scoped mutex using the given lock.
- Parameters:
-
lock the mutex to set and unset, or 0.
Definition at line 43 of file scopedMutex.h.
References eq::base::Lock::set().
Here is the call graph for this function:
| eq::base::ScopedMutex::ScopedMutex | ( | Lock & | lock | ) | [inline, explicit] |
Constructs a new scoped mutex using the given lock.
Definition at line 47 of file scopedMutex.h.
References eq::base::Lock::set().
Here is the call graph for this function:
| eq::base::ScopedMutex::~ScopedMutex | ( | ) | [inline] |
Destructs the scoped mutex and unsets the mutex.
Definition at line 51 of file scopedMutex.h.
References eq::base::Lock::unset().
Here is the call graph for this function:
The documentation for this class was generated from the following file:
