# 通知設計書 4-Async\ConditionNode::succeed

## 概要

本ドキュメントは、HH\Lib\Async\ConditionNode クラスの succeed メソッドによるリンクリストノードへの成功通知機能について記載する。

### 本通知の処理概要

Async\ConditionNode::succeed メソッドは、リンクリスト構造を持つ条件変数ノードに対して成功通知を行う機能である。ConditionNode は Condition クラスを継承しており、succeed メソッドは親クラスから継承される。主に BasePoll クラスで非同期イテレーションの完了通知に使用される。

**業務上の目的・背景**：Poll パターンにおいて、複数の Awaitable を順次完了順に処理する際、各完了イベントを待機中の処理に通知する必要がある。ConditionNode はリンクリスト形式で完了イベントを管理し、それぞれのノードに対して succeed を呼び出すことで、完了順に結果を通知できる仕組みを提供する。これにより、epoll/poll/select のような非同期I/O多重化パターンを Hack で実現できる。

**通知の送信タイミング**：BasePoll 内の waitForThenNotify メソッドから、Awaitable の完了時に自動的に呼び出される。個々の Awaitable が完了するたびに、対応するノードに対して succeed が呼び出される。

**通知の受信者**：同一 ConditionNode に対して waitForNotificationAsync を呼び出している BasePoll::next メソッドが受信者となる。

**通知内容の概要**：タプル型 (Tk, Tv) の結果値が通知される。Tk はキー、Tv は Awaitable の結果値を表す。

**期待されるアクション**：受信者（BasePoll::next）は結果を呼び出し元に返し、foreach ループの次のイテレーションで処理される。

## 通知種別

プログラム内非同期通知（リンクリスト型条件変数・Poll パターン）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（メソッド呼び出し時に即座に状態変更） |
| 優先度 | N/A（プログラム内通知のため） |
| リトライ | 無（各ノードへの通知は1回のみ） |

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

送信先は BasePoll 内で管理されるリンクリストの次のノード（lastNotified の次のノード）である。ノードの順序は Awaitable が追加された順序に従う。

## 通知テンプレート

### プログラム通知の場合

| 項目 | 内容 |
|-----|------|
| 通知形式 | Awaitable の完了 |
| データ型 | タプル (Tk, Tv) |
| 通知方法 | 継承した Condition::succeed メソッド経由 |

### 通知データ構造

```hack
// 成功通知時のデータ（BasePoll 使用時）
tuple(Tk $key, Tv $result)  // キーと結果値のタプル
```

### 添付ファイル

該当なし（プログラム内通知のため）

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $key | Awaitable に関連付けられたキー | addImpl の第1引数 | Yes |
| $result | Awaitable の結果値 | await $awaitable の戻り値 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| Awaitable 完了 | await $awaitable の成功完了 | なし | waitForThenNotify から自動呼び出し |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 二重通知 | 同一ノードに対して既に succeed または fail が呼び出されている場合、invariant 違反 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[Awaitable 完了] --> B[waitForThenNotify 内で await 完了]
    B --> C[lastNotified を次のノードに進める]
    C --> D[lastNotified->succeed を呼び出し]
    D --> E[待機中の next メソッドに結果を通知]
    E --> F[foreach ループで結果を処理]
    F --> G[終了]
```

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

該当なし（メモリ内での状態管理のみ）

### 参照テーブル一覧

該当なし

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| invariant 違反 | 同一ノードに2回以上 succeed/fail を呼び出した場合 | 通常使用では発生しない（BasePoll が管理） |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | 0（リトライ不可） |
| リトライ間隔 | N/A |
| リトライ対象エラー | なし |

## 配信設定

### レート制限

該当なし（プログラム内通知のため）

### 配信時間帯

制限なし

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

- 結果値に機密情報を含む場合は、受信側での適切な取り扱いが必要
- ConditionNode へのアクセスは BasePoll 内部に限定されているため、外部からの不正アクセスリスクは低い

## 備考

- ConditionNode は Condition クラスを継承し、リンクリスト機能を追加したクラス
- succeed メソッドは親クラス Condition から継承される
- 主な使用用途は BasePoll/Poll/KeyedPoll での非同期イテレーション

---

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

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

### 推奨読解順序

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

ConditionNode のリンクリスト構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | ConditionNode.php | `src/async/ConditionNode.php` | クラス定義と継承関係（16行目） |
| 1-2 | ConditionNode.php | `src/async/ConditionNode.php` | $next プロパティとリンクリスト構造（17行目） |

**読解のコツ**: ConditionNode は Condition を継承し、$next で次のノードへの参照を保持する単方向リンクリストである。

#### Step 2: 継承元のメソッドを理解する

succeed メソッドは Condition クラスから継承される。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | Condition.php | `src/async/Condition.php` | succeed メソッドの実装（23-36行目） |

**主要処理フロー**:
- ConditionNode::succeed は Condition::succeed をそのまま継承
- 処理内容は Condition::succeed と同一

#### Step 3: BasePoll での使用パターンを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | BasePoll.php | `src/async/BasePoll.php` | lastNotified プロパティ（71行目） |
| 3-2 | BasePoll.php | `src/async/BasePoll.php` | waitForThenNotify メソッド（132-146行目） |

**主要処理フロー**:
- **行132-135**: async メソッドの定義
- **行136-140**: try ブロックで await し、成功時に succeed を呼び出し
- **行138-139**: lastNotified を次のノードに進めて succeed を呼び出し
- **行141-145**: catch ブロックで fail を呼び出し

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

```
BasePoll::addImpl($key, $awaitable)
    |
    +-- ConditionNode::addNext()  // 新しいノードを追加
    |
    +-- waitForThenNotify($key, $awaitable)
            |
            +-- await $awaitable
            |
            +-- lastNotified = lastNotified->getNext()
            |
            +-- lastNotified->succeed(tuple($key, $result))
                    |
                    +-- [継承] Condition::succeed()
                            |
                            +-- 待機中の next() が結果を受け取る
```

### データフロー図

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

Awaitable<Tv>
    │
    v
await ────────────▶ waitForThenNotify() ────▶ ConditionNode::succeed()
                           │                          │
                           │                          v
                           │                  tuple(Tk, Tv)
                           │                          │
                           │                          v
                           └───────────────────▶ BasePoll::next()
                                                      │
                                                      v
                                              foreach ループ処理
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| ConditionNode.php | `src/async/ConditionNode.php` | ソース | ConditionNode クラスの実装 |
| Condition.php | `src/async/Condition.php` | ソース | 親クラス Condition の実装 |
| BasePoll.php | `src/async/BasePoll.php` | ソース | ConditionNode を使用する Poll 基底クラス |
| Poll.php | `src/async/Poll.php` | ソース | BasePoll を継承した具象クラス |
| KeyedPoll.php | `src/async/KeyedPoll.php` | ソース | BasePoll を継承したキー付き Poll クラス |
| PollTest.php | `tests/async/PollTest.php` | テスト | Poll/KeyedPoll のユニットテスト |
