# 通知設計書 37-ConnectionStateChanged

## 概要

本ドキュメントは、Windows Terminal におけるターミナル接続状態変更通知（ConnectionStateChanged）の設計仕様を記述する。ConnectionStateChanged は、ターミナルとプロセス（シェル等）間の接続状態が変更された際に発火するイベントであり、接続確立、切断、失敗などの状態遷移をアプリケーション層に通知する。

### 本通知の処理概要

ConnectionStateChanged は、ターミナル接続（ITerminalConnection）の状態が変化した際に、その変化をアプリケーションの各層に伝達する通知機構である。接続状態は NotConnected、Opening、Connected、Closing、Closed、Failed の各状態を取り得る。

**業務上の目的・背景**：ターミナルアプリケーションにおいて、接続状態の変化はタブの表示、ステータス表示、自動再接続などの UI 更新に直結する。接続が切断された場合にはユーザーに視覚的なフィードバックを提供し、必要に応じてプロセスの再起動や接続の再確立を促す必要がある。また、close-on-exit 設定に基づくタブの自動クローズにも使用される。

**通知の送信タイミング**：ITerminalConnection の StateChanged イベントが発火した際、および ControlCore の Connection プロパティが新しい接続に切り替わった際（旧状態と新状態が異なる場合）に発火する。

**通知の受信者**：ControlCore が発火し、TermControl がバブル（BUBBLED_FORWARDED_TYPED_EVENT）し、TerminalPaneContent が受信して ConnectionStateChanged イベントを再発火し、Tab が受信してタブ状態を更新する。TerminalPage も直接 TermControl の ConnectionStateChanged イベントをサブスクライブしている。

**通知内容の概要**：引数は Object 型（null）であり、受信側は sender から ICoreState インターフェースを取得して ConnectionState() プロパティを照会する。

**期待されるアクション**：受信側は接続状態に応じて、タブのアイコン更新、ステータスインジケータの変更、close-on-exit 処理、再接続メニューの表示などを行う。

## 通知種別

アプリ内通知（WinRT イベント）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 非同期（UIスレッドへのディスパッチが必要な場合あり） |
| 優先度 | 高（UI 状態に直結） |
| リトライ | なし |

### 送信先決定ロジック

ITerminalConnection の StateChanged イベントが ControlCore の _connectionStateChangedRevoker 経由で受信され、ConnectionStateChanged イベントが raise される。TermControl、TerminalPaneContent、Tab、TerminalPage の各層でイベントチェーンが構成される。

## 通知テンプレート

### メール通知の場合

該当なし（アプリ内イベント通知）

### 本文テンプレート

該当なし（イベント引数は null。受信側が sender から ConnectionState を照会）

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| （なし） | イベント引数は null。受信側は ICoreState.ConnectionState() を照会 | ControlCore / TermControl の ConnectionState プロパティ | - |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 接続状態変化 | ITerminalConnection.StateChanged | 常に | シェルプロセスの起動、終了、エラー等 |
| 接続切り替え | ControlCore.Connection プロパティ設定 | 旧状態と新状態が異なる場合 | 接続オブジェクトの差し替え時 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 状態変化なし | Connection プロパティ設定時に旧状態と新状態が同じ場合は発火しない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ITerminalConnection.StateChanged 発火] --> B[ControlCore ラムダハンドラー]
    B --> C[ConnectionStateChanged.raise<br/>sender=*this, args=nullptr]
    C --> D[TermControl バブル処理<br/>BUBBLED_FORWARDED_TYPED_EVENT]
    D --> E[TerminalPaneContent._controlConnectionStateChangedHandler]
    E --> F[BasicPaneEvents.ConnectionStateChanged.raise]
    F --> G[Tab イベントハンドラー]
    G --> H[co_await resume_foreground]
    H --> I[タブ状態更新<br/>アイコン、ステータスインジケータ]
    D --> J[TerminalPage._ConnectionStateChangedHandler]
    J --> K[close-on-exit 処理等]
