最終更新日時(UTC):
が更新

履歴 編集

customization point object
<execution>

std::execution::on(C++26)

namespace std::execution {
  struct on_t { unspecified };
  inline constexpr on_t on{};
}

概要

onは、2種類の呼び出し形式サポートするSenderアダプタである。

  • on(sch, sndr) : SendersndrSchedulerschに関連付けられた実行リソースに属する実行エージェント上で開始し、完了後にonSenderが開始された実行リソースへと実行制御を戻す。
  • on(sndr, sch, closure) : Sendersndrの完了後に、Schedulerschに関連付けられた実行リソースに属する実行エージェントへ実行を移し、sndrの完了結果をもってSenderアダプタクロージャclosureを実行し、Sendersndrが完了された実行リソースへと実行制御を戻す。

onパイプ可能Senderアダプタオブジェクトであり、パイプライン記法をサポートする。

効果

呼び出し式 on(sch, sndr)

説明用の式schsndrに対して、下記いずれかがtrueとなるとき呼び出し式on(sch, sndr)不適格となる。

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

呼び出し式 on(sndr, sch, closure)

説明用の式sndr, sch, closureに対して、下記いずれかがtrueとなるとき呼び出し式on(sndr, sch, closure)不適格となる。

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

transform_sender(
  get-domain-early(sndr),
  make-sender(on, product-type{sch, closure}, sndr))

Senderアルゴリズムタグ on

説明用の式out_sndrenvに対して、型OutSndrdecltype((out_sndr))とし、型Envdecltype((env))とする。sender-for<OutSndr, on_t> == falseのとき、式on.transform_env(out_sndr, env)および式on.transform_sender(out_sndr, env)はいずれも不適格となる。

そうでなければ、下記の通り。

説明専用のクラスnot-a-scheduler未規定な空のクラス型、not-a-senderを下記の通り定義する。

struct not-a-sender {
  using sender_concept = sender_t;

  auto get_completion_signatures(auto&&) const {
    return see below;
  }
};

メンバ関数get_completion_signaturescompletion_signaturesクラステンプレートの特殊化とは異なる型のオブジェクトを返す。 処理系(標準ライブラリ実装者)は、この型を用いてユーザにエラー理由を通知することが推奨される。

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

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

Receiverとの接続(connect)時に、関連付けられた実行ドメインに対してexecution::transform_sender経由でSender変換が行われる。 デフォルト実行ドメインではon.transform_sender(out_sndr, env)が呼ばれ、前述仕様通りのSenderへと変換される。

呼び出し式 on(sch, sndr)

説明用の式out_sndron(sch, sndr)戻り値Senderとし、型OutSndrdecltype((out_sndr))とする。式out_rcvrsender_in<OutSndr, Env> == trueとなる環境Envに関連付けられたReceiverとする。out_sndrout_rcvrとの接続(connect)結果Operation Stateへの左辺値参照をopとしたとき、start(op)呼び出しは下記を満たすべき。

  • 現在のSchedulerget_scheduler(get_env(rcvr))を記憶する。
  • Schedulerschに関連付けられた実行リソースに属する実行エージェント上でsndrを開始する。
  • sndrの完了後に、手順1で記憶したSchedulerに関連付けられた実行リソースに実行制御を戻す。
  • sndrの非同期操作の結果をout_rcvrへ転送する。

いずれかのスケジューリングが失敗した場合、未規定の実行エージェント上でout_rcvrエラー完了が行われるべき。

呼び出し式 on(sndr, sch, closure)

説明用の式out_sndron(sndr, sch, closure)戻り値Senderとし、型OutSndrdecltype((out_sndr))とする。式out_rcvrsender_in<OutSndr, Env> == trueとなる環境Envに関連付けられたReceiverとする。out_sndrout_rcvrとの接続(connect)結果Operation Stateへの左辺値参照をopとしたとき、start(op)呼び出しは下記を満たすべき。

  • 下記のうち最初に適格となるものを、現在のSchedulerとして記憶する。
  • sndrを現在の実行エージェント上で開始する。
  • sndrの完了後に、Schedulerschに関連付けられた実行リソースの実行エージェントに実行制御を移す。
  • sndrの非同期操作の結果を、Senderclosure(S)と接続して開始するかのように転送する。ここでSsndrの非同期操作の結果と同期的に完了するSenderとする。
  • 前手順で開始した非同期操作が完了したら、手順1で記憶したSchedulerに関連付けられた実行リソースに実行制御を戻し、非同期操作の結果をout_rcvrへ転送する。

いずれかのスケジューリングが失敗した場合、未規定の実行エージェント上でout_rcvrエラー完了が行われるべき。

例1: on(sch, sndr)

#include <thread>
#include <print>
#include <execution>
namespace ex = std::execution;

int main()
{
  std::println("main#{}", std::this_thread::get_id());

  ex::run_loop loop;
  std::jthread worker{[&]{
    std::println("start worker#{}", std::this_thread::get_id());
    loop.run();
  }};
  ex::scheduler auto sch = loop.get_scheduler();

  ex::sender auto snd0 =
    ex::then(ex::just(), []() {
      std::println("on worker#{}", std::this_thread::get_id());
      return 6;
    });
  ex::sender auto snd1 = ex::on(sch, snd0);
  ex::sender auto snd2 =
    ex::then(snd1, [](int n) {
      std::println("on main#{}", std::this_thread::get_id());
      return n * 7;
    });

  auto [val] = std::this_thread::sync_wait(std::move(snd2)).value();
  std::println("val={}", val);

  loop.finish();
}

出力例

main#133519926773568
start worker#133519921645120
on worker#133519921645120
on main#133519926773568
val=42

例2: on(sndr, sch, closure)

#include <thread>
#include <print>
#include <execution>
namespace ex = std::execution;

int main()
{
  std::println("main#{}", std::this_thread::get_id());

  ex::run_loop loop;
  std::jthread worker{[&]{
    std::println("start worker#{}", std::this_thread::get_id());
    loop.run();
  }};
  ex::scheduler auto sch = loop.get_scheduler();

  ex::sender auto sndr =
    ex::just()
    | ex::then([]() {
        std::println("on main#{}", std::this_thread::get_id());
        return 2;
      })
    | ex::on(sch, ex::then([](int n) {
        std::println("on worker#{}", std::this_thread::get_id());
        return n * 3;
      }))
    | ex::then([](int n) {
        std::println("on main#{}", std::this_thread::get_id());
        return n * 7;
      });

  auto [val] = std::this_thread::sync_wait(std::move(sndr)).value();
  std::println("val={}", val);

  loop.finish();
}

出力例

main#133519926773568
start worker#133519921645120
on main#133519926773568
on worker#133519921645120
on main#133519926773568
val=42

バージョン

言語

  • C++26

処理系

関連項目

参照