名前空間
変種
操作

std::condition_variable::wait_for

提供: cppreference.com

[edit template]
 
C++
 
スレッドサポートライブラリ
スレッド
(C++11)
(C++20)
(C++20)
(C++20)
(C++20)
(C++17)(C++17)
this_thread 名前空間
(C++11)
(C++11)
(C++11)
(C++11)
相互排他
(C++11)
(C++11)
(C++17)
汎用ロック管理
(C++11)
(C++17)
(C++11)
(C++14)
(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++20)(C++20)
ラッチとバリア
(C++20)
(C++20)
フューチャー
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
 
std::condition_variable
 
template< class Rep, class Period >

std::cv_status wait_for( std::unique_lock<std::mutex>& lock,

                         const std::chrono::duration<Rep, Period>& rel_time);
 (1) (C++11以上)
template< class Rep, class Period, class Predicate >

bool wait_for( std::unique_lock<std::mutex>& lock,
               const std::chrono::duration<Rep, Period>& rel_time,

               Predicate pred);
 (2) (C++11以上)
1) アトミックに、 lock を解放し、現在実行中のスレッドをブロックし、 *this の待機中スレッドのリストに追加します。 notify_all() または notify_one() が実行されるか、相対的なタイムアウト rel_time が経過すると、スレッドのブロックは解除されます。 spurious にブロック解除される可能性もあります。 ブロックが解除されると、その理由にかかわらず、 lock が再取得され、 wait_for() を抜けます。 例外によってこの関数を抜ける場合も、 lock は再取得されます。 (C++14未満)
2) return wait_until(lock, std::chrono::steady_clock::now() + rel_time, std::move(pred)); と同等です。 このオーバーロードは spurious wakeup を無視するために使用することができます。


標準は時間計測に steady clock を使用することを推奨しています。 スケジューリングやリソースの奪い合いによる遅延のため、この関数は timeout_duration より長くブロックする可能性があります。

lock.mutex() が現在のスレッドによってロックされていない場合、この関数の呼び出しは未定義動作です。

lock.mutex() が同じ条件変数で現在待機している他のすべてのスレッドが使用しているミューテックスと同じでない場合、この関数の呼び出しは未定義動作です。

これらの関数が事後条件 (lock.owns_lock()==true であり、 lock.mutex() が呼び出し元スレッドによってロックされている) を満たせない場合は、 std::terminate が呼ばれます。 例えば、ミューテックスの再取得で例外が投げられると、これが発生し得ます。

(C++14以上)

目次

[編集] 引数

lock - std::unique_lock<std::mutex> 型のオブジェクト。 現在のスレッドによってロックされていなければなりません
rel_time - 待機に費やす最大時間を表す std::chrono::duration 型のオブジェクト。 std::chrono::steady_clock::now() に加算したときにオーバーフローしない程度の小さな値でなければならないことに注意してください。
pred - 待機を続けるべき場合に ​false を返す述語。

述語関数のシグネチャは以下と同等であるべきです。

 bool pred();​

[編集] 戻り値

1) rel_time によって指定された相対タイムアウトが経過した場合は std::cv_status::timeout、そうでなければ std::cv_status::no_timeout。
2) 述語 pred が rel_time タイムアウト経過後も未だ false に評価される場合は false、そうでなければ true。


[編集] ���外

1)

std::system_error を投げる場合があります。 lock.lock() または lock.unlock() によって投げられた例外を伝播する場合もあります。

(C++14未満)

実行中に clock、time_point、または duration によって投げられるあらゆる例外 (標準ライブラリによって提供される clock、time_point、および duration は、例外を投げることはありません)。

(C++14以上)
2) (1) と同様ですが、 pred によって投げられた例外を伝搬する場合もあります。


[編集] ノート

ロック下で通知された場合であっても、タイムアウトで戻ったときは、オーバーロード (1) は紐付けられている述語の状態について、何の保証もしません。

notify_one()/notify_all() および wait()/wait_for()/wait_until() の3つのアトミック部分 (unlock+wait、wakeup、lock) 各々の効果は、アトミック変数の変更順序として考えることができる単一の全順序で行われます。 この順序は個々の条件変数に固有です。 これにより、例えば notify_one() が遅延され、 notify_one() の呼び出しの後に待機を開始したスレッドをブロック解除することは、ありえなくなります。

[編集] 例

Run this code
#include <iostream>
#include <atomic>
#include <condition_variable>
#include <thread>
#include <chrono>
using namespace std::chrono_literals;
 
std::condition_variable cv;
std::mutex cv_m;
int i;
 
void waits(int idx)
{
    std::unique_lock<std::mutex> lk(cv_m);
    if(cv.wait_for(lk, idx*100ms, []{return i == 1;})) 
        std::cerr << "Thread " << idx << " finished waiting. i == " << i << '\n';
    else
        std::cerr << "Thread " << idx << " timed out. i == " << i << '\n';
}
 
void signals()
{
    std::this_thread::sleep_for(120ms);
    std::cerr << "Notifying...\n";
    cv.notify_all();
    std::this_thread::sleep_for(100ms);
    {
        std::lock_guard<std::mutex> lk(cv_m);
        i = 1;
    }
    std::cerr << "Notifying again...\n";
    cv.notify_all();
}
 
int main()
{
    std::thread t1(waits, 1), t2(waits, 2), t3(waits, 3), t4(signals);
    t1.join();
    t2.join();
    t3.join();
    t4.join();
}

出力: 

Thread 1 timed out. i == 0
Notifying...
Thread 2 timed out. i == 0
Notifying again...
Thread 3 finished waiting. i == 1

[編集] 関連項目

 条件変数が通知されるまで現在のスレッドをブロックします
(パブリックメンバ関数) [edit]
条件変数が通知されるか指定時点に達するまで現在のスレッドをブロックします
(パブリックメンバ関数) [edit]
「https://ja.cppreference.com/mwiki/index.php?title=cpp/thread/condition_variable/wait_for&oldid=47554」から取得