std::condition_variable
来自cppreference.com
| 在标头 <condition_variable> 定义
|
||
| class condition_variable; |
(C++11 起) | |
std::condition_variable 是与 std::mutex 一起使用的同步原语，它能用于阻塞一个线程，或同时阻塞多个线程，直至另一线程修改共享变量（条件）并通知 std::condition_variable。
有意修改共享变量的线程必须
- 获得 std::mutex（常通过 std::lock_guard）
- 在保有锁时进行修改
- 在
std::condition_variable上执行 notify_one 或 notify_all（可以释放锁后再通知）
即使共享变量是原子的，也必须在拥有互斥体时修改它，以[1]把修改发布到等待的线程。
任何有意在 std::condition_variable 上等待的线程必须：
- 在用于保护共享变量的互斥体上获得 std::unique_lock<std::mutex>。
- 执行下列之一：
- 检查条件，是否为已更新且已提醒的情况。
- 调用
std::condition_variable的 wait、wait_for 或 wait_until（原子地释放互斥体并暂停线程的执行，直到条件变量被通知，时限过期，或发生虚假唤醒，然后在返回前自动获得互斥体）。 - 检查条件，并在未满足的情况下继续等待。
- 或者
- 使用 wait、wait_for 和 wait_until 的有谓词重载，它们包揽以上三个步骤。
std::condition_variable 只可与 std::unique_lock<std::mutex> 一同使用；此限制在一些平台上允许最大效率。std::condition_variable_any 提供可与任何可基本锁定 (BasicLockable) 对象（例如 std::shared_lock）一同使用的条件变量。
条件变量允许并行调用成员函数 wait、wait_for、wait_until、notify_one 和 notify_all。
类 std::condition_variable 是标准布局类型 (StandardLayoutType) 。它不可复制构造 (CopyConstructible) 、可移动构造 (MoveConstructible) 、可复制赋值 (CopyAssignable) 或可移动赋值 (MoveAssignable) 。
嵌套类型
| 名字 | 定义 |
native_handle_type
|
由实现定义 |
成员函数
| 构造对象 (公开成员函数) | |
| 析构对象 (公开成员函数) | |
| operator= [弃置] |
不可复制赋值 (公开成员函数) |
通知 | |
| 通知一个等待的线程 (公开成员函数) | |
| 通知所有等待的线程 (公开成员函数) | |
等待 | |
| 阻塞当前线程，直到条件变量被唤醒 (公开成员函数) | |
| 阻塞当前线程，直到条件变量被唤醒，或到指定时限时长后 (公开成员函数) | |
| 阻塞当前线程，直到条件变量被唤醒，或直到抵达指定时间点 (公开成员函数) | |
原生句柄 | |
| 返回本机句柄 (公开成员函数) | |
示例
与 std::mutex 组合使用 std::condition_variable，以促进线程间通信。
运行此代码
#include <condition_variable> #include <iostream> #include <mutex> #include <string> #include <thread> std::mutex m; std::condition_variable cv; std::string data; bool ready = false; bool processed = false; void worker_thread() { // 等待直至 main() 发送数据 std::unique_lock lk(m); cv.wait(lk, []{ return ready; }); // 等待后，我们占有锁 std::cout << "工作线程正在处理数据\n"; data += "（处理后）"; // 发送数据回 main() processed = true; std::cout << "工作线程指示数据已经处理完成\n"; // 通知前完成手动解锁，以避免等待线程才被唤醒就阻塞（细节见 notify_one） lk.unlock(); cv.notify_one(); } int main() { std::thread worker(worker_thread); data = "数据样例"; // 发送数据到 worker 线程 { std::lock_guard lk(m); ready = true; std::cout << "main() 指示数据已准备好进行处理\n"; } cv.notify_one(); // 等候 worker { std::unique_lock lk(m); cv.wait(lk, []{ return processed; }); } std::cout << "返回 main()，data = " << data << '\n'; worker.join(); }
输出：
main() 指示数据已准备好进行处理 工作线程正在处理数据 工作线程指示数据已经处理完成 返回 main()，data = 数据样例（处理后）
参阅
| (C++11) |
提供与任何锁类型关联的条件变量 (类) |
| (C++11) |
提供基本互斥设施 (类) |
| (C++11) |
实现严格基于作用域的互斥体所有权包装器 (类模板) |
| (C++11) |
实现可移动的互斥体所有权包装器 (类模板) |