template <class Rep, class Period>
cv_status wait_for(unique_lock<mutex>& lock,
const chrono::duration<Rep, Period>& rel_time); // (1)
template <class Rep, class Period, class Predicate>
bool wait_for(unique_lock<mutex>& lock,
const chrono::duration<Rep, Period>& rel_time,
Predicate pred); // (2)
概要
相対時間でタイムアウトを指定して、起床されるまで待機する。
この関数は、処理をするための準備ができたことをnotify_one()
/notify_all()
によって通知されるまでスレッドを待機するために使用する。
述語を指定しない場合、notify_one()
/notify_all()
が呼び出された時点でこの関数のブロッキングが解除される。
述語を指定する場合、述語呼び出しがtrue
になるまで待機を続行する。
要件
lock.owns_lock() == true
であることlock
が参照しているミューテックスオブジェクトが、この関数を呼び出したスレッドでロック取得されていること*this
のcondition_variable
オブジェクトが他スレッドで待機していないか、もしくは並行に待機している全てのスレッドでlock
パラメータが同じミューテックスオブジェクトを参照していること
戻り値
- (1) :
return wait_until(lock, chrono::steady_clock::now() + rel_time);
rel_time
で指定された相対時間内に起床されない場合、タイムアウトとなりcv_status::timeout
が返る。そうでない場合はcv_status::no_timeout
が返る。
- (2) :
return wait_until(lock, chrono::steady_clock::now() + rel_time, std::move(pred));
pred()
が最初からtrue
の場合、またはすでに期限が過ぎている場合、この関数はブロッキングしない
事後条件
lock.owns_lock() == true
であることlock
が参照しているミューテックスオブジェクトが、この関数を呼び出したスレッドでロック取得されていること
例外
- C++11 : この関数は、
lock.lock()
およびlock.unlock()
によって送出されうる、あらゆる例外が送出される可能性がある。 - C++14 : 時計クラス、
time_point
クラス、duration
クラスの構築が例外を送出する場合、この関数はそれらの例外を送出する。
備考
- C++14 : 事後条件を満たさない場合、
std::terminate()
関数を呼び出して、プログラムを異常終了させる。これは、ミューテックスの再ロック取得が例外を送出した場合に発生する。
例
#include <iostream>
#include <condition_variable>
#include <mutex>
#include <thread>
#include <chrono>
namespace chrono = std::chrono;
struct ProcessData {
std::mutex mtx_;
std::condition_variable cond_;
bool data_ready_ = false;
public:
// 処理に必要なデータの準備をする
void prepare_data_for_processing()
{
// ...準備処理...
{
std::lock_guard<std::mutex> lk(mtx_);
data_ready_ = true;
}
// 準備完了したので待機スレッドを全て起床させる
cond_.notify_all();
}
void wait_for_data_to_process1()
{
std::unique_lock<std::mutex> lk(mtx_);
// データの準備ができるまで待機してから処理する
while (!data_ready_) {
// 述語を指定しないバージョン
// 3秒でタイムアウト
std::cv_status result = cond_.wait_for(lk, chrono::seconds(3));
if (result == std::cv_status::timeout) {
std::cout << "wait_for_data_to_process1 : timeout" << std::endl;
return;
}
}
process_data();
}
void wait_for_data_to_process2()
{
std::unique_lock<std::mutex> lk(mtx_);
// データの準備ができるまで待機してから処理する
// 述語を指定するバージョン
// 3秒でタイムアウト
if (!cond_.wait_for(lk, chrono::seconds(3), [this] { return data_ready_; })) {
// data_ready == false
std::cout << "data is not ready" << std::endl;
return;
}
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
バージョン
言語
- C++11
処理系
- Clang: ??
- GCC: 4.7.0 ✅
- ICC: ??
- Visual C++: 2012 ✅, 2013 ✅