最終更新日時: 2026年06月08日 00時58分39秒 (JST)
yoh が更新

履歴 編集

customization point object
<execution>

# std::this_thread::sync_wait(C++26)

    namespace std::this_thread {
      struct sync_wait_t { unspecified };
      inline constexpr sync_wait_t sync_wait{};
    }

## 概要

`sync_wait`は、入力Senderが完了するまで現在のスレッドをブロックし、非同期操作の結果を取得するSenderコンシューマである。

`sync_wait`は入力Senderが値完了シグネチャを1個だけ持つことを要求する。 値完了シグネチャが複数存在する場合は`sync_wait_with_variant`アルゴリズムを利用する。

入力Senderの値完了シグネチャが`set_value_t(Ts...)`のとき、`sync_wait`の結果型は`optional<tuple<Ts...>>`となる。

## 効果

説明用の`sndr`を`decltype((sndr))`が`Sndr`型となる式とする。

型`Domain`を`get_completion_domain<set_value_t>(get_env(sndr), sync-wait-env{})`として、呼び出し式`this_thread::sync_wait(sndr)`は下記と等価。

    apply_sender(Domain(), sync_wait, sndr)

- `sender_in<Sndr, sync-wait-env> == true`であること。
- 型`sync-wait-result-type<Sndr>`が適格であること。
- 上記の`apply_sender`式を`e`としたとき、`same_as<decltype(e), sync-wait-result-type<Sndr>> == true`であること。

### 結果型

`sync_wait`の結果型となる、説明専用のエイリアステンプレート`sync-wait-result-type`を下記の通り定義する。

    namespace std::this_thread {
      template<execution::sender_in<sync-wait-env> Sndr>
      using sync-wait-result-type =
        optional<execution::value_types_of_t<Sndr, sync-wait-env,
                 decayed-tuple, type_identity_t>>;
    }

### Senderアルゴリズムタグ `sync_wait`

説明用の`sndr`を`decltype((sndr))`が`Sndr`型となる式とする。

`sender-to<Sndr, sync-wait-receiver<Sndr>> == false`のとき、式`sync_wait.apply_sender(sndr)`は不適格となる。

そうでなければ、式`sync_wait.apply_sender(sndr)`は下記と等価。

    sync-wait-state<Sndr> state;
    auto op = connect(sndr, sync-wait-receiver<Sndr>{&state});
    start(op);

    state.loop.run();
    if (state.error) {
      rethrow_exception(std::move(state.error));
    }
    return std::move(state.result);

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

入力Sender `sndr`の完了ドメイン `dom`に対して、 `execution::apply_sender`経由で`dom.apply_sender(sync_wait, sndr)`が呼ばれる。

デフォルト実行ドメインでは、`sync_wait.apply_sender(sndr)`が呼ばれる。

下記を満たさない場合、呼び出し式`this_thread::sync_wait(sndr)`の動作は未定義となる。

- 指定したSenderが完了するまで、前方進行保証委任(forward progress guarantee delegation)による現在のスレッドをブロックすること。
- 指定したSenderの非同期操作の結果が返る場合
  - 値完了の場合、結果データは`optional`オブジェクト内の`tuple`で返されること。
  - エラー完了の場合、例外を送出すること。
  - 停止完了の場合、無効値`optional`オブジェクトが返されること。

## 例

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

    int main()
    {
      // 値(100, 'X')を送信するSender
      ex::sender auto sndr = ex::just(100, 'X');
      // メインスレッド上で完了待機
      auto result = std::this_thread::sync_wait(sndr);
      // 結果型optional<tuple<int,char>>から値を取り出す
      auto [n, c] = result.value();
      std::println("result=({}, {})", n, c);
    }

### 出力

    result=(100, X)

## バージョン

### 言語

- C++26

### 処理系

- Clang: ??
- GCC: ??
- ICC: ??
- Visual C++: ??

## 関連項目

- `execution::sender`
- `this_thread::sync_wait_with_variant`

## 参照

- P2300R10 `std::execution`
- P3557R3 High-Quality Sender Diagnostics with Constexpr Exceptions
- P3826R5 Fix Sender Algorithm Customization
- P4159R0 Make `sender_in` and `receiver_of` exposition-only