Skip to content

notify_all_at_thread_exit.md

Latest commit

 

History

History
130 lines (99 loc) · 3.48 KB

notify_all_at_thread_exit.md

File metadata and controls

130 lines (99 loc) · 3.48 KB

notify_all_at_thread_exit

  • condition_variable[meta header]
  • std[meta namespace]
  • condition_variable[meta class]
  • function[meta id-type]
  • cpp11[meta cpp]
namespace std {
  void notify_all_at_thread_exit(condition_variable& cond, unique_lock<mutex> lk);
}
  • unique_lock[link /reference/mutex/unique_lock.md]
  • mutex[link /reference/mutex/mutex.md]

概要

現在のスレッド終了時に、条件変数が待っている全てのスレッドを起床させる

要件

  • lkが呼び出し元スレッドによってロック取得されていること
  • *thisのcondition_variableオブジェクトが他スレッドで待機していないか、もしくは並行に待機している全てのスレッドでlockパラメータが同じミューテックスオブジェクトを参照していること

効果

lkのロック所有権を（スレッドライブラリの）内部ストレージへと移し、スレッド終了時、スレッドローカルなデータを解放した後、condを使って通知する。通知は以下のように行う：

// ここでスレッドローカルストレージを解放
lk.unlock();
cond.notify_all();
  • lk.unlock()[link /reference/mutex/unique_lock/unlock.md]
  • cond.notify_all()[link notify_all.md]

戻り値

なし

備考

ロックはスレッド終了まで保持され続けるため、デッドロックを避けるためにできるだけ早くスレッドを終了させることを推奨する。

例

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

struct ProcessData {
  std::mutex mtx_;
  std::condition_variable cond_;

  bool data_ready_;

public:
  ProcessData() : data_ready_(false) {}

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

    {
      std::unique_lock<std::mutex> lk(mtx_);
      data_ready_ = true;

      // このスレッドが終了したら、cond_を待機している全てのスレッドを起床させる
      std::notify_all_at_thread_exit(cond_, std::move(lk));
    }
  }

  void wait_for_data_to_process()
  {
    std::unique_lock<std::mutex> lk(mtx_);

    // データの準備ができるまで待機してから処理する
    cond_.wait(lk, [this] { return data_ready_; });
    process_data();
  }

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

int main()
{
  ProcessData p;

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

  t1.detach(); // 準備スレッドの管理を手放す

  t2.join();
  t3.join();
}
  • std::notify_all_at_thread_exit[color ff0000]
  • cond_.wait[link wait.md]
  • std::move[link /reference/utility/move.md]
  • t1.detach()[link /reference/thread/thread/detach.md]

出力

data is ready: true
data is ready: true

バージョン

言語

  • C++11

処理系

参照