Namespaces
Variants

std::condition_variable_any:: wait

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 >
void wait ( Lock & lock ) ;
(1) (C++11以降)
template < class Lock, class Predicate >
void wait ( Lock & lock, Predicate pred ) ;
(2) (C++11以降)
template < class Lock, class Predicate >
bool wait ( Lock & lock, std:: stop_token stoken, Predicate pred ) ;
(3) (C++20以降)

wait は、条件変数が通知されるか、偽の起床が発生するまで、現在のスレッドをブロックします。 pred はオプションで提供され、偽の起床を検出するために使用できます。

1) アトミックに lock. unlock ( ) を呼び出し、 * this でブロックします。
スレッドは、 notify_all() または notify_one() が実行されたときにブロック解除されます。また、偽の解除が発生する可能性もあります。
ブロック解除されると、 lock. lock ( ) を呼び出し(ロックでブロックされる可能性あり)、その後リターンします。
2,3) 特定の条件が真になるまで待機。擬似的な起床を無視するために使用できる。
2) 次と同等
while ( ! pred ( ) )
wait ( lock ) ;
3) この呼び出しの期間中、 * this を登録し、 stoken の関連付けられた停止状態に対して停止要求が行われた場合に通知を受信する。その後、これは以下と等価となる:
while ( ! stoken. stop_requested ( ) )
{
if ( pred ( ) )
return true ;
wait ( lock ) ;
}
return pred ( ) ;

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

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

目次

パラメータ

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

戻り値

1,2) (なし)
3) 呼び出し元に戻る前の pred ( ) の最新の結果。

例外

1) 例外を投げない。
2,3) pred によって送出されるあらゆる例外。

注記

オーバーロード (3) の戻り値は、 pred true と評価されたかどうかを示し、停止要求の有無に関わらず適用されます。

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 2114
( P2167R3 )
C++11 bool への変換可能性が実装の期待を反映するには弱すぎた 要件を強化
LWG 2135 C++11 lock. lock ( ) が例外をスローした場合の動作が不明確だった この場合 std::terminate を呼び出す

関連項目

現在のスレッドを、条件変数が通知されるか、指定されたタイムアウト時間が経過するまでブロックする
(public member function)
現在のスレッドを、条件変数が通知されるか、指定された時間ポイントに到達するまでブロックする
(public member function)
C documentation for cnd_wait

外部リンク

The Old New Thing 記事: Win32条件変数における偽のウェイクアップ。