std::scoped_lock<MutexTypes...>::scoped_lock (3) - Linux Manuals

std::scoped_lock<MutexTypes...>::scoped_lock: std::scoped_lock<MutexTypes...>::scoped_lock

NAME

std::scoped_lock<MutexTypes...>::scoped_lock - std::scoped_lock<MutexTypes...>::scoped_lock

Synopsis


explicit scoped_lock( MutexTypes&... m ); (1) (since C++17)
scoped_lock( std::adopt_lock_t, MutexTypes&... m ); (2) (since C++17)
scoped_lock( const scoped_lock& ) = delete; (3) (since C++17)


Acquires ownership of the given mutexes m.
1) If sizeof...(MutexTypes) == 0, does nothing. Otherwise, If sizeof...(MutexTypes) == 1, effectively calls m.lock(). Otherwise, effectively calls std::lock(m...). The behavior is undefined if one of MutexTypes is not a recursive mutex and the current thread already owns the corresponding argument in m....
2) Acquires ownership of the mutexes m... without attempting to lock any of them. The behavior is undefined unless the current thread owns all of the mutexes in m....
3) Copy constructor is deleted.
The behavior is undefined if m is destroyed before the scoped_lock object is.

Parameters


m - mutexes to acquire ownership of

Exceptions


1) Throws any exceptions thrown by m.lock()
2) Throws nothing


Defect reports


The following behavior-changing defect reports were applied retroactively to previously published C++ standards.


DR Applied to Behavior as published Correct behavior
P0739R0 C++17 adopt_lock_t parameter was last, impeding class template argument deduction moved to first