public member function
<condition_variable>

std::condition_variable_any::wait

unconditional (1)
template <class Lock> void wait (Lock& lck);
predicate (2)
template <class Lock, class Predicate>  void wait (Lock& lck, Predicate pred);
等待通知
当前线程的执行(该线程目前应锁定 lck)将一直阻塞,直到被通知

在线程阻塞时,函数会自动调用 lck.unlock(),允许其他已锁定的线程继续执行。

一旦被通知(由另一个线程显式调用),函数将解除阻塞并调用 lck.lock(),使 lck 恢复到调用函数时的状态。然后函数返回(请注意,最后的互斥锁锁定操作可能会在返回前再次阻塞线程)。

通常,该函数是通过其他线程调用成员函数 notify_onenotify_all通知以唤醒的。但某些实现可能会在没有调用这些函数的情况下产生虚假唤醒。因此,该函数的使用者应确保其恢复条件得到满足。

如果指定了 pred (2),则仅当 pred 返回 false 时,函数才会阻塞,并且通知只能在 pred 变为 true 时解除阻塞线程(这对于检查虚假唤醒特别有用)。此版本 (2) 的行为类似于如下实现:
1
while (!pred()) wait(lck);

参数

lck
当前被该线程锁定的一个可锁定对象
所有对该对象的wait 成员函数的并发调用都必须使用相同的底层互斥锁对象
Lock 应为可锁定类型
pred
一个可调用对象或函数,它不接受任何参数,并返回一个可以被评估为 bool 的值。
此函数会反复调用 pred,直到其求值为 true

返回值



示例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
// condition_variable_any::wait (with predicate)
#include <iostream>           // std::cout
#include <thread>             // std::thread, std::this_thread::yield
#include <mutex>              // std::mutex
#include <condition_variable> // std::condition_variable_any

std::mutex mtx;
std::condition_variable_any cv;

int cargo = 0;
bool shipment_available() {return cargo!=0;}

void consume (int n) {
  for (int i=0; i<n; ++i) {
    mtx.lock();
    cv.wait(mtx,shipment_available);
    // consume:
    std::cout << cargo << '\n';
    cargo=0;
    mtx.unlock();
  }
}

int main ()
{
  std::thread consumer_thread (consume,10);

  // produce 10 items when needed:
  for (int i=0; i<10; ++i) {
    while (shipment_available()) std::this_thread::yield();
    mtx.lock();
    cargo = i+1;
    cv.notify_one();
    mtx.unlock();
  }

  consumer_thread.join();

  return 0;
}

输出

1
2
3
4
5
6
7
8
9
10


数据竞争

该函数执行三个原子操作:
  • lck 的初始解锁和同时进入等待状态。
  • 解除等待状态。
  • 在返回前锁定 lck
对对象的原子操作按照一个单一的总顺序进行排序,此函数中的三个原子操作以与上述相同的相对顺序发生。

异常安全

如果任何参数的值对此函数无效(例如,如果 lck互斥锁对象未被调用线程锁定),则会导致未定义行为

否则,如果抛出异常,则 condition_variable_any 对象和参数都处于有效状态(基本保证)。此外,在发生异常时,会尝试恢复 lck 的状态,然后再退出函数作用域(通过调用 lck.lock())。

在发生故障时,可能会抛出 system_error(将相应的 lockunlock 调用中的任何错误条件传递出来)。
谓词版本 (2) 也可能抛出由 pred 抛出的异常。
否则
无条件版本 (1) 永远不会抛出异常(无抛出保证)。
谓词版本 (2) 可能会抛出由 pred 抛出的异常,使 condition_variable_any 对象和参数都处于有效状态(基本保证)。

如果函数在某个时刻未能恢复锁定并返回(例如,如果尝试锁定或解锁时抛出异常),则会调用 std::terminate

另见