命名空间
变体
操作

std::condition_variable_any::wait_until

来自 cppreference.cn
 
 
并发支持库
线程
(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 中已弃用)
内存排序
(C++11)(C++26 中已弃用)
原子操作的自由函数
原子标志的自由函数
 
 
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) 如果已达到 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; // 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++ 标准。

缺陷报告 应用于 发布时的行为 正确的行为
LWG 2093 C++11 规范中缺少与超时相关的异常 提及这些异常
LWG 2114
(P2167R3)
C++11 可转换为 bool 对于反映实现的期望来说太弱了 要求已加强
LWG 2135 C++11 如果 lock.lock() 抛出异常,则行为不明确 在这种情况下调用 std::terminate

[编辑] 另请参阅

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