Spec-Zone.ru › C++

std::condition_variable::wait

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)

wait блокирует текущий поток до тех пор, пока условная переменная не будет уведомлена или не произойдёт ложное пробуждение. pred можно предоставить, чтобы обнаруживать ложные пробуждения.

1) Атомарно вызывает lock.unlock() и блокируется на *this.
Поток будет разблокирован при выполнении notify_all() или notify_one(). Он также может быть разблокирован ложно.
После разблокировки вызывает lock.lock() (возможно, блокируясь на мьютексе), а затем возвращает управление.
2) Эквивалентно
while (!pred())wait(lock);.
Эту перегрузку можно использовать, чтобы игнорировать ложные пробуждения в ожидании того, когда определённое условие станет true.

Сразу после возврата wait, lock.owns_lock() имеет значение true, а lock.mutex() заблокирован вызывающим потоком. Если эти постусловия не могут быть выполнены[1], вызывается std::terminate.

Поведение не определено, если выполняется любое из следующих условий:

  • lock.owns_lock() имеет значение false.
  • lock.mutex() не заблокирован вызывающим потоком.
  • Если другие потоки также ожидают на *this, lock.mutex() отличается от мьютекса, разблокированного функциями ожидания (wait, wait_for и wait_until), вызванными этими потоками для *this.
  1. Это может произойти, если повторная блокировка мьютекса приводит к исключению.

Параметры

lock - мьютекс, который должен быть заблокирован вызывающим потоком
pred - предикат для проверки возможности завершения ожидания
Требования к типам
-Predicate должен соответствовать требованиям FunctionObject.
-pred() должно быть допустимым выражением, а его тип и категория значения должны соответствовать требованиям BooleanTestable.

Исключения

1) Ничего не выбрасывает.
2) Любое исключение, выброшенное pred.

Примечания

Эффекты notify_one()/notify_all() и каждой из трёх атомарных частей wait()/wait_for()/wait_until() (разблокировка+ожидание, пробуждение и блокировка) происходят в едином общем порядке, который можно рассматривать как порядок модификации атомарной переменной: этот порядок специфичен для данной условной переменной. Благодаря этому notify_one(), например, не может задержаться и разблокировать поток, начавший ожидание сразу после вызова notify_one().

Пример

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

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

Отчёты об ошибках

Следующие отчёты об ошибках, изменяющие поведение, были ретроактивно применены к ранее опубликованным стандартам C++.

DR Применение к Поведение согласно опубликованной версии Исправленное поведение
LWG 2114
(P2167R3)
C++11 преобразуемость в bool была недостаточно строгой, чтобы отражать ожидания реализаций требования усилены
LWG 2135 C++11 поведение было не определено, если lock.lock() выбрасывает исключение в этом случае вызывается std::terminate

См. также

wait_for
блокирует текущий поток до пробуждения условной переменной или истечения указанного интервала времени
(открытая функция-член)
wait_until
блокирует текущий поток до пробуждения условной переменной или наступления указанного момента времени
(открытая функция-член)
Документация C для cnd_wait

Внешние ссылки

Статья The Old New Thing: ложные пробуждения в условных переменных Win32.

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/cpp/thread/condition_variable/wait

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API