std::condition_variable_any::wait(C++11)

template <class Lock>
void wait(Lock& lock);                 // (1)

template <class Lock, class Predicate>
void wait(Lock& lock, Predicate pred); // (2)

template<class Lock, class Predicate>
bool wait(Lock& lock,
          stop_token stoken,
          Predicate pred);             // (3) C++20 から

概要

起床されるまで待機する。

この関数は、処理をするための準備ができたことをnotify_one()/notify_all()によって通知されるまでスレッドを待機するために使用する。

述語を指定しない場合、notify_one()/notify_all()が呼び出された時点でこの関数のブロッキングが解除される。

述語を指定する場合、述語呼び出しがtrueになるまで待機を続行する。

効果

(1) :
- アトミックにlock.unlock()する
- notify_one()/notify_all()もしくはそれ以外の理由で通知があるまでブロッキングする
- この関数を抜ける際にlock.lock()する
- この関数が例外送出によって終了する場合、関数を抜ける前にlock.lock()する
(2) : 以下と等価の処理を行う

while (!pred()) {
  wait(lock);
}

(3) : このメンバ関数呼び出しの間だけstokenに対する停止要求によって*thisへ通知が行われるよう登録し、以下と等価の処理を行う

while (!stoken.stop_requested()) {
  if (pred())
    return true;
  wait(lock);
}
return pred();

事後条件

lockが参照しているミューテックスオブジェクトが、この関数を呼び出したスレッドでロック取得されていること

戻り値

(1),(2) : なし
(3) : 停止要求の有無によらず、pred()の結果が返る。

例外

(1) :
- C++11まで : この関数は、lock.lock()およびlock.unlock()によって送出されうる、あらゆる例外が送出される可能性がある。
- C++14 : 投げない
(2) :
- C++11まで : この関数は、lock.lock()およびlock.unlock()によって送出されうる、あらゆる例外が送出される可能性がある。
- C++14 : pred()により送出された例外。－ (3) :
- pred()により送出された例外。

備考

C++14 : 事後条件を満たさない場合、std::terminate()関数を呼び出して、プログラムを異常終了させる。これは、ミューテックスの再ロック取得が例外を送出した場合に発生する。

例

#include <iostream>
#include <condition_variable>
#include <mutex>
#include <thread>

struct ProcessData {
  std::recursive_mutex mtx_;
  std::condition_variable_any cond_;

  bool data_ready_ = false;

public:
  // 処理に必要なデータの準備をする
  void prepare_data_for_processing()
  {
    // ...準備処理...

    {
      std::lock_guard<std::recursive_mutex> lk(mtx_);
      data_ready_ = true;
    }

    // 準備完了したので待機スレッドを全て起床させる
    cond_.notify_all();
  }

  void wait_for_data_to_process1()
  {
    std::unique_lock<std::recursive_mutex> lk(mtx_);

    // データの準備ができるまで待機してから処理する
    while (!data_ready_) {
      // 述語を指定しないバージョン
      cond_.wait(lk);
    }
    process_data();
  }

  void wait_for_data_to_process2()
  {
    std::unique_lock<std::recursive_mutex> lk(mtx_);

    // データの準備ができるまで待機してから処理する

    // 述語を指定するバージョン
    cond_.wait(lk, [this] { return data_ready_; });
    process_data();
  }

private:
  void process_data()
  {
    // ...データを処理する...
    std::cout << "process data" << std::endl;
  }
};

int main()
{
  ProcessData p;

  std::thread t1([&] { p.prepare_data_for_processing(); });
  std::thread t2([&] { p.wait_for_data_to_process1(); });
  std::thread t3([&] { p.wait_for_data_to_process2(); });

  t1.join();
  t2.join();
  t3.join();
}

出力

process data
process data

std::condition_variable_any::wait(C++11)

概要

効果

事後条件

戻り値

例外

備考

例

出力

バージョン

言語

処理系

参照