33 Thread support library [thread]

33.5 Condition variables [thread.condition]

33.5.4 Class condition_­variable_­any [thread.condition.condvarany]

Lock Типа должны отвечать BasicLockable требованиям. [ Note: Все стандартные типы мьютексов соответствуют этому требованию. Если используетсяLock тип, отличный от одного из стандартных типов мьютекса илиunique_­lock оболочки для стандартного типа мьютексаcondition_­variable_­any, пользователь должен убедиться, что вся необходимая синхронизация выполняется по отношению к предикату, связанному сcondition_­variable_­any экземпляром. ]end note

namespace std {
  class condition_variable_any {
  public:
    condition_variable_any();
    ~condition_variable_any();

    condition_variable_any(const condition_variable_any&) = delete;
    condition_variable_any& operator=(const condition_variable_any&) = delete;

    void notify_one() noexcept;
    void notify_all() noexcept;
    template <class Lock>
      void wait(Lock& lock);
    template <class Lock, class Predicate>
      void wait(Lock& lock, Predicate pred);

    template <class Lock, class Clock, class Duration>
      cv_status wait_until(Lock& lock, const chrono::time_point<Clock, Duration>& abs_time);
    template <class Lock, class Clock, class Duration, class Predicate>
      bool wait_until(Lock& lock, const chrono::time_point<Clock, Duration>& abs_time,
        Predicate pred);
    template <class Lock, class Rep, class Period>
      cv_status wait_for(Lock& lock, const chrono::duration<Rep, Period>& rel_time);
    template <class Lock, class Rep, class Period, class Predicate>
      bool wait_for(Lock& lock, const chrono::duration<Rep, Period>& rel_time,
        Predicate pred);
  };
}

condition_variable_any();

Effects: Создает объект типаcondition_­variable_­any.

Throws:bad_­alloc илиsystem_­error когда требуется исключение ([thread.req.exception]).

Error conditions:

  • resource_­unavailable_­try_­again - если какое-то ограничение ресурсов, не связанных с памятью, препятствует инициализации.

  • operation_­not_­permitted - если поток не имеет права выполнять операцию.

~condition_variable_any();

Requires: Не должно быть блокировок резьбы*this. [ Note: То есть все потоки должны быть уведомлены; впоследствии они могут заблокировать блокировку, указанную в ожидании. Это ослабляет обычные правила, которые требовали бы, чтобы все вызовы ожидания выполнялись до уничтожения. Только уведомление для разблокировки ожидания должно произойти до уничтожения. Пользователь должен позаботиться о том, что ни один из потоков не ждать*this когда был запущен деструктор, особенно когда ожидающие потоки вызова функции ожидания в цикле или с использованием перегрузокwait,wait_­forилиwait_­until что взять предикат. ]end note

Effects: Разрушает объект.

void notify_one() noexcept;

Effects: Если какие-либо потоки заблокированы в ожидании*this, разблокирует один из этих потоков.

void notify_all() noexcept;

Effects: Разблокирует все потоки, которые заблокированы в ожидании*this.

template <class Lock> void wait(Lock& lock);

[ Note: Если какая-либо изwait функций завершается через исключение, не указывается,Lock удерживается ли она. Можно использоватьLock тип, который позволяет запрашивать это, напримерunique_­lock оболочку. ]end note

Effects:

  • Атомарно звонитlock.unlock() и блокируется*this.

  • При разблокировке вызываетlock.lock() (возможно, блокировку по блокировке) и возвращает.

  • Функция разблокируется при получении сигнала от вызоваnotify_­one(), вызоваnotify_­all()или ложного сигнала .

Remarks: Если функция не удовлетворяет постусловию,terminate() должна быть вызвана ([except.terminate]). [ Note: Это может произойти, если повторная блокировка мьютекса вызывает исключение. ]end note

Postconditions:lock заблокирован вызывающим потоком.

Throws: Ничего такого.

template <class Lock, class Predicate> void wait(Lock& lock, Predicate pred);

Effects: Эквивалентен:

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

template <class Lock, class Clock, class Duration> cv_status wait_until(Lock& lock, const chrono::time_point<Clock, Duration>& abs_time);

Effects:

  • Атомарно звонитlock.unlock() и блокируется*this.

  • При разблокировке вызываетlock.lock() (возможно, блокировку по блокировке) и возвращает.

  • Функция разблокируется при получении сигнала от вызоваnotify_­one(), вызоваnotify_­all(), истечения абсолютного тайм-аута ([thread.req.timing]), указанного с помощьюabs_­time, или ложно.

  • Если функция завершается через исключение, онаlock.lock() должна вызываться до выхода из функции.

Remarks: Если функция не удовлетворяет постусловию,terminate() должна быть вызвана ([except.terminate]). [ Note: Это может произойти, если повторная блокировка мьютекса вызывает исключение. ]end note

Postconditions:lock заблокирован вызывающим потоком.

Returns:cv_­status​::​timeout если истек абсолютный тайм-аут ([thread.req.timing]), указанный вabs_­time , в противном случаеcv_­status​::​no_­timeout.

Throws: Исключения, связанные с тайм-аутом ([thread.req.timing]).

template <class Lock, class Rep, class Period> cv_status wait_for(Lock& lock, const chrono::duration<Rep, Period>& rel_time);

Effects: Эквивалентен:

return wait_until(lock, chrono::steady_clock::now() + rel_time);

Returns:cv_­status​::​timeout если истек относительный тайм-аут ([thread.req.timing]), указанный вrel_­time , в противном случаеcv_­status​::​no_­timeout.

Remarks: Если функция не удовлетворяет постусловию,terminate() должна быть вызвана ([except.terminate]). [ Note: Это может произойти, если повторная блокировка мьютекса вызывает исключение. ]end note

Postconditions:lock заблокирован вызывающим потоком.

Throws: Исключения, связанные с тайм-аутом ([thread.req.timing]).

template <class Lock, class Clock, class Duration, class Predicate> bool wait_until(Lock& lock, const chrono::time_point<Clock, Duration>& abs_time, Predicate pred);

Effects: Эквивалентен:

while (!pred())
  if (wait_until(lock, abs_time) == cv_status::timeout)
    return pred();
return true;

[ Note: Блокировка отсутствует, еслиpred() она установлена ​​изначальноtrueили если время ожидания уже истекло. ]end note

[ Note: Возвращенное значение указывает, оценивается ли предикатtrue независимо от того, был ли установлен тайм-аут. ] end note

template <class Lock, class Rep, class Period, class Predicate> bool wait_for(Lock& lock, const chrono::duration<Rep, Period>& rel_time, Predicate pred);

Effects: Эквивалентен:

return wait_until(lock, chrono::steady_clock::now() + rel_time, std::move(pred));