命名空间
变体
操作

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++11)
条件变量
(C++11)
信号量
闩锁和屏障
(C++20)
(C++20)
期货
(C++11)
(C++11)
(C++11)
(C++11)
安全回收
(C++26)
危险指针
原子类型
(C++11)
(C++20)
原子类型初始化
(C++11)(C++20 中已弃用)
(C++11)(C++20 中已弃用)
内存排序
用于原子操作的自由函数
用于原子标志的自由函数
 
 
template< class Lock, class Clock, class Duration >

std::cv_status
    wait_until( Lock& lock,

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

bool wait_until( Lock& lock,
                 const std::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,
                 const std::chrono::time_point<Clock, Duration>& abs_time,

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

wait_until 会导致当前线程阻塞,直到条件变量被通知,给定的持续时间已过去,或发生虚假唤醒。 pred 可以选择性地提供以检测虚假唤醒。

1) 原子地调用 lock.unlock() 并阻塞在 *this 上。
notify_all()notify_one() 被执行,或 abs_time 到达时,线程将被解除阻塞。它也可能被虚假地解除阻塞。
解除阻塞后,调用 lock.lock()(可能在锁上阻塞),然后返回。
2,3) 等待特定条件变为真,可以用来忽略虚假唤醒。
2) 等同于 while (!pred())
    if (wait_until(lock, abs_time) == std::cv_status::timeout)
        return pred();
return true;
.
3) 注册 *this 在此调用的持续时间内,以便在对 stoken 的关联停止状态发出停止请求时通知;然后它等同于 while (!stoken.stop_requested())
{
    if (pred())
        return true;
    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) std::cv_status::timeout 如果已经达到 abs_time,否则 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() 的三个原子部分(解锁+等待、唤醒和锁定)的效果以单个总顺序发生,可以被视为 修改顺序 of an atomic variable: the order is specific to this individual condition variable. This makes it impossible for notify_one() to, for example, be delayed and unblock a thread that started waiting just after the call to notify_one() was made.

[编辑] 示例

#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

[编辑] 另请参阅

阻塞当前线程,直到条件变量被唤醒
(公共成员函数) [编辑]
wait_until
阻塞当前线程,直到条件变量被唤醒或直到达到指定的时刻
(公共成员函数) [编辑]