std::condition_variable::wait_until
| template< class Clock, class Duration > std::cv_status |
(1) | (C++11以降) |
| template< class Clock, class Duration, class Predicate > bool wait_until( std::unique_lock<std::mutex>& lock, |
(2) | (C++11以降) |
wait_until は、現在のスレッドを、条件変数に通知されるか、指定された時刻に達するか、または偽りのウェイクアップが発生するまでブロックします。pred は、偽りのウェイクアップを検出するためにオプションで指定できます。
if (wait_until(lock, abs_time) == std::cv_status::timeout)
return pred();
return true; と同等です。
wait_until が返った直後、lock.owns_lock() は true であり、lock.mutex() は呼び出しスレッドによってロックされています。これらの事後条件が満たされない場合[1]、 std::terminate が呼び出されます。
次のいずれかの条件が満たされる場合、動作は未定義です。
- lock.owns_lock() は false です。
- lock.mutex() は呼び出しスレッドによってロックされていません。
- 他のスレッドも *this を待機している場合、lock.mutex() は、これらのスレッドによって *this で呼び出された待機関数（wait、wait_for、および
wait_until）によってアンロックされたミューテックスとは異なります。
- ↑ これは、ミューテックスの再ロックが例外をスローした場合に発生する可能性があります。
目次 |
[編集] パラメータ
| lock | - | 呼び出しスレッドによってロックされる必要があるロック |
| abs_time | - | 待機が期限切れとなる時刻 |
| pred | - | 待機が完了できるかどうかをチェックする述語 |
| 型要件 | ||
-Predicate は FunctionObject の要件を満たす必要があります。 | ||
| -pred() は有効な式であり、その型と値カテゴリは BooleanTestable の要件を満たす必要があります。 | ||
[編集] 戻り値
[編集] 例外
[編集] 注記
標準では、abs_time に関連付けられたクロックを使用して時間を測定することを推奨しています。そのクロックはモノトニッククロックである必要はありません。クロックが不連続に調整された場合の動作に関する保証はありませんが、既存の実装は Clock から std::chrono::system_clock への abs_time の変換を行い、POSIX の pthread_cond_timedwait に委譲するため、待機はシステムクロックの調整を尊重しますが、ユーザー提供の Clock の調整は尊重しません。いずれにしても、スケジューリングやリソース競合の遅延により、abs_time の到達後より長く待機することもあります。
使用中のクロックが std::chrono::steady_clock またはその他のモノトニッククロックであっても、システムクロックの調整は偽りのウェイクアップを誘発する可能性があります。
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 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 を呼び出す |
[編集] 関連項目
| 条件変数が通知されるまで現在のスレッドをブロックする (public member function) | |
| 指定されたタイムアウト期間後、または条件変数(condition variable)が起動されるまで、現在のスレッドをブロックする。 (public member function) |
