◐ Shell
clean mode source ↗

std::condition_variable::wait - cppreference.com

提供: cppreference.com

<tbody> </tbody>

void wait( std::unique_lock<std::mutex>& lock );

 (1) (C++11以上)

template< class Predicate > void wait( std::unique_lock<std::mutex>& lock, Predicate pred );

 (2) (C++11以上)

条件変数が通知されるか spurious wakeup が発生するまで現在のスレッドをブロックします。 オプションで何らかの述語が満たされるまでループします。

1) アトミックに、 lock のロックを解除し、現在実行中のスレッドをブロックし、 *this の待機中スレッドのリストに追加します。 notify_all() または notify_one() が実行されると、スレッドのブロックは解除されます。 spurious にブロック解除される可能性もあります。 ブロックが解除されると、その理由にかかわらず、 lock が再取得され、 wait を抜けます。 例外によってこの関数を抜ける場合も、 lock は再取得されます。 (C++14未満)

2) 以下と同等です。 

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

特定の条件が true になるのを待つ間 spurious wakeup を無視するためにこのオーバーロードを使用することができます。

この関数に入る前に lock を取得していなければならず、 wait(lock) を抜けた後に再取得されていることに注意してください。 つまり、 lock は pred() へのアクセスを保護するために使用することができます。

これらの関数が事後条件 (lock.owns_lock()==true であり、 lock.mutex() が呼び出し元スレッドによってロックされている) を満たせない場合は、 std::terminate が呼ばれます。 例えば、ミューテックスの再取得で例外が投げられると、これが発生し得ます。

(C++14以上)

引数

lock - std::unique_lock<std::mutex> 型のオブジェクト。 現在のスレッドによってロックされていなければなりません
pred - 待機を続けるべき場合に ​false を返す述語。

述語関数のシグネチャは以下と同等であるべきです。

bool pred();​

戻り値

(なし)

例外

2) (1) と同様ですが、 pred によって投げられた例外を伝搬する場合もあります。

ノート

lock.mutex() が現在のスレッドによってロックされていない場合、この関数の呼び出しは未定義動作です。

lock.mutex() が同じ条件変数で現在待機している他のすべてのスレッドが使用しているミューテックスと同じでない場合、この関数の呼び出しは未定義動作です。

notify_one()/notify_all() および wait()/wait_for()/wait_until() の3つのアトミック部分 (unlock+wait、wakeup、lock) 各々の効果は、アトミック変数の変更順序として考えることができる単一の全順序で行われます。 この順序は個々の条件変数に固有です。 これにより、例えば notify_one() が遅延され、 notify_one() の呼び出しの後に待機を開始したスレッドをブロック解除することは、ありえなくなります。

例

#include <iostream>
#include <condition_variable>
#include <thread>
#include <chrono>

std::condition_variable cv;
std::mutex cv_m; // This mutex is used for three purposes:
                 // 1) to synchronize accesses to i
                 // 2) to synchronize accesses to std::cerr
                 // 3) for the condition variable 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

関連項目