std::unique_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) yield (C++11) sleep_for (C++11) sleep_until (C++11) Mutual exclusion mutex (C++11) timed_mutex (C++11) recursive_mutex (C++11) recursive_timed_mutex (C++11) Generic lock management lock_guard (C++11) unique_lock (C++11) defer_lock_t try_to_lock_t adopt_lock_t (C++11) (C++11) (C++11) lock (C++11) try_lock (C++11) defer_lock try_to_lock adopt_lock (C++11) (C++11) (C++11) Condition variables condition_variable (C++11) condition_variable_any (C++11) notify_all_at_thread_exit (C++11) cv_status (C++11) Futures promise (C++11) packaged_task (C++11) future (C++11) shared_future (C++11) async (C++11)
std::unique_lock
Member functions unique_lock::unique_lock unique_lock::~unique_lock unique_lock::operator= Locking unique_lock::lock unique_lock::try_lock unique_lock::try_lock_for unique_lock::try_lock_until unique_lock::unlock Modifiers unique_lock::swap unique_lock::release Observers unique_lock::mutex unique_lock::owns_lock unique_lock::operator bool

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

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 2.1 Locking 2.2 Modifiers 2.3 Observers 3 Non-member functions

[edit] Member types

Type	Definition
mutex_type	Mutex

[edit] Member functions

(constructor)	constructs a lock, optionally locking the supplied mutex (public member function)
(destructor)	unlocks the associated mutex, if owned (public member function)
operator=	unlocks the mutex, if owned, and acquires ownership of another (public member function)
Locking
lock	locks the associated mutex (public member function)
try_lock	tries to lock the associated mutex, returns if the mutex is not available (public member function)
try_lock_for	attempts to lock the associated TimedLockable mutex, returns if the mutex has been unavailable for the specified time duration (public member function)
try_lock_until	tries to lock the associated TimedLockable mutex, returns if the mutex has been unavailable until specified time point has been reached (public member function)
unlock	unlocks the associated mutex (public member function)
Modifiers
swap	swaps state with another std::unique_lock (public member function)
release	disassociates the associated mutex without unlocking it (public member function)
Observers
mutex	returns a pointer to the associated mutex (public member function)
owns_lock	tests whether the lock owns its associated mutex (public member function)
operator bool	tests whether the lock owns its associated mutex (public member function)

[edit] Non-member functions

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