std::condition_variable_any::wait_until
template< class Lock, class Clock, class Duration >
std::cv_status
wait_until( Lock& lock,
const std::chrono::time_point<Clock, Duration>& abs_time );
| (1) | (начиная с C++11) |
template< class Lock, class Clock, class Duration, class Predicate >
bool wait_until( Lock& lock,
const std::chrono::time_point<Clock, Duration>& abs_time,
Predicate pred );
| (2) | (начиная с C++11) |
template< class Lock, class Clock, class Duration, class Predicate >
bool wait_until( Lock& lock, std::stop_token stoken,
const std::chrono::time_point<Clock, Duration>& abs_time,
Predicate pred );
| (3) | (начиная с C++20) |
wait_until переводит текущий поток в состояние ожидания, пока переменная условия не будет уведомлена, не истечёт заданный интервал времени или не произойдёт ложное пробуждение. pred можно передать, чтобы обнаруживать ложные пробуждения.
lock.unlock() и блокируется на *this.notify_all() или notify_one() либо при наступлении abs_time. Также возможно ложное пробуждение.lock.lock() (возможно, блокируясь на мьютексе), а затем возвращает управление.while (!pred())if (wait_until(lock, abs_time) == std::cv_status::timeout)return pred();return true;.*this, чтобы получить уведомление при отправке запроса остановки для связанного с stoken состояния остановки; в этом случае эквивалентно while (!stoken.stop_requested()){if (pred())return true;if (wait_until(lock, abs_time) == std::cv_status::timeout)return pred();}return pred();.Сразу после возврата wait_until lock заблокирован вызывающим потоком. Если это постусловие не может быть выполнено[1], вызывается std::terminate.
- Это может произойти, если повторная блокировка мьютекса приводит к исключению.
Параметры
| lock | - | мьютекс, который должен быть заблокирован вызывающим потоком |
| stoken | - | токен остановки для регистрации прерывания |
| abs_time | - | момент времени, при наступлении которого ожидание истекает |
| pred | - | предикат для проверки возможности завершения ожидания |
| Требования к типам | ||
-Lock должен соответствовать требованиям BasicLockable. |
||
-Predicate должен соответствовать требованиям FunctionObject. |
||
-pred() должно быть допустимым выражением, а его тип и категория значения должны соответствовать требованиям BooleanTestable. |
||
Возвращаемое значение
std::cv_status::timeout, если наступил момент abs_time, в противном случае — std::cv_status::no_timeout.pred() перед возвратом управления вызывающему коду.Исключения
pred.Примечания
Стандарт рекомендует использовать часы, связанные с abs_time, для измерения времени; эти часы не обязаны быть монотонными. Поведение этой функции при скачкообразном изменении часов не гарантируется, однако существующие реализации преобразуют abs_time из Clock в std::chrono::system_clock и передают управление функции POSIX pthread_cond_timedwait, чтобы ожидание учитывало изменения системных часов, но не изменения заданных пользователем Clock. В любом случае из-за задержек планирования или конкуренции за ресурсы функция может ожидать и после наступления abs_time.
Даже если используемые часы — std::chrono::steady_clock или другие монотонные часы, изменение системных часов может вызвать ложное пробуждение.
Эффекты 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_any 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 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_any/wait_until