std::condition_variable_any::wait_until

来自cppreference.com

 
C++
 
线程支持库
线程
(C++11)
(C++20)
(C++20)
(C++20)
(C++20)
(C++17)(C++17)
this_thread 命名空间
(C++11)
(C++11)
(C++11)
(C++11)
互斥
(C++11)
(C++11)
(C++17)
通用锁管理
(C++11)
(C++17)
(C++11)
(C++14)
(C++11)(C++11)(C++11)
(C++11)
(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++20)
(C++20)
future
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
 
std::condition_variable_any
 
template< class Lock, class Clock, class Duration >

std::cv_status
    wait_until( Lock& lock,

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

bool wait_until( Lock& lock,
                 const std::chrono::time_point<Clock, Duration>& timeout_time,

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

void wait_until( Lock& lock,
                 std::stop_token stoken,
                 const std::chrono::time_point<Clock, Duration>& timeout_time,

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

wait_until 导致当前线程阻塞直至通知条件变量、抵达指定时间或虚假唤醒发生，可选的循环直至满足某谓词。

1) 原子地释放 lock ，阻塞当前线程，并将它添加到等待在 *this 上的线程列表。将在执行 notify_all() 或 notify_one() 时，或抵达绝对时间点 timeout_time 时解除阻塞线程。亦可能虚假地解除阻塞。解除阻塞时，无关缘由，重获得 lock 并退出 wait_for() 。
2) 等价于
while (!pred()) {
    if (wait_until(lock, timeout_time) == std::cv_status::timeout) {
        return pred();
    }
}
return true;
此重载可用于忽略虚假唤醒。


3) 可中断等待：在 wait_until() 期间注册 condition_variable_any ，使得若在给定的 stoken 的关联停止状态上作出停止请求则提醒它；然后它等价于 
while (!stoken.stop_requested()) {
    if (pred())
        return true;
    if (wait_until(lock, timeout_time) == std::cv_status::timeout)
        return pred();
}
return pred();

若这些函数不能满足后条件（调用方线程锁定 lock ），则调用 std::terminate 。例如，这可能在重锁定互斥抛异常的情况下发生。

Clock 必须符合时钟 (Clock) 要求。若 std::chrono::is_clock_v<Clock> 为 false 则程序为非良构。 (C++20 起)

参数

lock - 满足基本可锁定 (BasicLockable) 要求的 Lock 类型对象，必须为当前线程所锁定
stoken - 用于注册中断的 std::stop_token
timeout_time - 表示停止等待时间的 std::chrono::time_point 类型对象
pred - 是否应该持续等待则返回 ​false 的谓词。

谓词函数的签名应等价于如下者：

 bool pred();​

返回值

1) 若抵达 timeout_time 指定的的绝对时间点则为 std::cv_status::timeout ，否则为 std::cv_status::no_timeout 。
2) 若度过 timeout_time 时限后 pred 仍求值为 false 则为 false ，否则为 true 。若已度过时限，则求值并返回 pred 的结果。
3) pred() ，无关乎是否到达实现或请求停止。

异常

1) 执行期间时钟、时间点或时长可能抛出的任何异常（标准库提供的时钟、时间点和时长决不抛出）
2) 同 (1) ，但亦可传播 pred 所抛的异常
3) 同 (2)

注解

使用倾向 timeout_time 的时钟，不要求是单调时钟。若不连续地调节时钟，则不对此函数的行为保证，但既存实现将 timeout_time 从 Clock 转换到 std::chrono::system_clock ，并委托 POSIX pthread_cond_timedwait 以令等待忠实于系统时钟，但非用户提供 Clock 的调节。任何情况下，由于调度或资源争议延迟，函数可能等待长于抵达 timeout_time 。

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

notify_one()/notify_all() 的效果与 wait()/wait_for()/wait_until() 的三个原子部分的每一者（解锁+等待、唤醒和锁定）以能看做原子变量修改顺序单独全序发生：顺序对此单独的 condition_variable 是特定的。譬如，这使得 notify_one() 不可能被延迟并解锁正好在进行 notify_one() 调用后开始等待的线程。

示例

运行此代码
#include <iostream>
#include <atomic>
#include <condition_variable>
#include <thread>
#include <chrono>
using namespace std::chrono_literals;
 
std::condition_variable cv;
std::mutex cv_m;
std::atomic<int> i{0};
 
void waits(int idx)
{
    std::unique_lock<std::mutex> lk(cv_m);
    auto now = std::chrono::system_clock::now();
    if(cv.wait_until(lk, now + idx*100ms, [](){return i == 1;}))
        std::cerr << "Thread " << idx << " finished waiting. i == " << i << '\n';
    else
        std::cerr << "Thread " << idx << " timed out. i == " << i << '\n';
}
 
void signals()
{
    std::this_thread::sleep_for(120ms);
    std::cerr << "Notifying...\n";
    cv.notify_all();
    std::this_thread::sleep_for(100ms);
    i = 1;
    std::cerr << "Notifying again...\n";
    cv.notify_all();
}
 
int main()
{
    std::thread t1(waits, 1), t2(waits, 2), t3(waits, 3), t4(signals);
    t1.join(); 
    t2.join();
    t3.join();
    t4.join();
}

可能的输出： 

Thread 1 timed out. i == 0
Notifying...
Thread 2 timed out. i == 0
Notifying again...
Thread 3 finished waiting. i == 1

缺陷报告

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

DR 应用于 出版时的行为 正确行为
LWG 2093 C++11 规范中缺失超时相关异常 已提及
LWG 2135 C++11 wait_until 在解锁/重锁失败时抛异常 调用 std::terminate

参阅

 阻塞当前线程，直到条件变量被唤醒
(公开成员函数)
阻塞当前线程，直到条件变量被唤醒，或到指定时限时长后
(公开成员函数)
来自“https://zh.cppreference.com/mwiki/index.php?title=cpp/thread/condition_variable_any/wait_until&oldid=52631”