NAME¶

std::recursive_timed_mutex - std::recursive_timed_mutex

Synopsis¶

Defined in header <mutex>
class recursive_timed_mutex; (since C++11)

The recursive_timed_mutex class is a synchronization primitive that can be used to
protect shared data from being simultaneously accessed by multiple threads.

In a manner similar to std::recursive_mutex, recursive_timed_mutex provides
exclusive, recursive ownership semantics. In addition, recursive_timed_mutex
provides the ability to attempt to claim ownership of a recursive_timed_mutex with a
timeout via the try_lock_for and try_lock_until member functions.

The recursive_timed_mutex class satisfies all requirements of TimedMutex and
StandardLayoutType.

Member types¶

Member type Definition
native_handle_type(not always present) implementation-defined

Member functions¶

constructor constructs the mutex
(public member function)
destructor destroys the mutex
(public member function)
operator= not copy-assignable
[deleted] (public member function)

Locking¶

lock locks the mutex, blocks if the mutex is not available
(public member function)
try_lock tries to lock the mutex, returns if the mutex is not available
(public member function)
tries to lock the mutex, returns if the mutex has been
try_lock_for unavailable for the specified timeout duration
(public member function)
tries to lock the mutex, returns if the mutex has been
try_lock_until unavailable until specified time point has been reached
(public member function)
unlock unlocks the mutex
(public member function)

Native handle¶

native_handle returns the underlying implementation-defined native handle object
(public member function)