This class is a simple wrapper around C++ standard library type std::recursive_timed_mutex
. Thus, it is used to implement mutual exclusive access to resources by protecting critical code sections from being executed in parallel in concurrent threads.
With release-compilations, the only difference to using std::recursive_timed_mutex
directly is that "spurious wake-ups" are detected and mitigated by this implementation.
code block, then it is recommended to use a stack instantiation of class OwnerRecursive to acquire and release objects of this class. Such a use is highly simplified with macros ALIB_LOCK_RECURSIVE and ALIB_LOCK_RECURSIVE_WITH.
Nested acquisitions are supported with this type. An instance of this class is released when an equal number of invocations to AcquireRecursive and ReleaseRecursive have been performed.
This class has slightly reduced performance in comparison to non-recursive type Lock. Not only for this reason, non-nested locking is the preferred technique. But there are situations where nested locks are just unavoidable.
Definition at line 47 of file recursivetimedlock.inl.
Public Field Index: | |
DbgLockAsserter | Dbg |
The debug tool instance. | |
Public Method Index: | |
~RecursiveTimedLock () override | |
Destructor. With debug-compilations, asserts that this lock is not acquired. | |
ALIB_DLL void | AcquireRecursive (ALIB_DBG_TAKE_CI) |
virtual ALIB_DLL bool | DCSIsAcquired () const override |
virtual ALIB_DLL bool | DCSIsSharedAcquired () const override |
ALIB_DLL void | ReleaseRecursive (ALIB_DBG_TAKE_CI) |
ALIB_DLL bool | TryAcquire (ALIB_DBG_TAKE_CI) |
bool | TryAcquireTimed (const Ticks &pointInTime, const CallerInfo &ci) |
ALIB_DLL bool | TryAcquireTimed (const Ticks::Duration &waitDuration, const CallerInfo &ci) |
bool | TryAcquireTimed (const Ticks::Duration::TDuration &waitDuration, const CallerInfo &ci) |
bool | TryAcquireTimed (const Ticks::TTimePoint &pointInTime, const CallerInfo &ci) |
![]() | |
virtual | ~AssociatedLock () |
Virtual Destructor. | |
Protected Field Index: | |
std::recursive_timed_mutex | mutex |
The internal object to lock on. | |
DbgLockAsserter alib::threads::RecursiveTimedLock::Dbg |
The debug tool instance.
Definition at line 59 of file recursivetimedlock.inl.
|
protected |
The internal object to lock on.
Definition at line 54 of file recursivetimedlock.inl.
|
inlineoverride |
Destructor. With debug-compilations, asserts that this lock is not acquired.
Definition at line 64 of file recursivetimedlock.inl.
void alib::threads::RecursiveTimedLock::AcquireRecursive | ( | ALIB_DBG_TAKE_CI | ) |
Thread which invokes this method gets registered as the current owner of this object, until the same thread releases the ownership invoking ReleaseRecursive. In the case that this object is already owned by another thread, the invoking thread is suspended until ownership can be gained. Multiple (nested) calls to this method are counted and the object is only released when the same number of Release() calls have been made.
Definition at line 306 of file locks.cpp.
|
overridevirtual |
true
if the lock is acquired (in non-shared mode), false
otherwise. Implements alib::lang::DbgCriticalSections::AssociatedLock.
|
overridevirtual |
true
if the lock is shared-acquired (by at least any thread). Otherwise, returns false
. Implements alib::lang::DbgCriticalSections::AssociatedLock.
void alib::threads::RecursiveTimedLock::ReleaseRecursive | ( | ALIB_DBG_TAKE_CI | ) |
Releases ownership of this object. If AcquireRecursive was called multiple times before, the same number of calls to this method has to be performed to release ownership.
|
nodiscard |
Tries to acquire this lock. Successful calls to this method are counted, as if AcquireRecursive was called and an according invocation of ReleaseRecursive has to be performed.
true
if the lock was not acquired by a different thread and thus, this call was successful. false
otherwise.
|
inlinenodiscard |
Same as overloaded sibling, but expects a point in time rather than an Ticks::Duration.
pointInTime | The point in time, when this method stops waiting. |
ci | Caller information. Use macro ALIB_COMMA_CALLER_PRUNED with invocations. |
true
if the lock was acquired, false
if the pointInTime was reached without successful acquisition. Definition at line 146 of file recursivetimedlock.inl.
|
nodiscard |
A thread which invokes this method gets registered as the current owner of this object, until the same thread releases the ownership invoking ReleaseRecursive. In the case that this object is already owned by another thread, the invoking thread is suspended until ownership can be gained.
Successful calls to this method are counted, as if AcquireRecursive was called and an according invocation of ReleaseRecursive has to be performed.
waitDuration | The maximum time-span to wait. |
ci | Caller information. Use macro ALIB_COMMA_CALLER_PRUNED with invocations. |
true
if the lock was acquired, false
if the waitDuration expired without successful acquisition Definition at line 376 of file locks.cpp.
|
inlinenodiscard |
Same as overloaded sibling, but expects a C++ standard library duration type rather than an Ticks::Duration.
waitDuration | The point in time, when this method stops waiting. |
ci | Caller information. Use macro ALIB_COMMA_CALLER_PRUNED with invocations. |
true
if the lock was acquired, false
if the pointInTime was reached without successful acquisition. Definition at line 136 of file recursivetimedlock.inl.
|
inlinenodiscard |
Same as overloaded sibling, but expects a C++ standard library point in time type rather than an Ticks::Duration.
pointInTime | The point in time, when this method stops waiting. |
ci | Caller information. Use macro ALIB_COMMA_CALLER_PRUNED with invocations. |
true
if the lock was acquired, false
if the pointInTime was reached without successful acquisition. Definition at line 158 of file recursivetimedlock.inl.