std::condition_variable_any::wait_for

来自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 Rep, class Period >

std::cv_status wait_for( Lock& lock,

                         const std::chrono::duration<Rep, Period>& rel_time);
 (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,

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

bool wait_for( Lock& lock,
               std::stop_token stoken,
               const std::chrono::duration<Rep, Period>& rel_time,

               Predicate pred);
 (3) (C++20 起)
1) 原子地释放 lock ，阻塞当前线程，并将它添加到等待在 *this 上的线程列表。线程将在执行 notify_all() 或 notify_one() 时，或度过相对时限 rel_time 时被解除阻塞。它亦可被虚假地解除阻塞。解阻塞时，无关缘由，重获得 lock 并退出 wait_for() 退出。
2) 等价于 return wait_until(lock, std::chrono::steady_clock::now() + rel_time, std::move(pred)); 。此重载可用于忽略虚假唤醒。

用稳定时钟度量时长。由于调度或资源争议，此函数可能阻塞长于 timeout_duration 。

3) 等价于 return wait_until(lock, std::move(stoken), std::chrono::steady_clock::now() + rel_time, std::move(pred));


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

参数

lock - 满足基本可锁定 (BasicLockable) 要求的 Lock 类型对象，必须为当前线程所锁定
stoken - 用于注册中断的 std::stop_token
rel_time - 表示等待所耗的最大时间的 std::chrono::duration 类型对象。注意 rel_time 必须足够小，以在加到 std::chrono::steady_clock::now() 时不溢出。
pred - 是否应该持续等待则返回 ​false 的谓词。

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

 bool pred();​

返回值

1) 若经过 rel_time 所指定的关联时限则为 std::cv_status::timeout ，否则为 std::cv_status::no_timeout 。
2) 若经过 rel_time 时限后谓词 pred 仍求值为 false 则为 false ，否则为 true 。
3) pred() ，无关乎是否达到时限或停止请求。

异常

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

注解

即使在锁定时通知，重载 (1) 在因时限退出时也不对关联谓词的状态做出保证。

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_any cv;
std::mutex cv_m;
int i;
 
void waits(int idx)
{
    std::unique_lock<std::mutex> lk(cv_m);
    if(cv.wait_for(lk, 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);
    {
        std::lock_guard<std::mutex> lk(cv_m);
        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_for 在解锁/重锁失败时抛异常 调用 std::terminate

参阅

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