```

## データベース参照・更新仕様

### 参照テーブル一覧

該当なし（インメモリイベント処理のみ）

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 接続失敗 | ConnectionState が Failed になった場合 | TerminalPaneContent が接続失敗状態を検出し、UI に反映 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし（接続のリトライは別の機構で制御） |
| リトライ間隔 | - |
| リトライ対象エラー | - |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 制限なし |
| 1日あたり上限 | 制限なし |

### 配信時間帯

制限なし

## セキュリティ考慮事項

- 接続状態情報はプロセス内のみで伝達され、外部送信は行わない

## 備考

- ConnectionStateChanged イベントの引数は null であり、具体的な状態は sender の ICoreState インターフェースを通じて取得する
- ControlCore.idl で「UIスレッドから呼ばれるイベント」グループに分類されている（行206）
- BasicPaneEvents.h でも ConnectionStateChanged が定義されており、TerminalPaneContent から Tab へのイベント伝達に使用される
- TerminalPaneContent は _connectionState フィールドで最新の接続状態をキャッシュしている

---

## コードリーディングガイド

本通知を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | ControlCore.idl | `src/cascadia/TerminalControl/ControlCore.idl` | ConnectionStateChanged イベント宣言（行206）。引数は Object, Object（型付き引数なし） |
| 1-2 | BasicPaneEvents.h | `src/cascadia/TerminalApp/BasicPaneEvents.h` | BasicPaneEvents の ConnectionStateChanged 定義（行10）。til::typed_event<> |

**読解のコツ**: このイベントは型付き EventArgs を持たない。受信側は sender を ICoreState にキャストして ConnectionState() を照会する。

#### Step 2: ControlCore での発火

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | ControlCore.cpp | `src/cascadia/TerminalControl/ControlCore.cpp` | Connection プロパティ設定時（行319-320, 344-349）。StateChanged ハンドラーの設定と、接続差し替え時の状態比較 |
| 2-2 | ControlCore.h | `src/cascadia/TerminalControl/ControlCore.h` | til::typed_event<> ConnectionStateChanged 宣言（行283） |

**主要処理フロー**:
1. **行319-320**: _connectionStateChangedRevoker でラムダハンドラー設定、ConnectionStateChanged.raise(*this, nullptr)
2. **行344-349**: 旧状態と新状態の比較、異なる場合にイベント発火

#### Step 3: TermControl でのバブル処理

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | TermControl.h | `src/cascadia/TerminalControl/TermControl.h` | BUBBLED_FORWARDED_TYPED_EVENT(ConnectionStateChanged, ...) マクロ（行227） |
| 3-2 | TermControl.cpp | `src/cascadia/TerminalControl/TermControl.cpp` | イベント登録（行325） |

#### Step 4: TerminalPaneContent と Tab でのハンドリング

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | TerminalPaneContent.cpp | `src/cascadia/TerminalApp/TerminalPaneContent.cpp` | _controlConnectionStateChangedHandler（行195-202）。ConnectionStateChanged を再 raise |
| 4-2 | Tab.cpp | `src/cascadia/TerminalApp/Tab.cpp` | イベント登録（行1101-1106）。co_await resume_foreground でUIスレッドへ |

### プログラム呼び出し階層図

```
ITerminalConnection.StateChanged
    |
    +-- ControlCore ラムダハンドラー
           |
           +-- ConnectionStateChanged.raise(*this, nullptr)
                  |
                  +-- TermControl::BUBBLED_FORWARDED_TYPED_EVENT
                         |
                         +-- TerminalPaneContent::_controlConnectionStateChangedHandler
                         |       |
                         |       +-- BasicPaneEvents.ConnectionStateChanged.raise
                         |              |
                         |              +-- Tab イベントハンドラー
                         |                     +-- タブ状態更新
                         |
                         +-- TerminalPage::_ConnectionStateChangedHandler
```

### データフロー図

```
[入力]                         [処理]                            [出力]

ITerminalConnection           ControlCore -> TermControl        TerminalPaneContent -> Tab
StateChanged イベント  -->  ConnectionStateChanged.raise  -->  タブ状態更新
                              バブル処理                         close-on-exit 処理
                                                                 TerminalPage -> UI 更新
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| ControlCore.idl | `src/cascadia/TerminalControl/ControlCore.idl` | IDL定義 | ConnectionStateChanged イベント宣言 |
| ControlCore.h | `src/cascadia/TerminalControl/ControlCore.h` | ソース | til::typed_event 宣言 |
| ControlCore.cpp | `src/cascadia/TerminalControl/ControlCore.cpp` | ソース | イベント発火ロジック |
| TermControl.idl | `src/cascadia/TerminalControl/TermControl.idl` | IDL定義 | TermControl レベルの ConnectionStateChanged 宣言 |
| TermControl.h | `src/cascadia/TerminalControl/TermControl.h` | ソース | BUBBLED_FORWARDED_TYPED_EVENT マクロ |
| BasicPaneEvents.h | `src/cascadia/TerminalApp/BasicPaneEvents.h` | ソース | BasicPaneEvents の ConnectionStateChanged 定義 |
| TerminalPaneContent.cpp | `src/cascadia/TerminalApp/TerminalPaneContent.cpp` | ソース | _controlConnectionStateChangedHandler 実装 |
| TerminalPaneContent.h | `src/cascadia/TerminalApp/TerminalPaneContent.h` | ソース | ControlEventTokens 定義 |
| Tab.cpp | `src/cascadia/TerminalApp/Tab.cpp` | ソース | ConnectionStateChanged ハンドラーとタブ状態更新 |
| TerminalPage.cpp | `src/cascadia/TerminalApp/TerminalPage.cpp` | ソース | _ConnectionStateChangedHandler 実装 |
