std::condition_variable::wait_for
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 можно указать, чтобы обнаруживать ложные пробуждения.
return wait_until(lock, std::chrono::steady_clock::now() + rel_time);.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.
- Это может произойти, если повторная блокировка мьютекса приводит к исключению.
Параметры
| lock | - | мьютекс, который должен быть заблокирован вызывающим потоком |
| rel_time | - | максимальное время ожидания |
| pred | - | предикат для проверки возможности завершить ожидание |
| Требования к типам | ||
-Predicate должен соответствовать требованиям FunctionObject. |
||
-pred() должно быть корректным выражением, а его тип и категория значения должны соответствовать требованиям BooleanTestable. |
||
Возвращаемое значение
std::cv_status::timeout, если с начала этого вызова истекло rel_time, иначе std::cv_status::no_timeout.pred() перед возвратом вызывающему коду.Исключения
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; // 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++.
| Отчёт об ошибке | Применяется к | Опубликованное поведение | Исправленное поведение |
|---|---|---|---|
| LWG 2093 | C++11 | в спецификации отсутствовали исключения, связанные с тайм-аутом | упоминает эти исключения |
|
LWG 2114 (P2167R3) | C++11 | требование преобразуемости в bool было недостаточно строгим, чтобы отражать ожидания реализаций | требования усилены |
| LWG 2135 | C++11 | поведение было неясным, если lock.lock() выбрасывает исключение | в этом случае вызывается std::terminate |
См. также
| блокирует текущий поток до пробуждения условной переменной (открытая функция-член) |
|
| блокирует текущий поток до пробуждения условной переменной или наступления указанного момента времени (открытая функция-член) |
© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://en.cppreference.com/cpp/thread/condition_variable/wait_for