Skip to content

schedule_from.md

Latest commit

 

History

History
232 lines (186 loc) · 10.2 KB

schedule_from.md

File metadata and controls

232 lines (186 loc) · 10.2 KB

schedule_from

  • execution[meta header]
  • cpo[meta id-type]
  • std::execution[meta namespace]
  • cpp26[meta cpp]
namespace std::execution {
  struct schedule_from_t { unspecified };
  inline constexpr schedule_from_t schedule_from{};
}
  • unspecified[italic]

概要

schedule_fromは、Senderの完了に依存する作業をSchedulerに関連付けられた実行リソースにスケジュールするSenderアダプタである。

schedule_fromはユーザコードで利用されるものではなく、continues_onSenderアルゴリズムの実装において利用される。

効果

説明用の式schとsndrに対して、decltype((sch))がschedulerを満たさない、もしくはdecltype((sndr))がsenderを満たさないとき、呼び出し式schedule_from(sch, sndr)は不適格となる。

そうでなければ、呼び出し式schedule_from(sch, sndr)はschが1回だけ評価されることを除いて、下記と等価。

transform_sender(
  query-with-default(get_domain, sch, default_domain()),
  make-sender(schedule_from, sch, sndr))
  • transform_sender[link transform_sender.md]
  • query-with-default[link query-with-default.md]
  • get_domain[link get_domain.md]
  • default_domain()[link default_domain.md]
  • make-sender[link make-sender.md]

Senderアルゴリズムタグ schedule_from

Senderアルゴリズム動作説明用のクラステンプレートimpls-forに対して、下記の特殊化が定義される。

namespace std::execution {
  template<>
  struct impls-for<schedule_from_t> : default-impls {
    static constexpr auto get-attrs = see below;
    static constexpr auto get-state = see below;
    static constexpr auto complete = see below;

    template<class Sndr, class... Env>
    static consteval void check-types();
  };
}
  • impls-for[link impls-for.md]
  • default-impls[link impls-for.md]

impls-for<schedule_from_t>::get-attrsメンバは、下記ラムダ式と等価な関数呼び出し可能なオブジェクトで初期化される。

[](const auto& data, const auto& child) noexcept -> decltype(auto) {
  return JOIN-ENV(SCHED-ATTRS(data), FWD-ENV(get_env(child)));
}
  • JOIN-ENV[link ../queryable.md]
  • SCHED-ATTRS[link scheduler.md]
  • FWD-ENV[link ../forwarding_query.md]
  • get_env[link get_env.md]

impls-for<schedule_from_t>::get-stateメンバは、下記ラムダ式と等価な関数呼び出し可能なオブジェクトで初期化される。

[]<class Sndr, class Rcvr>(Sndr&& sndr, Rcvr& rcvr) noexcept(see below)
    requires sender_in<child-type<Sndr>, FWD-ENV-T(env_of_t<Rcvr>)> {

  auto& [_, sch, child] = sndr;

  using sched_t = decltype(auto(sch));
  using variant_t = see below;
  using receiver_t = see below;
  using operation_t = connect_result_t<schedule_result_t<sched_t>, receiver_t>;
  constexpr bool nothrow = noexcept(connect(schedule(sch), receiver_t{nullptr}));

  struct state-type {
    Rcvr& rcvr;                 // exposition only
    variant_t async-result;     // exposition only
    operation_t op-state;       // exposition only

    explicit state-type(sched_t sch, Rcvr& rcvr) noexcept(nothrow)
      : rcvr(rcvr), op-state(connect(schedule(sch), receiver_t{this})) {}
  };

  return state-type{sch, rcvr};
}
  • sender_in[link sender_in.md]
  • child-type[link child-type.md]
  • FWD-ENV-T[link ../forwarding_query.md]
  • env_of_t[link env_of_t.md]
  • connect_result_t[link connect_result_t.md]
  • schedule_result_t[link schedule_result_t.md]
  • connect[link connect.md]
  • schedule[link schedule.md]

  • ローカルクラスstate-typeのオブジェクトは構造化束縛における初期化子として利用できる。

  • 説明用のパックSigsをcompletion_signatures_of_t<child-type<Sndr>, FWD-ENV-T(env_of_t<Rcvr>)>によるcompletion_signatures特殊化のテンプレートパラメータと定義する。説明用のエイリアステンプレートas-tuple<Tag(Args...)>をdecayed-tuple<Tag, Args...>と定義し、説明用の変数テンプレートis-nothrow-decay-copy-sig<Tag(Args...)>を型Args...が全て例外送出せずdecayコピー可能ならば値true、そうでなければfalseとなるbool const型のコア定数式と定義する。説明用のパックerror-completionを、(is-nothrow-decay-copy-sig<Sigs> &&...)がfalseならばset_error_t(exception_ptr)、そうでなければ空のパックと定義する。型variant_tは下記定義において重複削除した型となる。

    variant<monostate, as-tuple<Sigs>..., error-completion...>
    • variant[link /reference/variant/variant.md]
    • monostate[link /reference/variant/monostate.md]

  • receiver_tは説明専用クラスreceiver-typeのエイリアスとする。

