# 機能設計書 62-DCDサーバー停止

## 概要

本ドキュメントは、serve-dにおけるDCDサーバー停止機能（served/killServer）の設計を記述する。LSPクライアントからの通知に応じて、serve-dが管理する全てのDCDサーバーインスタンスを即座に停止する機能である。

### 本機能の処理概要

**業務上の目的・背景**：DCDサーバーが応答不能になった場合や、serve-dのシャットダウン時など、DCDサーバーを強制的に停止する必要がある場面が存在する。本機能はDCDサーバーの即座の停止手段を提供する。restartServer（機能No.61）とは異なり、停止のみを行い再起動は行わない。

**機能の利用シーン**：DCDサーバーがハングアップした場合や、リソースを解放したい場合に使用される。また、エディタの終了時やワークスペースのクローズ時に明示的にサーバーを停止させる場合にも利用される。

**主要な処理内容**：
1. バックエンドに登録された全ワークスペースインスタンスを走査する
2. 各インスタンスがDCDComponentを保持しているか確認する
3. DCDComponentを持つインスタンスに対してkillServer()を呼び出す

**関連システム・外部連携**：DCDサーバープロセスとの連携。DCDサーバーの停止はworkspace-dのDCDComponentを通じて行われる。

**権限による制御**：特別な権限制御はない。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 41 | DCDサーバー停止（served/killServer） | 主画面 | 全DCDサーバーインスタンスを停止する |

## 機能種別

サーバー管理操作（プロセス停止）

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| (なし) | - | - | パラメータなしの通知 | - |

### 入力データソース

LSPクライアントからの `served/killServer` 通知。パラメータは不要。

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| (なし) | void | 通知のため戻り値なし |

### 出力先

なし（通知のためレスポンスを返さない）。

## 処理フロー

### 処理シーケンス

```
1. served/killServer通知を受信
   └─ killServer()関数が呼び出される
2. 全バックエンドインスタンスを走査
   └─ backend.instancesをforeachで反復
3. 各インスタンスでDCDComponentの有無を確認
   └─ instance.has!DCDComponentで判定
4. DCDComponentを持つインスタンスのkillServer()を呼び出し
   └─ 同期的にDCDサーバープロセスを停止
```

### フローチャート

```mermaid
flowchart TD
    A[served/killServer 通知受信] --> B{全インスタンスを走査}
    B -->|次のインスタンス| C{DCDComponent あり?}
    C -->|Yes| D[instance.get!DCDComponent.killServer を呼び出し]
    C -->|No| B
    D --> B
    B -->|走査完了| E[処理完了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-62-01 | 全インスタンス停止 | DCDComponentを持つ全てのワークスペースインスタンスのDCDサーバーを停止する | 常時 |
| BR-62-02 | 非同期通知 | Notificationのため完了を待たずにクライアントに制御を返す | 常時 |
| BR-62-03 | 非DCDインスタンスのスキップ | DCDComponentを持たないインスタンスはスキップする | 常時 |

### 計算ロジック

特になし。

## データベース操作仕様

### 操作別データベース影響一覧

データベース操作はない。

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | プロセス停止失敗 | DCDサーバープロセスが既に停止している場合 | DCDComponentの内部でハンドリングされる |

### リトライ仕様

本機能自体にリトライ機構はない。

## トランザクション仕様

トランザクション管理は不要。

## パフォーマンス要件

プロセスの停止であるため、高速に完了する。

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

外部プロセスの停止操作であるが、serve-dが管理しているDCDサーバーのみが対象となるため、セキュリティリスクは低い。

## 備考

- `@protocolNotification("served/killServer")` アノテーションにより、LSP通知として登録される
- restartServer（機能No.61）とは異なり、`@protocolNotification` であるため戻り値なし（void）
- killServerは同期的に各DCDサーバーを停止する（Futureを使わない）
- restartServerとの違い：restartServerは再起動（停止+起動）で応答を返すが、killServerは停止のみで応答なし

---

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

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

### 推奨読解順序

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

DCDComponent型の理解は機能No.61と共通である。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | complete.d | `source/served/commands/complete.d` | killServer関数の定義位置（1388-1394行目）を確認 |

**読解のコツ**: `@protocolNotification` はリクエスト・レスポンスではなく一方向通知として登録されるアノテーション。restartServerとの比較で理解するとよい。

#### Step 2: エントリーポイントを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | complete.d | `source/served/commands/complete.d` | killServer関数（1388-1394行目） |

**主要処理フロー**:
1. **1388行目**: `@protocolNotification("served/killServer")` によりLSP通知として登録
2. **1389行目**: `void killServer()` - 戻り値なしの関数定義
3. **1391-1393行目**: `backend.instances` を走査し、DCDComponentを持つインスタンスのkillServer()を呼び出し

#### Step 3: restartServerとの比較

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | complete.d | `source/served/commands/complete.d` | restartServer関数（1376-1385行目）との比較 |

**比較ポイント**:
- restartServerはFuture!void[]を使い非同期で全再起動を待機するが、killServerは同期的に停止のみ
- restartServerは `@protocolMethod` でboolを返すが、killServerは `@protocolNotification` でvoid

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

```
killServer() [complete.d:1388-1394]
    |
    +-- backend.instances (全ワークスペースインスタンスの列挙)
    |
    +-- instance.has!DCDComponent (DCDComponent保持チェック)
    |
    +-- instance.get!DCDComponent.killServer() (各DCDサーバー停止)
            |
            +-- [workspace-d内部] DCDサーバープロセスの停止
```

### データフロー図

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

served/killServer     ──▶  killServer()            ──▶  (なし: void)
(LSP通知)                    |
                            +-- 全インスタンス走査
                            +-- DCDComponent.killServer()
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| complete.d | `source/served/commands/complete.d` | ソース | killServer関数の定義（1388-1394行目） |
| extension.d | `source/served/extension.d` | ソース | バックエンドインスタンス管理 |
| types.d | `source/served/types.d` | ソース | 共通型定義 |
