xrpl::ScopeUnlock< Mutex > Class Template Reference
Automatically unlocks and re-locks a unique_lock object. More...
#include <scope.h>
Collaboration diagram for xrpl::ScopeUnlock< Mutex >:
Public Member Functions | |
| ScopeUnlock (std::unique_lock< Mutex > &lock) noexcept(true) | |
| ScopeUnlock (ScopeUnlock const &)=delete | |
| ScopeUnlock & | operator= (ScopeUnlock const &)=delete |
| ~ScopeUnlock () noexcept(true) | |
Private Attributes | |
| std::unique_lock< Mutex > * | plock_ |
Detailed Description
template<class Mutex>
class xrpl::ScopeUnlock< Mutex >
class xrpl::ScopeUnlock< Mutex >
Automatically unlocks and re-locks a unique_lock object.
This is the reverse of a std::unique_lock object - instead of locking the mutex for the lifetime of this object, it unlocks it.
Make sure you don't try to unlock mutexes that aren't actually locked!
This is essentially a less-versatile boost::reverse_lock.
e.g.
std::mutex mut;
for (;;)
{
std::unique_lock myScopedLock{mut};
// mut is now locked
... do some stuff with it locked ..
while (xyz)
{
... do some stuff with it locked ..
scope_unlock unlocker{myScopedLock};
// mut is now unlocked for the remainder of this block,
// and re-locked at the end.
...do some stuff with it unlocked ...
} // mut gets locked here.
} // mut gets unlocked here
Constructor & Destructor Documentation
◆ ScopeUnlock() [1/2]
template<class Mutex>
|
explicitnoexcept |
◆ ScopeUnlock() [2/2]
template<class Mutex>
|
delete |
◆ ~ScopeUnlock()
template<class Mutex>
|
noexcept |
Member Function Documentation
◆ operator=()
template<class Mutex>
|
delete |
Member Data Documentation
◆ plock_
template<class Mutex>
|
private |
Generated by
1.16.1