std::timed_mutex (3) - Linux Manuals

std::timed_mutex: std::timed_mutex

NAME

std::timed_mutex - std::timed_mutex

Synopsis

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

The 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 mutex, timed_mutex offers exclusive, non-recursive ownership semantics. In addition, timed_mutex provides the ability to attempt to claim ownership of a timed_mutex with a timeout via the try_lock_for() and try_lock_until() methods.
The timed_mutex class satisfies all requirements of TimedMutex and StandardLayoutType.

Member types

Member type Definition
native_handle_type(optional) implementation-defined

Member functions

               constructs the mutex
constructor (public member function)
               destroys the mutex
destructor (public member function)

operator= not copy-assignable
               (public member function)
[deleted]

Locking

               locks the mutex, blocks if the mutex is not available
lock (public member function)
               tries to lock the mutex, returns if the mutex is not available
try_lock (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)
               unlocks the mutex
unlock (public member function)

Native handle

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