std::condition_variable_any::wait_for
来自 cppreference.com
< cpp | thread | condition variable any
| template< class Lock, class Rep, class Period > std::cv_status wait_for( Lock& lock, |
(1) | (自 C++11 起) |
| template< class Lock, class Rep, class Period, class Predicate > bool wait_for( Lock& lock, const std::chrono::duration<Rep, Period>& rel_time, |
(2) | (自 C++11 起) |
| template< class Lock, class Rep, class Period, class Predicate > bool wait_for( Lock& lock, std::stop_token stoken, |
(3) | (自 C++20 起) |
wait_for 会导致当前线程阻塞，直到条件变量被通知，给定的持续时间已过去，或出现虚假唤醒。 pred 可以选择性地提供，以检测虚假唤醒。
1) 等效于 return wait_until(lock, std::chrono::steady_clock::now() + rel_time);.
2,3) 等待特定条件变为真，可用于忽略虚假唤醒。
2) 等效于 return wait_until(lock, std::chrono::steady_clock::now() + rel_time, std::move(pred));.
3) 在此调用期间注册 *this，以便在 stoken 的关联停止状态上发出停止请求时通知；然后它等效于 return wait_until(lock, std::move(stoken),
std::chrono::steady_clock::now() + rel_time, std::move(pred));.
std::chrono::steady_clock::now() + rel_time, std::move(pred));.
在 wait_for 返回后，lock 会被调用线程锁定。 如果此后置条件无法满足[1]，则调用 std::terminate.
- ↑ 如果互斥锁的重新锁定抛出异常，则可能会发生这种情况。
内容 |
[编辑] 参数
| lock | - | 必须由调用线程锁定的锁 |
| stoken | - | 要注册中断的停止令牌 |
| rel_time | - | 等待的最大持续时间 |
| pred | - | 用于检查是否可以完成等待的谓词 |
| 类型要求 | ||
-Lock 必须满足 BasicLockable 的要求。 | ||
-Predicate 必须满足 FunctionObject 的要求。 | ||
| -pred() 必须是有效的表达式，其类型和值类别必须满足 BooleanTestable 要求。 | ||
[编辑] 返回值
2,3) 在返回调用者之前 pred() 的最新结果。
[编辑] 异常
1) 与超时相关的异常。
2,3) 与超时相关的异常，以及 pred 抛出的任何异常。
[编辑] 备注
即使在锁定状态下收到通知，重载 (1) 也不保证由于超时而返回时关联谓词的状态。
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 2093 | C++11 | 规范中缺少与超时相关的异常 | 提到了这些异常 |
| LWG 2114 (P2167R3) |
C++11 | 可转换为 bool 的能力太弱，无法反映实现的预期 | 要求得到加强 |
| LWG 2135 | C++11 | 如果 lock.lock() 抛出异常，行为不明确 | 在这种情况下调用 std::terminate |
[编辑] 另请参阅
| 阻止当前线程，直到条件变量被唤醒 (公有成员函数) | |
| 阻止当前线程，直到条件变量被唤醒或直到指定的时刻到来 (公有成员函数) |
