Namespaces
Variants

std::condition_variable_any:: wait_for

From cppreference.net
Concurrency support library
Threads
(C++11)
(C++20)
this_thread namespace
(C++11)
(C++11)
Cooperative cancellation
Mutual exclusion
Generic lock management
Condition variables
(C++11)
Semaphores
Latches and Barriers
(C++20)
(C++20)
Futures
(C++11)
(C++11)
(C++11)
Safe reclamation
Hazard pointers
Atomic types
(C++11)
(C++20)
Initialization of atomic types
(C++11) (deprecated in C++20)
(C++11) (deprecated in C++20)
Memory ordering
(C++11) (deprecated in C++26)
Free functions for atomic operations
Free functions for atomic flags
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 の関連付けられた停止状態に対して停止要求が行われた場合に通知を受ける。その後、これは以下と等価となる: return wait_until ( lock, std :: move ( stoken ) ,
std:: chrono :: steady_clock :: now ( ) + rel_time, std :: move ( pred ) ) ;

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

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

目次

パラメータ

lock - 呼び出しスレッドによってロックされなければならないロック
stoken - 割り込み登録用のストップトークン
rel_time - 待機する最大時間
pred - 待機完了を判定する述語
型要件
-
Lock BasicLockable の要件を満たさなければならない。
-
Predicate FunctionObject の要件を満たさなければならない。
-
pred ( ) は有効な式でなければならず、その型と値カテゴリは BooleanTestable の要件を満たさなければならない。

戻り値

1) std:: cv_status :: timeout この呼び出し開始から rel_time が経過した場合、それ以外の場合は 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; // このミューテックスは3つの目的で使用されます:
                 // 1) iへのアクセスを同期するため
                 // 2) std::cerrへのアクセスを同期するため
                 // 3) 条件変数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)
条件変数が通知されるか、指定された時間ポイントに到達するまで現在のスレッドをブロックする
(public member function)