Description:

This class is a simple wrapper around C++ standard library type std::recursive_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.

When a pair of AcquireRecursive and ReleaseRecursive invocations is performed within the same 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 greatly 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.

Debug-Features

Public member Dbg is available with debug-compilations. It offers the following features:

The object stores the actual owning thread and the source code position of the last acquirement.
Releasing non-acquired instances, as well as destructing acquired one, raise an assertion.
A warning threshold for the number of nested acquisitions can be defined with public member int RecursionLimit.
Field WaitTimeLimit enables the raise of ALib warnings in case a certain wait time is exceeded. Note that instead of wrapping std::recursive_mutex, with debug-compilations class std::recursive_timed_mutex is wrapped.

Availability: This type is not available if the configuration macro ALIB_SINGLE_THREADED is set.

See also

Chapter 3. Locks of the Programmer's Manual of the module ALib Threads.
Chapter A.5 Collecting Caller Information of the General Programmer's Manual.

Definition at line 48 of file recursivelock.inl.

Inheritance diagram for alib::threads::RecursiveLock:

Public Field Index:
DbgLockAsserter	Dbg
	The debug tool instance.

Public Method Index:
void	AcquireRecursive (ALIB_DBG_TAKE_CI)
virtual bool	DCSIsAcquired () const override
virtual bool	DCSIsSharedAcquired () const override
void	ReleaseRecursive (ALIB_DBG_TAKE_CI)
bool	TryAcquire (ALIB_DBG_TAKE_CI)
Public Method Index: inherited from alib::lang::DbgCriticalSections::AssociatedLock
virtual	~AssociatedLock ()
	Virtual Destructor.

Protected Field Index:
std::recursive_mutex	mutex

Field Details:

◆ Dbg

DbgLockAsserter alib::threads::RecursiveLock::Dbg

The debug tool instance.

Definition at line 68 of file recursivelock.inl.

◆ mutex

std::recursive_mutex alib::threads::RecursiveLock::mutex

protected

The internal object to lock on.

Note: With debug-compilations, this is of type std::recursive_timed_mutex.

Definition at line 61 of file recursivelock.inl.

Method Details:

◆ AcquireRecursive()

void alib::threads::RecursiveLock::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.

Debug Parameter:: Pass macro ALIB_CALLER_PRUNED with invocations.

Definition at line 182 of file locks.cpp.

◆ DCSIsAcquired()

bool alib::threads::RecursiveLock::DCSIsAcquired ( ) const

overridevirtual

Returns: true if the lock is acquired (in non-shared mode), false otherwise.

Implements alib::lang::DbgCriticalSections::AssociatedLock.

Definition at line 554 of file locks.cpp.

◆ DCSIsSharedAcquired()

bool alib::threads::RecursiveLock::DCSIsSharedAcquired ( ) const

overridevirtual

Returns: true if the lock is shared-acquired (by at least any thread). Otherwise, returns false.

Implements alib::lang::DbgCriticalSections::AssociatedLock.

Definition at line 555 of file locks.cpp.

◆ ReleaseRecursive()

void alib::threads::RecursiveLock::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.

Debug Parameter:: Pass macro ALIB_CALLER_PRUNED with invocations.

Definition at line 215 of file locks.cpp.

◆ TryAcquire()

bool alib::threads::RecursiveLock::TryAcquire ( ALIB_DBG_TAKE_CI )

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.

Debug Parameter:: Pass macro ALIB_CALLER_PRUNED with invocations.

Returns: true if the lock was not acquired by a different thread and thus, this call was successful. false otherwise.

Definition at line 208 of file locks.cpp.

The documentation for this class was generated from the following files: