Namespaces
Variants

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

From cppreference.net
C++
Standard library headers

このヘッダは スレッドサポート ライブラリの一部です。

目次

クラス

(C++20)
std::jthread のキャンセル要求が行われたかどうかを問い合わせるためのインターフェース
(クラス)
(C++20)
1つまたは複数の 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)
指定されたストップトークン型に対するコールバック型を取得する
(エイリアステンプレート)

Concepts

(C++26)
停止要求の問い合わせと停止要求が可能かどうかの確認を許可するストップトークンの基本インターフェースを指定する
(コンセプト)
(C++26)
停止を許可しないストップトークンを指定する
(concept)

タグ

(C++20)
stop_source が構築時に停止状態を持たないことを示すために使用されるタグ
(タグ)

概要 

namespace std {
  // 停止トークンコンセプト
  template<class CallbackFn, class Token, class Init = CallbackFn>
    concept /*stoppable-callback-for*/ = /* see description */; // 説明専用
  template<class Token>
    concept stoppable_token = /* see description */;
  template<class Token>
    concept unstoppable_token = /* see description */;
  template<class Source>
    concept /*stoppable-source*/ = /* see description */; // 説明専用
  // クラス 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>;
}

Stopトークンコンセプト 

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>;
}