Namespaces
Variants

Standard library header <stop_token> (C++20)

From cppreference.net
C++
Standard library headers

Этот заголовок является частью библиотеки поддержки потоков .

Содержание

Классы

(C++20)
интерфейс для проверки, был ли отправлен запрос на отмену std::jthread
(класс)
(C++20)
класс, представляющий запрос на остановку одного или нескольких std::jthread
(класс)
(C++20)
интерфейс для регистрации колбэков при отмене std::jthread
(шаблон класса)
(C++26)
предоставляет интерфейс токена остановки, при котором остановка никогда не возможна и не запрашивается
(класс)
(C++26)
токен остановки, который ссылается на состояние остановки своего ассоциированного std::inplace_stop_source объекта
(класс)
(C++26)
stoppable-source , который является единственным владельцем состояния остановки
(класс)
(C++26)
колбэк остановки для std::inplace_stop_token
(шаблон класса)

Шаблоны псевдонимов

(C++26)
получает тип callback для заданного типа stop token
(псевдоним шаблона)

Концепции

(C++26)
определяет базовый интерфейс токенов остановки, который позволяет выполнять запросы на остановку и проверять возможность запроса остановки
(concept)
(C++26)
задает токен остановки, который не позволяет остановку
(концепт)

Теги

(C++20)
тег, используемый для stop_source для указания отсутствия связанного состояния остановки при создании
(тег)

Синопсис 

namespace std {
  // концепции stop token
  template<class CallbackFn, class Token, class Init = CallbackFn>
    concept /*stoppable-callback-for*/ = /* см. описание */; // только для экспозиции
  template<class Token>
    concept stoppable_token = /* см. описание */;
  template<class Token>
    concept unstoppable_token = /* см. описание */;
  template<class Source>
    concept /*stoppable-source*/ = /* см. описание */; // только для экспозиции
  // класс stop_token
  class stop_token;
  // класс stop_source
  class stop_source;
  // индикатор отсутствия общего состояния остановки
  struct nostopstate_t {
    explicit nostopstate_t() = default;
  };
  inline constexpr nostopstate_t nostopstate{};
  // шаблон класса stop_callback
  template<class Callback>
  class stop_callback;
  // класс never_stop_token
  class never_stop_token;
  // класс inplace_stop_token
  class inplace_stop_token;
  // класс inplace_stop_source
  class inplace_stop_source;
  // шаблон класса inplace_stop_callback
  template<class CallbackFn>
    class inplace_stop_callback;
  template<class T, class CallbackFn>
    using stop_callback_for_t = T::template callback_type<CallbackFn>;
}

Концепции стоп-токена 

namespace std {
  template<class CallbackFn, class Token, class Init = CallbackFn>
    concept /*stoppable-callback-for*/ =                         // только для пояснения
      invocable<CallbackFn> &&
      constructible_from<CallbackFn, Init> &&
      requires { typename stop_callback_for_t<Token, CallbackFn>; } &&
      constructible_from<stop_callback_for_t<Token, CallbackFn>, const Token&, Init>;
  template<template<class> class>
    struct /*check-type-alias-exists*/;                          // только для пояснения
  template<class Token>
    concept stoppable_token = 
      requires (const Token tok) {
        typename /*check-type-alias-exists*/<Token::template callback_type>;
        { tok.stop_requested() } noexcept -> same_as<bool>;
        { tok.stop_possible() } noexcept -> same_as<bool>;
        { Token(tok) } noexcept; // см. вариации неявных выражений
      } &&
      copyable<Token> &&
      equality_comparable<Token>;
  template<class Token>
    concept unstoppable_token = 
      stoppable_token<Token> &&
      requires (const Token tok) {
        requires bool_constant<(!tok.stop_possible())>::value;
      };
  template<class Source>
    concept /*stoppable-source*/ =                               // только для пояснения
      requires (Source& src, const Source csrc) {
        { csrc.get_token() } -> stoppable_token;
        { csrc.stop_possible() } noexcept -> same_as<bool>;
        { csrc.stop_requested() } noexcept -> same_as<bool>;
        { src.request_stop() } -> same_as<bool>;
      };
}

Класс std::stop_token 

namespace std {
  class stop_token {
  public:
    template<class CallbackFn>
      using callback_type = stop_callback<CallbackFn>;
    // конструкторы, копирование и присваивание
    stop_token() noexcept = default;
    // функции-члены
    void swap(stop_token&) noexcept;
    // обработка остановки
    bool stop_requested() const noexcept;
    bool stop_possible() const noexcept;
    friend bool operator==(const stop_token& lhs, const stop_token& rhs) noexcept;
    friend void swap(stop_token& lhs, stop_token& rhs) noexcept;
  private:
    shared_ptr</*unspecified*/> stop_state_; // только для демонстрации
  };
}

