For the latest documentation on Visual Studio 2017 RC, see Visual Studio 2017 RC Documentation.
This header uses Concurrency Runtime (ConcRT) so that you can use it together with other ConcRT mechanisms. For more information about ConcRT, see Concurrency Runtime.
In code that is compiled by using /clr or /clr:pure, this header is blocked.
Code that waits for a condition variable must also use a
mutex. A calling thread must lock the
mutex before it calls the functions that wait for the condition variable. The
mutex is then locked when the called function returns. The
mutex is not locked while the thread waits for the condition to become true. So that there are no unpredictable results, each thread that waits for a condition variable must use the same
Objects of type
condition_variable_any can be used with a mutex of any type. The type of the mutex that is used does not have to provide the
try_lock method. Objects of type
condition_variable can only be used with a mutex of type
unique_lock<mutex>. Objects of this type may be faster than objects of type
To wait for an event, first lock the mutex, and then call one of the
wait methods on the condition variable. The
wait call blocks until another thread signals the condition variable.
Spurious wakeups occur when threads that are waiting for condition variables become unblocked without appropriate notifications. To recognize such spurious wakeups, code that waits for a condition to become true should explicitly check that condition when the code returns from a wait function. This is usually done by using a loop; you can use
wait(unique_lock<mutex>& lock, Predicate pred) to perform this loop for you.
condition_variable classes each have three methods that wait for a condition.
waitwaits for an unbounded time period.
wait_untilwaits until a specified
wait_forwaits for a specified
Each of these methods has two overloaded versions. One just waits and can wake up spuriously. The other takes an additional template argument that defines a predicate. The method does not return until the predicate is
Each class also has two methods that are used to notify a condition variable that its condition is
notify_onewakes up one of the threads that is waiting for the condition variable.
notify_allwakes up all of the threads that are waiting for the condition variable.