std::condition_variable_any::wait

template< class Lock > void wait( Lock& lock );	(1)	(自 C++11 起)
template< class Lock, class Predicate > void wait( Lock& lock, Predicate pred );	(2)	(自 C++11 起)
template< class Lock, class Predicate > bool wait( Lock& lock, std::stop_token stoken, Predicate pred );	(3)	(自 C++20 起)

wait 使当前线程阻塞，直到条件变量被通知或出现虚假唤醒。 pred 可选地提供以检测虚假唤醒。

1) 原子地调用 lock.unlock() 并阻塞在 *this 上。

当 notify_all() 或 notify_one() 被执行时，线程将被解除阻塞。它也可能被虚假地解除阻塞。

解除阻塞后，调用 lock.lock()（可能阻塞在锁上），然后返回。

2,3) 等待特定条件变为真，可用于忽略虚假唤醒。

2) 等效于

while (!pred())
wait(lock);

3) 注册 *this 在此调用的持续时间内，以在 stoken 的关联停止状态上发出停止请求时收到通知；然后它等效于

while (!stoken.stop_requested())
{
if (pred())
return true;
wait(lock);
}
return pred();

在 wait 返回后，lock 由调用线程锁定。如果此后置条件无法满足^[1]，则调用 std::terminate。

↑ 如果互斥锁的重新锁定引发异常，则可能发生这种情况。

[编辑] 参数

lock	-	一个锁，必须由调用线程锁定
stoken	-	用于注册中断的停止令牌
pred	-	用于检查等待是否可以完成的谓词
类型要求
- `Lock` 必须满足 BasicLockable 的要求。
- `Predicate` 必须满足 FunctionObject 的要求。
- pred() 必须是一个有效的表达式，其类型和值类别必须满足 BooleanTestable 的要求。

[编辑] 返回值

1,2) (无)

3) pred() 在返回调用者之前的最新结果。

[编辑] 异常

1) 不抛出异常。

2,3) pred 抛出的任何异常。

[编辑] 笔记

重载 (3) 的返回值指示 pred 是否计算为 true，无论是否请求停止。

notify_one()/notify_all() 和 wait()/wait_for()/wait_until() 的三个原子部分（解锁+等待、唤醒和锁定）的效应按单个总体顺序发生，可以视为原子变量的修改顺序：顺序特定于此单独的条件变量。这使得 notify_one() 无法例如延迟并解除在调用 notify_one() 后开始等待的线程的阻塞。

[编辑] 示例

[编辑]

运行此代码

#include <chrono>
#include <condition_variable>
#include <iostream>
#include <thread>
 
std::condition_variable_any cv;
std::mutex cv_m; // This mutex is used for three purposes:
                 // 1) to synchronize accesses to i
                 // 2) to synchronize accesses to std::cerr
                 // 3) for the condition variable cv
int i = 0;
 
void waits()
{
    std::unique_lock<std::mutex> lk(cv_m);
    std::cerr << "Waiting... \n";
    cv.wait(lk, []{ return i == 1; });
    std::cerr << "...finished waiting. i == 1\n";
}
 
void signals()
{
    std::this_thread::sleep_for(std::chrono::seconds(1));
    {
        std::lock_guard<std::mutex> lk(cv_m);
        std::cerr << "Notifying...\n";
    }
    cv.notify_all();
 
    std::this_thread::sleep_for(std::chrono::seconds(1));
 
    {
        std::lock_guard<std::mutex> lk(cv_m);
        i = 1;
        std::cerr << "Notifying again...\n";
    }
    cv.notify_all();
}
 
int main()
{
    std::thread t1(waits), t2(waits), t3(waits), t4(signals);
    t1.join(); 
    t2.join(); 
    t3.join();
    t4.join();
}

可能的输出

Waiting...
Waiting...
Waiting...
Notifying...
Notifying again...
...finished waiting. i == 1
...finished waiting. i == 1
...finished waiting. i == 1

[编辑] 缺陷报告

以下改变行为的缺陷报告被追溯应用到之前发布的 C++ 标准。

DR	应用于	已发布的行为	正确行为
LWG 2114 （P2167R3）	C++11	转换为 bool 的可转换性太弱，无法反映实现的预期	要求增强
LWG 2135	C++11	如果 lock.lock() 抛出异常，行为尚不清楚	在这种情况下调用 std::terminate

[编辑] 另请参见

wait_for	阻塞当前线程，直到条件变量被唤醒或在指定的超时持续时间之后 (公共成员函数) [编辑]
wait_until	阻塞当前线程，直到条件变量被唤醒或达到指定的时点 (公共成员函数) [编辑]
C 文档 for cnd_wait

[编辑] 外部链接

1.	The Old New Thing 文章：Win32 条件变量中的虚假唤醒。

[1] 如果互斥锁的重新锁定引发异常，则可能发生这种情况。

[1]

编译器支持
独立和托管
语言
标准库
标准库头文件
命名要求
特性测试宏 (C++20)
语言支持库
概念库 (C++20)
元编程库 (C++11)
诊断库
通用实用程序库
字符串库
容器库
迭代器库
范围库 (C++20)
算法库
数值库
本地化库
输入/输出库
文件系统库 (C++17)
正则表达式库 (C++11)
并发支持库 (C++11)
执行支持库 (C++26)
技术规范
符号索引
外部库

成员函数
condition_variable_any::condition_variable_any
condition_variable_any::~condition_variable_any
通知
condition_variable_any::notify_one
condition_variable_any::notify_all
等待
condition_variable_any::wait
condition_variable_any::wait_for
condition_variable_any::wait_until

cppreference.com

命名空间

变体

视图

操作