Класс std::stop_source 

namespace std {
  class stop_source {
  public:
    // конструкторы, копирование и присваивание
    stop_source();
    explicit stop_source(nostopstate_t) noexcept {}
    // функции-члены
    void swap(stop_source&) noexcept;
    // обработка остановки
    stop_token get_token() const noexcept;
    bool stop_possible() const noexcept;
    bool stop_requested() const noexcept;
    bool request_stop() noexcept;
    friend bool
    operator==(const stop_source& lhs, const stop_source& rhs) noexcept;
    friend void swap(stop_source& lhs, stop_source& rhs) noexcept;
  private:
    shared_ptr</*unspecified*/> stop_state_; // только для демонстрации
  };
}

Шаблон класса std::stop_callback 

namespace std {
  template<class CallbackFn>
  class stop_callback {
  public:
    using callback_type = CallbackFn;
    // конструкторы и деструктор
    template<class Init>
    explicit stop_callback(const stop_token& st, Init&& init)
        noexcept(is_nothrow_constructible_v<CallbackFn, Init>);
    template<class Init>
    explicit stop_callback(stop_token&& st, Init&& init)
        noexcept(is_nothrow_constructible_v<CallbackFn, Init>);
    ~stop_callback();
    stop_callback(const stop_callback&) = delete;
    stop_callback(stop_callback&&) = delete;
    stop_callback& operator=(const stop_callback&) = delete;
    stop_callback& operator=(stop_callback&&) = delete;
  private:
    CallbackFn callback_fn_;      // только для демонстрации
  };
  template<class CallbackFn>
  stop_callback(stop_token, CallbackFn) -> stop_callback<CallbackFn>;
}

Шаблон класса std::never_stop_token 

namespace std {
  class never_stop_token {
    struct /*callback-type*/ {       // только для демонстрации
      explicit /*callback-type*/(never_stop_token, auto&&) noexcept {}
    };
  public:
    template<class>
      using callback_type = /*callback-type*/;
    static constexpr bool stop_requested() noexcept { return false; }
    static constexpr bool stop_posible() noexcept { return false; }
    bool operator==(const never_stop_token&) const = default;
  };
}

Шаблон класса std::inplace_stop_token 

namespace std {
  class inplace_stop_token {
  public:
    template<class CallbackFn>
      using callback_type = inplace_stop_callback<CallbackFn>;
    inplace_stop_token() = default;
    bool operator==(const inplace_stop_token&) const = default;
    // функции-члены
    bool stop_requested() const noexcept;
    bool stop_possible() const noexcept;
    void swap(inplace_stop_token&) noexcept;
  private:
    const inplace_stop_source* stop_source_ = nullptr; // только для демонстрации
  };
}

Шаблон класса std::inplace_stop_source 

namespace std {
  class inplace_stop_source {
    // конструкторы, присваивания и деструктор
    constexpr inplace_stop_source() noexcept;
    inplace_stop_source(inplace_stop_source&&) = delete;
    inplace_stop_source(const inplace_stop_source&) = delete;
    inplace_stop_source& operator=(inplace_stop_source&&) = delete;
    inplace_stop_source& operator=(const inplace_stop_source&) = delete;
    ~inplace_stop_source();
    // обработка остановки
    constexpr inplace_stop_token get_token() const noexcept;
    static constexpr bool stop_possible() noexcept { return true; }
    bool stop_requested() const noexcept;
    bool request_stop() noexcept;
  };
}

Шаблон класса std::inplace_stop_callback 

namespace std {
  template<class CallbackFn>
  class inplace_stop_callback {
  public:
    using callback_type = CallbackFn;
    // конструкторы и деструктор
    template<class Init>
    explicit inplace_stop_callback(inplace_stop_token st, Init&& init)
        noexcept(is_nothrow_constructible_v<CallbackFn, Init>);
    ~inplace_stop_callback();
    inplace_stop_callback(const inplace_stop_callback&) = delete;
    inplace_stop_callback(inplace_stop_callback&&) = delete;
    inplace_stop_callback& operator=(const inplace_stop_callback&) = delete;
    inplace_stop_callback& operator=(inplace_stop_callback&&) = delete;
  private:
    CallbackFn callback_fn_;      // только для демонстрации
  };
  template<class CallbackFn>
  inplace_stop_callback(inplace_stop_token, CallbackFn) 
    -> inplace_stop_callback<CallbackFn>;
}