std::condition_variable_any::wait_for

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以降)

wait_for は、条件変数に通知されるか、指定された時間が経過するか、または偽のウェイクアップが発生するまで、現在のスレッドをブロックさせます。pred は、偽のウェイクアップを検出するためにオプションで指定できます。

1) return wait_until(lock, std::chrono::steady_clock::now() + rel_time); と同等です。

2,3) 特定の条件が真になるのを待機します。偽のウェイクアップを無視するために使用できます。

2) return wait_until(lock, std::chrono::steady_clock::now() + rel_time, std::move(pred)); と同等です。

3) この呼び出しの間、*this を登録し、stoken の関連する stop-state に stop リクエストが行われた場合に通知されます。その後、return wait_until(lock, std::move(stoken),
std::chrono::steady_clock::now() + rel_time, std::move(pred)); と同等です。

wait_for が返された直後、lock は呼び出しスレッドによってロックされます。この後条件を満たせない場合^[1]、std::terminate が呼び出されます。

↑ これは、ミューテックスの再ロックが例外をスローした場合に発生する可能性があります。

lock	-	呼び出しスレッドによってロックされる必要があるロック
stoken	-	割り込みを登録するためのストップトークン
rel_time	-	待機する最大時間
pred	-	待機が完了できるかどうかをチェックする述語
型要件
- `Lock` は BasicLockable の要件を満たす必要があります。
- `Predicate` は FunctionObject の要件を満たす必要があります。
- pred() は有効な式であり、その型と値カテゴリは BooleanTestable の要件を満たす必要があります。

[編集] 戻り値

1) この呼び出しの開始以降 rel_time が経過した場合、std::cv_status::timeout。そうでなければ、std::cv_status::no_timeout。

2,3) 返される前の pred() の最新の結果。

[編集] 例外

1) タイムアウト関連の例外。

2,3) タイムアウト関連の例外、および pred によってスローされる可能性のある例外。

[編集] 注記

ロック下で通知された場合でも、オーバーロード (1) は、タイムアウトによる復帰時に、関連する述語の状態について保証しません。

notify_one()/notify_all() と、wait()/wait_for()/wait_until() の 3 つのアトミック部分（アンロック+待機、ウェイクアップ、ロック）の効果は、単一の全順序で発生します。これは、アトミック変数の一連の変更順序と見なすことができます。この順序は、この個別の条件変数に固有のものです。これにより、例えば、notify_one() の呼び出しが行われた直後に待機を開始したスレッドを解除するために notify_one() が遅延することは不可能になります。

[編集] 例

このコードを実行

#include <chrono>
#include <condition_variable>
#include <iostream>
#include <thread>
 
std::condition_variable_any cv;
std::mutex cv_m; // This mutex is used for three purposes:
                 // 1) to synchronize accesses to i
                 // 2) to synchronize accesses to std::cerr
                 // 3) for the condition variable 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

[編集] 不具合報告

以下の動作変更を伴う欠陥報告が、以前に公開されたC++標準に遡って適用されました。

DR	適用対象	公開された動作	正しい動作
LWG 2093	C++11	タイムアウト関連の例外が仕様に欠けていました。	これらの例外に言及
LWG 2114 (P2167R3)	C++11	bool への変換可能性は、実装の期待を反映するには弱すぎた	要件が強化された
LWG 2135	C++11	lock.lock() が例外をスローした場合の動作が不明確だった	この場合、std::terminate を呼び出す

[編集] 関連項目

wait	条件変数が通知されるまで現在のスレッドをブロックする (public member function) [編集]
wait_until	指定された時刻に達するか、または条件変数(condition variable)が起動されるまで、現在のスレッドをブロックする。 (public member function) [編集]

[1] これは、ミューテックスの再ロックが例外をスローした場合に発生する可能性があります。

[1]

コンパイラサポート
フリースタンディングとホスト
言語
標準ライブラリ
標準ライブラリヘッダー
名前付き要件
機能テストマクロ (C++20)
言語サポートライブラリ
コンセプトライブラリ (C++20)
診断ライブラリ
メモリ管理ライブラリ
メタプログラミングライブラリ (C++11)
汎用ユーティリティライブラリ
コンテナライブラリ
イテレータライブラリ
Rangesライブラリ (C++20)
アルゴリズムライブラリ
文字列ライブラリ
テキスト処理ライブラリ
数値ライブラリ
日付と時刻ライブラリ
入出力ライブラリ
ファイルシステムライブラリ (C++17)
並行サポートライブラリ (C++11)
実行制御ライブラリ (C++26)
Technical specifications (技術仕様)
シンボルインデックス
外部ライブラリ

メンバ関数
condition_variable_any::condition_variable_any
condition_variable_any::~condition_variable_any
通知
condition_variable_any::notify_one
condition_variable_any::notify_all
待機
condition_variable_any::wait
condition_variable_any::wait_for
condition_variable_any::wait_until

cppreference.com

名前空間

変種

表示

操作