std::lunique_lock

From Cppreference

C++ Standard Library
Language Utilities library Strings library Containers library Algorithms library Iterators library Numerics library Input/output library Localizations library Regular expressions library (C++11) Atomic operations library (C++11) Thread support library (C++11)
Thread support library
Threads thread (C++11) this_thread namespace get_id (C++11) sleep_for (C++11) sleep_until (C++11) yield (C++11) Mutual exclusion mutex (C++11) recursive_mutex (C++11) timed_mutex (C++11) recursive_timed_mutex (C++11) Generic lock management lock_guard (C++11) unique_lock (C++11) lock (C++11) try_lock (C++11) Condition variables condition_variable (C++11) condition_variable_any (C++11) notify_all_at_thread_exit (C++11) Futures promise (C++11) packaged_task (C++11) future (C++11) shared_future (C++11) async (C++11)
std::unique_lock
Template:cpp/thread/unique lock/sidebar content

Defined in header <mutex>
template<typename Mutex> class unique_lock;		(C++11 feature)

The class unique_lock implements general-purpose mutex ownership wrapper allowing deferred locking, timed locking, recursive locking, transfer of lock ownership, and use with condition variables. The class is non-copyable but movable.

Contents 1 Member types 2 Member functions 3 Helper classes 4 Non-member constants 5 Non-member functions 6 Example

[edit] Member types

Member type	Definition
mutex_type	Mutex

[edit] Member functions

(constructor)	Constructs a unique_lock, optionally locking the supplied mutex (public member function)
(destructor)	Unlocks the supplied mutex, if owned (public member function)
operator=	Unlocks the mutex, if owned, and acquires ownership of another (public member function)
lock	Locks the supplied mutex (public member function)
try_lock	Attempts to lock the supplied mutex (public member function)
try_lock_for	Attempts to lock the supplied TimedLockable mutex for specified std::duration (public member function)
try_lock_until	Attempts to lock the supplied TimedLockable mutex until specified std::time_point (public member function)
unlock	Unlocks the supplied mutex (public member function)
swap	Swaps state with another std::unique_lock (public member function)
mutex	Returns a pointer to the supplied mutex (public member function)
release	Unlocks the mutex and returns a pointer to the mutex object (public member function)
owns_lock	Tests if this unique_lock owns its mutex (public member function)
operator bool()	Tests if this unique_lock owns its mutex (public member function)

[edit] Helper classes

defer_lock_t	tag type used to disambiguate unique_lock constructors (class)
try_to_lock_t	tag type used to disambiguate unique_lock constructors (class)
adopt_lock_t	tag type used to disambiguate unique_lock constructors (class)

[edit] Non-member constants

defer_lock	tag constant used to disambiguate unique_lock constructors (constant)
try_to_lock	tag constant used to disambiguate unique_lock constructors (constant)
adopt_lock	tag constant used to disambiguate unique_lock constructors (constant)

[edit] Non-member functions

std_swap	Specialization of std::swap for unique_locks (function template)

[edit] Example

This section is incomplete