std::condition_variable::wait_until
template< class Clock, class Duration > std::cv_status |
(1) | (C++11 起) |
template< class Clock, class Duration, class Pred > bool wait_until( std::unique_lock<std::mutex>& lock, |
(2) | (C++11 起) |
wait_until
导致当前线程阻塞直至通知条件变量、抵达指定时间或虚假唤醒发生,可选的循环直至满足某谓词。
lock
,阻塞当前线程,并将它添加到等待在 *this 上的线程列表。线程将在执行 notify_all() 或 notify_one() 时,或抵达绝对时间点 timeout_time
时被解除阻塞。它亦可被虚假地解除阻塞。解除阻塞时,无关缘由,重获得 lock
并退出 wait_for()
。若此函数通过异常退出,则亦重获得 lock
。 (C++14 前)while (!pred()) { if (wait_until(lock, timeout_time) == std::cv_status::timeout) { return pred(); } } return true;
若当前线程未锁定 lock.mutex()
,则调用此函数是未定义行为。
若 lock.mutex()
与所有其他当前等待在同一条件变量上的线程所用的互斥不相同,则调用此函数是未定义行为。
若这些函数不能满足后置条件( lock.owns_lock()==true 且调用方线程锁定 lock.mutex() ),则调用 std::terminate 。例如,这可能在重锁定互斥抛异常的情况下发生。 |
(C++14 起) |
参数
lock | - | std::unique_lock<std::mutex> 类型对象,必须被当前线程锁定 |
timeout_time | - | 表示停止等待时间的 std::chrono::time_point 类型对象 |
pred | - | 是否应该持续等待则返回 false 的谓词。 谓词函数的签名应等价于如下者: bool pred(); |
返回值
timeout_time
时限后 pred
仍求值为 false 则为 false ,否则为 true 。若已度过时限,则求值并返回 pred
的结果。异常
可抛出 std::system_error ,亦可传播 lock.lock() 或 lock.unlock() 所抛的异常 |
(C++14 前) |
执行期间时钟、时间点或时长可能抛出的任何异常(标准库提供的时钟、时间点和时长决不抛出) |
(C++14 起) |
pred
所抛的异常注意
使用倾向 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
参阅
阻塞当前线程,直到条件变量被唤醒 (公开成员函数) | |
阻塞当前线程,直到条件变量被唤醒,或到指定时限时长后 (公开成员函数) |