libstdc++
Collaboration diagram for Mutexes:

Classes

struct  std::adopt_lock_t
 
struct  std::defer_lock_t
 
class  std::lock_guard< _Mutex >
 
class  std::mutex
 
struct  std::once_flag
 
class  std::recursive_mutex
 
class  std::recursive_timed_mutex
 
class  std::shared_lock< _Mutex >
 
class  std::shared_timed_mutex
 
class  std::timed_mutex
 
struct  std::try_to_lock_t
 
class  std::unique_lock< _Mutex >
 

Macros

#define __cpp_lib_shared_timed_mutex
 

Functions

template<typename _Callable , typename... _Args>
void std::call_once (once_flag &__once, _Callable &&__f, _Args &&...__args)
 
template<typename _L1 , typename _L2 , typename... _L3>
void std::lock (_L1 &__l1, _L2 &__l2, _L3 &...__l3)
 
template<typename _Lock1 , typename _Lock2 , typename... _Lock3>
int std::try_lock (_Lock1 &__l1, _Lock2 &__l2, _Lock3 &...__l3)
 

Variables

constexpr adopt_lock_t std::adopt_lock
 
constexpr defer_lock_t std::defer_lock
 
constexpr try_to_lock_t std::try_to_lock
 

Detailed Description

Classes for mutex support.

Function Documentation

template<typename _Callable , typename... _Args>
void std::call_once ( once_flag &  __once,
_Callable &&  __f,
_Args &&...  __args 
)

Invoke a callable and synchronize with other calls using the same flag.

Definition at line 712 of file mutex.

References std::__addressof().

template<typename _L1 , typename _L2 , typename... _L3>
void std::lock ( _L1 &  __l1,
_L2 &  __l2,
_L3 &...  __l3 
)

Generic lock.

Parameters
__l1Meets Lockable requirements (try_lock() may throw).
__l2Meets Lockable requirements (try_lock() may throw).
__l3Meets Lockable requirements (try_lock() may throw).
Exceptions
Anexception thrown by an argument's lock() or try_lock() member.
Postcondition
All arguments are locked.

All arguments are locked via a sequence of calls to lock(), try_lock() and unlock(). If the call exits via an exception any locks that were obtained will be released.

Definition at line 589 of file mutex.

References std::tie().

template<typename _Lock1 , typename _Lock2 , typename... _Lock3>
int std::try_lock ( _Lock1 &  __l1,
_Lock2 &  __l2,
_Lock3 &...  __l3 
)

Generic try_lock.

Parameters
__l1Meets Lockable requirements (try_lock() may throw).
__l2Meets Lockable requirements (try_lock() may throw).
__l3Meets Lockable requirements (try_lock() may throw).
Returns
Returns -1 if all try_lock() calls return true. Otherwise returns a 0-based index corresponding to the argument that returned false.
Postcondition
Either all arguments are locked, or none will be.

Sequentially calls try_lock() on each argument.

Definition at line 568 of file mutex.

References std::tie().

Variable Documentation

constexpr adopt_lock_t std::adopt_lock
inline

Tag used to make a scoped lock take ownership of a locked mutex.

Definition at line 145 of file std_mutex.h.

constexpr defer_lock_t std::defer_lock
inline

Tag used to prevent a scoped lock from acquiring ownership of a mutex.

Definition at line 139 of file std_mutex.h.

constexpr try_to_lock_t std::try_to_lock
inline

Tag used to prevent a scoped lock from blocking if a mutex is locked.

Definition at line 142 of file std_mutex.h.