std::condition_variable::wait_for
来自 cppreference.cn
< cpp | thread | condition variable
| template< class Rep, class Period > std::cv_status wait_for( std::unique_lock<std::mutex>& lock, |
(1) | (自 C++11 起) |
| template< class Rep, class Period, class Predicate > bool wait_for( std::unique_lock<std::mutex>& lock, |
(2) | (自 C++11 起) |
wait_for 导致当前线程阻塞，直到条件变量被通知、给定的持续时间已过去或发生虚假唤醒。pred 可以选择性地提供以检测虚假唤醒。
1) 等价于 return wait_until(lock, std::chrono::steady_clock::now() + rel_time);.
2) 等价于 return wait_until(lock, std::chrono::steady_clock::now() + rel_time, std::move(pred));.
此重载可用于在等待特定条件变为真时忽略虚假唤醒。
在 wait_for 返回后，lock.owns_lock() 为 true，并且 lock.mutex() 由调用线程锁定。如果这些后置条件无法满足[1]，则调用 std::terminate。
如果满足以下任何条件，则行为未定义
- lock.owns_lock() 为 false。
- lock.mutex() 未被调用线程锁定。
- 如果其他一些线程也在等待 *this，则 lock.mutex() 与由在这些线程上调用的等待函数（wait、
wait_for和 wait_until）解锁的互斥量不同。
- ↑ 如果互斥量的重新锁定抛出异常，则可能发生这种情况。
内容 |
[edit] 参数
| lock | - | 一个锁，必须由调用线程锁定 |
| rel_time | - | 最大等待持续时间 |
| pred | - | 用于检查等待是否可以完成的谓词 |
| 类型要求 | ||
-Predicate 必须满足 FunctionObject 的要求。 | ||
| -pred() 必须是有效的表达式，并且其类型和值类别必须满足 BooleanTestable 的要求。 | ||
[edit] 返回值
2) 在返回调用者之前，pred() 的最新结果。
[edit] 异常
1) 与超时相关的异常。
2) 与超时相关的异常，以及 pred 抛出的任何异常。
[edit] 注解
即使在锁下被通知，重载 (1) 也不保证由于超时返回时关联谓词的状态。
notify_one()/notify_all() 的效果以及 wait()/wait_for()/wait_until()（解锁+等待、唤醒和锁定）的三个原子部分中的每一个都发生在单个总顺序中，该顺序可以被视为原子变量的修改顺序：此顺序特定于此单个条件变量。 这使得 notify_one() 不可能例如被延迟并解除阻塞在调用 notify_one() 之后立即开始等待的线程。
[edit] 示例
运行此代码
#include <chrono> #include <condition_variable> #include <iostream> #include <thread> std::condition_variable 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
[edit] 缺陷报告
以下行为变更缺陷报告被追溯应用于先前发布的 C++ 标准。
| DR | 应用于 | 已发布行为 | 正确行为 |
|---|---|---|---|
| LWG 2093 | C++11 | 超时相关的异常在规范中缺失 | 提及了这些异常 |
| LWG 2114 (P2167R3) |
C++11 | 转换为 bool 的可转换性太弱，无法反映实现的期望 | 要求已加强 |
| LWG 2135 | C++11 | 如果 lock.lock() 抛出异常，则行为不明确 | 在这种情况下调用 std::terminate |
[edit] 参见
| 阻塞当前线程，直到条件变量被唤醒 (公共成员函数) | |
| 阻塞当前线程，直到条件变量被唤醒或直到到达指定时间点 (公共成员函数) |
