std::condition_variable

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::condition_variable
Member functions condition_variable::condition_variable condition_variable::~condition_variable Notification condition_variable::notify_one condition_variable::notify_all Waiting condition_variable::wait condition_variable::wait_for condition_variable::wait_until Native handle condition_variable::native handle

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

The condition_variable class manages a list of threads that are waiting until another thread notifies one or all of the waiting threads that they may proceed, until a timeout expires, or until a spurious wakeup occurs. Any thread that intends to wait on std::condition_variable has to acquire a std::unique_lock first. The wait operation atomically releases the mutex and suspends the execution of the thread. When the thread is awakened, the mutex is reacquired.

The class std::condition_variable is a standard-layout class. It is not copy-constructible, move-constructible, copy-assignable, or move-assignable.

Contents 1 Member types 2 Member functions 2.1 Notification 2.2 Waiting 2.3 Native handle

[edit] Member types

Member type	Definition
native_handle_type	implementation-defined

[edit] Member functions

(constructor)	constructs the object (public member function)
(destructor)	destructs the object (public member function)
operator= [deleted]	not copy-assignable (public member function)
Notification
notify_one	notifies one waiting thread (public member function)
notify_all	notifies all waiting threads (public member function)
Waiting
wait	blocks the current thread until the condition variable is woken up (public member function)
wait_for	blocks the current thread until the condition variable is woken up or after the specified timeout duration (public member function)
wait_until	blocks the current thread until the condition variable is woken up or until specified time point has been reached (public member function)
Native handle
native_handle	returns the native handle (public member function)