#include <mutex.h>
Inheritance diagram for shaka::DebugMutex< _Mutex >:
Public Member Functions | |
| DebugMutex (const std::string &name) | |
| ~DebugMutex () override | |
| std::thread::id | GetProvider () const override |
| void | lock () |
| bool | try_lock () |
| void | unlock () |
| void | lock_shared () |
| bool | try_lock_shared () |
| void | unlock_shared () |
 Public Member Functions inherited from shaka::Waitable | |
| Waitable (const std::string &name) | |
| virtual | ~Waitable () |
| std::string | name () const |
Detailed Description
template<typename _Mutex>
class shaka::DebugMutex< _Mutex >
A wrapper around a mutex. This exists to provide debug information and to track deadlocks.
This implements the Mutex (and Lockable) concept so it can be used in std::unique_lock<T>. It can also be used in std::condition_variable_any, but it is suggested to use a ThreadEvent instead (to track deadlocks).
If _Mutex implements the SharedMutex concept, so does this.
Constructor & Destructor Documentation
§ DebugMutex()
template<typename _Mutex >
|
inlineexplicit |
§ ~DebugMutex()
template<typename _Mutex >
|
inlineoverride |
Member Function Documentation
§ GetProvider()
template<typename _Mutex >
|
inlineoverridevirtual |
- Returns
- The thread that will be providing the thing. This can return id() if it is unknown.
Implements shaka::Waitable.
§ lock()
template<typename _Mutex >
|
inline |
§ lock_shared()
template<typename _Mutex >
|
inline |
§ try_lock()
template<typename _Mutex >
|
inline |
§ try_lock_shared()
template<typename _Mutex >
|
inline |
§ unlock()
template<typename _Mutex >
|
inline |
§ unlock_shared()
template<typename _Mutex >
|
inline |
The documentation for this class was generated from the following file:
- shaka/src/debug/mutex.h