impls-for<schedule_from_t>::completeメンバは、下記ラムダ式と等価な関数呼び出し可能なオブジェクトで初期化される。

[]<class Tag, class... Args>(auto, auto& state, auto& rcvr, Tag, Args&&... args) noexcept
    -> void {
  using result_t = decayed-tuple<Tag, Args...>;
  constexpr bool nothrow = (is_nothrow_constructible_v<decay_t<Args>, Args> && ...);

  try {
    state.async-result.template emplace<result_t>(Tag(), std::forward<Args>(args)...);
  } catch (...) {
    if constexpr (!nothrow)
      state.async-result.template emplace<tuple<set_error_t, exception_ptr>>(set_error, current_exception());
  }
  start(state.op-state);
};
  • decayed-tuple[link decayed-tuple.md]
  • set_error[link set_error.md]
  • start[link start.md]
  • is_nothrow_constructible_v[link /reference/type_traits/is_nothrow_constructible.md]
  • template emplace[link /reference/variant/variant/emplace.md]
  • set_error_t[link set_error.md]
  • exception_ptr[link /reference/exception/exception_ptr.md]
  • current_exception()[link /reference/exception/current_exception.md]

メンバ関数impls-for<schedule_from_t>::check-typesの効果は下記の通り。

get_completion_signatures<schedule_result_t<data-type<Sndr>>, FWD-ENV-T(Env)...>();
auto cs = get_completion_signatures<child-type<Sndr>, FWD-ENV-T(Env)...>();
decay-copyable-result-datums(cs);
  • get_completion_signatures[link get_completion_signatures.md]
  • schedule_result_t[link schedule_result_t.md]
  • data-type[link data-type.md]
  • FWD-ENV-T[link ../forwarding_query.md]
  • decay-copyable-result-datums[link decay-copyable-result-datums.md]

説明専用エンティティ

説明専用のクラスreceiver-typeを下記の通り定義する。

namespace std::execution {
  struct receiver-type {
    using receiver_concept = receiver_t;
    state-type* state;  // exposition only

    void set_value() && noexcept {
      visit(
        [this]<class Tuple>(Tuple& result) noexcept -> void {
          if constexpr (!same_as<monostate, Tuple>) {
            auto& [tag, ...args] = result;
            tag(std::move(state->rcvr), std::move(args)...);
          }
        },
        state->async-result);
    }

    template<class Error>
    void set_error(Error&& err) && noexcept {
      execution::set_error(std::move(state->rcvr), std::forward<Error>(err));
    }

    void set_stopped() && noexcept {
      execution::set_stopped(std::move(state->rcvr));
    }

    decltype(auto) get_env() const noexcept {
      return FWD-ENV(execution::get_env(state->rcvr));
    }
  };
}
  • receiver_t[link receiver.md]
  • execution::set_error[link set_error.md]
  • execution::set_stopped[link set_stopped.md]
  • execution::get_env[link get_env.md]
  • FWD-ENV[link ../forwarding_query.md]
  • visit[link /reference/variant/visit.md]
  • monostate[link /reference/variant/monostate.md]
  • std::move[link /reference/utility/move.md]

カスタマイゼーションポイント

Senderアルゴリズム構築時およびReceiver接続時に、関連付けられた実行ドメインに対してexecution::transform_sender経由でSender変換が行われる。 デフォルト実行ドメインでは無変換。

説明用の式out_sndrをschedule_from(sndr, sch)の戻り値Senderとし、型OutSndrをdecltype((out_sndr))とする。式out_rcvrをsender_in<OutSndr, Env> == trueとなる環境Envに関連付けられたReceiverとする。out_sndrとout_rcvrとの接続(connect)結果Operation Stateへの左辺値参照をopとしたとき、

  • 呼び出しstart(op)は、現在の実行エージェント上で入力Sendersndrを開始し、Schedulerschに関連付けられた実行リソースに属する実行エージェント上でout_rcvrの完了操作を実行すべき。
  • sch上でのスケジューリングが失敗した場合、未規定の実行エージェント上でout_rcvrのエラー完了が行われるべき。

バージョン

言語

  • C++26

処理系

関連項目

参照