Namespaces
Variants

std::condition_variable:: wait_for

From cppreference.net
Concurrency support library
Threads
(C++11)
(C++20)
this_thread namespace
(C++11)
(C++11)
Cooperative cancellation
Mutual exclusion
Generic lock management
Condition variables
(C++11)
Semaphores
Latches and Barriers
(C++20)
(C++20)
Futures
(C++11)
(C++11)
(C++11)
Safe reclamation
Hazard pointers
Atomic types
(C++11)
(C++20)
Initialization of atomic types
(C++11) (deprecated in C++20)
(C++11) (deprecated in C++20)
Memory ordering
(C++11) (deprecated in C++26)
Free functions for atomic operations
Free functions for atomic flags
template < class Rep, class Period >

std:: cv_status wait_for ( std:: unique_lock < std:: mutex > & lock,

const std:: chrono :: duration < Rep, Period > & rel_time ) ;
(1) (начиная с C++11)
template < class Rep, class Period, class Predicate >

bool wait_for ( std:: unique_lock < std:: mutex > & lock,
const std:: chrono :: duration < Rep, Period > & rel_time,

Predicate pred ) ;
(2) (начиная с C++11)

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

1) Эквивалентно return wait_until ( lock, std:: chrono :: steady_clock :: now ( ) + rel_time ) ; .
2) Эквивалентно return wait_until ( lock, std:: chrono :: steady_clock :: now ( ) + rel_time, std :: move ( pred ) ) ; .
Эта перегрузка может использоваться для игнорирования ложных пробуждений при ожидании выполнения определенного условия.

Сразу после возврата из wait_for , 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 - блокировка, которая должна быть захвачена вызывающим потоком
rel_time - максимальное время ожидания
pred - предикат для проверки возможности завершения ожидания
Требования к типам
-
Predicate должен удовлетворять требованиям FunctionObject .
-
pred ( ) должно быть валидным выражением, а его тип и категория значения должны удовлетворять требованиям BooleanTestable .

Возвращаемое значение

1) std:: cv_status :: timeout если rel_time истек с начала вызова, иначе std:: cv_status :: no_timeout .
2) Последний результат pred ( ) перед возвратом к вызывающей стороне.

Исключения

1) Исключения, связанные с таймаутом.
2) Исключения, связанные с таймаутом, и любые исключения, выбрасываемые pred .

Примечания

Даже при уведомлении под блокировкой, перегрузка (1) не дает никаких гарантий относительно состояния связанного предиката при возврате из-за таймаута.

Эффекты 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; // Этот мьютекс используется для трёх целей:
                 // 1) для синхронизации доступа к i
                 // 2) для синхронизации доступа к std::cerr
                 // 3) для переменной условия 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 2093 C++11 исключения, связанные с таймаутом, отсутствовали в спецификации упоминает эти исключения
LWG 2114
( P2167R3 )
C++11 конвертируемость в bool была слишком слабой для отражения ожиданий реализаций требования усилены
LWG 2135 C++11 поведение было неясным, если lock. lock ( ) выбрасывает исключение вызывает std::terminate в этом случае

Смотрите также

блокирует текущий поток до тех пор, пока условная переменная не будет пробуждена
(public member function)
блокирует текущий поток до тех пор, пока условная переменная не будет пробуждена или не будет достигнута указанная точка времени
(public member function)