std::condition_variable_any::wait_until

来自cppreference.com
 
 
并发支持库
线程
(C++11)
(C++20)
this_thread 命名空间
(C++11)
(C++11)
(C++11)
协作式取消
互斥
通用锁管理
(C++11)
(C++11)
(C++11)
(C++11)
条件变量
(C++11)
信号量
闩与屏障
(C++20)
(C++20)
未来体
(C++11)
(C++11)
(C++11)
安全回收
风险指针
原子类型
(C++11)
(C++20)
原子类型的初始化
(C++11)(C++20 弃用)
(C++11)(C++20 弃用)
内存定序
(C++11)(C++26 弃用)
原子操作的自由函数
原子标志的自由函数
 
 
template<class Lock, class Clock, class Duration >

std::cv_status
    wait_until( Lock& lock,

                conststd::chrono::time_point<Clock, Duration>& abs_time );
(1) (C++11 起)
template<class Lock, class Clock, class Duration, class Predicate >

bool wait_until( Lock& lock,
                 conststd::chrono::time_point<Clock, Duration>& abs_time,

                 Predicate pred );
(2) (C++11 起)
template<class Lock, class Clock, class Duration, class Predicate >

bool wait_until( Lock& lock, std::stop_token stoken,
                 conststd::chrono::time_point<Clock, Duration>& abs_time,

                 Predicate pred );
(3) (C++20 起)

wait_until 导致当前线程阻塞,直至条件变量被通知,超过指定的时长,或发生虚假唤醒。可以提供 pred 以检测虚假唤醒。

1) 原子地调用 lock.unlock(),并在 *this 上阻塞调用线程。
调用线程会在抵达 abs_time,或者执行 notify_all()notify_one() 时解除阻塞。它也可能因虚假唤醒而解除阻塞。
在解除阻塞时调用 lock.lock()(在锁定时可能还会阻塞),然后返回。
2,3) 等待特定条件为真,可用于忽略虚假唤醒。
2) 等价于 while(!pred())
    if(wait_until(lock, abs_time)==std::cv_status::timeout)
        return pred();
returntrue;
3) 在此调用期间注册 *this,使得在给定的 stoken 的关联停止状态上作出停止请求时提醒它;它等价于 while(!stoken.stop_requested())
{
    if(pred())
        returntrue;
    if(wait_until(lock, abs_time)==std::cv_status::timeout)
        return pred();
}
return pred();

wait_until 返回时,调用线程会锁定 lock。如果无法满足此后条件[1],那么就会调用 std::terminate

  1. 重新锁定互斥体的过程中抛出异常就会发生这种情况。

目录

[编辑]参数

lock - 必须已经由调用线程锁定的锁
stoken - 用于注册中断的停止令牌
abs_time - 等待截止的时间点
pred - 检查是否可以完成等待的谓词
类型要求
-
Lock 必须满足可基本锁定(BasicLockable)
-
Predicate 必须满足函数对象(FunctionObject)
-
pred() 必须为合法的表达式,且其类型与值类别必须符合可布尔测试(BooleanTestable) 要求。

[编辑]返回值

1) 已经抵达 abs_time 的情况下返回 std::cv_status::timeout,否则返回 std::cv_status::no_timeout
2,3) 在返回调用方前 pred() 的最新结果。

[编辑]异常

1) 超时相关异常。
2,3) 超时相关异常,以及 pred 抛出的任何异常。

[编辑]注解

标准建议使用绑定到 abs_time 的时钟来测量时间,而该时钟不需要是单调时钟。当该时钟的调节不连续时,不会对此函数的行为有任何保证,但既存实现会将 abs_timeClock 转换到 std::chrono::system_clock,并委托 POSIX pthread_cond_timedwait,使得等待忠实于系统时钟而不是用户提供的 Clock 的调节。任何情况下,由于调度或资源争议延迟,函数可能在抵达 abs_time 后还会继续等待。

即使使用的始终是 std::chrono::steady_clock 或另一单调时钟,系统时钟调节也可能会导致虚假唤醒。

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;// 此互斥体用于三个目的:// 1) 同步对 i 的访问// 2) 同步对 std::cerr 的访问// 3) 用于条件变量 cvint i =0;   void waits(){std::unique_lock<std::mutex> lk(cv_m);std::cerr<<"等待... \n"; cv.wait(lk, []{return i ==1;});std::cerr<<"...结束等待。i == 1\n";}   void signals(){std::this_thread::sleep_for(std::chrono::seconds(1));{std::lock_guard<std::mutex> lk(cv_m);std::cerr<<"通知...\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<<"再次通知...\n";} cv.notify_all();}   int main(){std::thread t1(waits), t2(waits), t3(waits), t4(signals); t1.join(); t2.join(); t3.join(); t4.join();}

可能的输出:

等待... 等待... 等待... 通知... 再次通知... ...结束等待。i == 1 ...结束等待。i == 1 ...结束等待。i == 1

[编辑]缺陷报告

下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。

缺陷报告 应用于 出版时的行为 正确行为
LWG 2093 C++11 说明中缺失了超时相关异常 提及这些异常
LWG 2114
(P2167R3)
C++11 bool 的可转换性过于弱而无法反映实现的期待 加强要求
LWG 2135 C++11 lock.lock() 抛出异常时的行为不明确 此时会调用 std::terminate

[编辑]参阅

阻塞当前线程,直到条件变量被唤醒
(公开成员函数)[编辑]
阻塞当前线程,直到条件变量被唤醒,或到指定时限时长后
(公开成员函数)[编辑]
close