public member function
<condition_variable>

std::condition_variable_any::wait_for

unconditional (1)
template <class Lock, class Rep, class Period>  cv_status wait_for (Lock& lck,                      const chrono::duration<Rep,Period>& rel_time);
predicate (2)
template <class Lock, class Rep, class Period, class Predicate>       bool wait_for (Lock& lck,                      const chrono::duration<Rep,Period>& rel_time, Predicate pred);
等待超時或直到收到通知
當前執行緒(應持有 lck 鎖)的執行將被阻塞 rel_time 時間,或者直到收到通知(如果後者先發生)。

線上程阻塞時,函式會自動呼叫 lck.unlock(),允許其他已鎖定的執行緒繼續執行。

一旦收到通知或 rel_time 時間過去,函式將解除阻塞並呼叫 lck.lock(),使 lck 處於呼叫函式時的相同狀態。然後函式返回(請注意,這個最後的互斥鎖鎖定可能會在返回前再次阻塞執行緒)。

通常,函式是透過另一執行緒呼叫成員函式 notify_onenotify_one喚醒的。但某些實現可能會在沒有呼叫這些函式的情況下產生虛假喚醒。因此,此函式的使用者應確保其恢復條件得到滿足。

如果指定了 pred (2),則僅當 pred 返回 false 時函式才阻塞,並且只有在 pred 變為 true 時通知才能解除執行緒阻塞(這對於檢查虛假喚醒特別有用)。它的行為就好像是這樣實現的:
1
return wait_until (lck, chrono::steady_clock::now() + rel_time, std::move(pred));

引數

lck
當前被該執行緒鎖定的一個可鎖定物件
所有對該物件的wait 成員函式的併發呼叫都必須使用相同的底層互斥鎖物件
Lock 應為可鎖定型別
rel_time
執行緒在等待通知期間可能阻塞的最大時間跨度。
duration 是一個表示特定相對時間的物件。
pred
一個可呼叫物件或函式,它不接受任何引數,並返回一個可以被評估為 bool 的值。
此函式會反覆呼叫 pred,直到其求值為 true

返回值

無條件版本 (1) 如果函式因為 rel_time 時間過去而返回,則返回 cv_status::timeout,否則返回 cv_status::no_timeout
謂詞版本 (2) 返回 pred(),而不管超時是否被觸發(儘管它只有在被觸發時才能為 false)。

示例

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
// condition_variable_any::wait_for example
#include <iostream>           // std::cout
#include <thread>             // std::thread
#include <chrono>             // std::chrono::seconds
#include <mutex>              // std::mutex
#include <condition_variable> // std::condition_variable_any, std::cv_status

std::condition_variable_any cv;

int value;

void read_value() {
  std::cin >> value;
  cv.notify_one();
}

int main ()
{
  std::cout << "Please, enter an integer (I'll be printing dots): ";
  std::thread th (read_value);

  std::mutex mtx;
  mtx.lock();
  while (cv.wait_for(mtx,std::chrono::seconds(1))==std::cv_status::timeout) {
    std::cout << '.';
  }
  std::cout << "You entered: " << value << '\n';
  mtx.unlock();

  th.join();

  return 0;
}

可能的輸出

Please, enter an integer (I'll be priniting dots): .....20
You entered: 20


資料競爭

該函式執行三個原子操作:
  • lck 的初始解鎖和同時進入等待狀態。
  • 解除等待狀態。
  • 在返回前鎖定 lck
對物件的原子操作按照一個單一的總順序進行排序,此函式中的三個原子操作以與上述相同的相對順序發生。

異常安全

如果任何引數的值對此函式無效(例如,如果 lck互斥鎖物件未被呼叫執行緒鎖定),則會導致未定義行為

否則,如果丟擲異常,則 condition_variable_any 物件和引數都處於有效狀態(基本保證)。

如果發生錯誤(將相應的對 lockunlock 的呼叫傳輸的任何錯誤條件),則可能丟擲 system_error

謂詞版本 (2) 也可能丟擲由 pred 丟擲的任何異常。

發生異常時,在退出函式作用域之前,會嘗試恢復 lck 的狀態(透過呼叫 lck.lock())。
如果與 rel_time 相關的操作丟擲異常,則可能丟擲異常(請注意,<chrono> 中提供的 duration 型別(如 seconds)的操作永遠不會丟擲異常)。

謂詞版本 (2) 也可能丟擲由 pred 丟擲的異常。

如果函式在某個時刻未能恢復鎖定並返回(例如,如果嘗試鎖定或解鎖時丟擲異常),則會呼叫 std::terminate

另見