std::condition_variable::wait

来自cppreference.com
 
 
线程支持库
线程
(C++11)
this_thread 命名空间
(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++11)
(C++11)
(C++11)
 
 
void wait( std::unique_lock<std::mutex>& lock );
(1) (C++11 起)
template< class Predicate >
void wait( std::unique_lock<std::mutex>& lock, Predicate pred );
(2) (C++11 起)

wait 导致当前线程阻塞直至条件变量被通知,或虚假唤醒发生,可选地循环直至满足某谓词。

1) 原子地释放 lock ,阻塞当前执行线程,并将它添加到于 *this 上等待的线程列表。线程将在执行 notify_all()notify_one() 时被解除阻塞。解阻塞时,无关乎原因, lock 得到释放且 wait 退出。若此函数通过异常退出,则亦会重获得 lock (C++14 前)
2) 等价于
while (!pred()) {
    wait(lock);
}
此重载可用于在等待特定条件成为 true 时忽略虚假唤醒。注意进入此方法前,必须得到 lockwait(lock) 退出后也会重获得它,即 lock 能用做 pred() 访问的保障。
若这些函数不能满足后置条件( lock.owns_lock()==true 且调用方线程锁定 lock.mutex() ),则调用 std::terminate 。例如,这可能在重锁定互斥抛异常的情况下发生。 (C++14 起)

目录

[编辑] 参数

lock - std::unique_lock<std::mutex> 类型对象,必须为当前线程所锁定
pred - 等待是否应该持续则返回 ​false 的谓词。

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

 bool pred();

[编辑] 返回值

(无)

[编辑] 异常

1)

可能抛出 std::system_error ,亦可能传播 lock.lock()lock.unlock() 所抛的异常。

(C++14 前)

不抛出

(C++14 起)
2)(1) 但亦会传播 pred 所抛的异常

[编辑] 注意

若当前线程未锁定 lock.mutex() ,则调用此函数是未定义行为。

lock.mutex() 与所有其他当前等待在同一条件变量上的线程所用的互斥不相同,则调用此函数是未定义行为。

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

[编辑] 示例

#include <iostream>
#include <condition_variable>
#include <thread>
#include <chrono>
 
std::condition_variable cv;
std::mutex cv_m; // 此互斥用于三个目的:
                 // 1) 同步到 i 的访问
                 // 2) 同步到 std::cerr 的访问
                 // 3) 为条件变量 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

[编辑] 参阅

阻塞当前线程,直到条件变量被唤醒,或到指定时限时长后
(公开成员函数) [编辑]
阻塞当前线程,直到条件变量被唤醒,或直到抵达指定时间点
(公开成员函数) [编辑]
cnd_waitC 文档