# 機能設計書 36-読み書き可能判定

## 概要

本ドキュメントは、libuvにおけるストリームの読み書き可能判定機能（uv_is_readable()/uv_is_writable()）の設計仕様を記述する。

### 本機能の処理概要

**業務上の目的・背景**：ストリームに対してデータの読み取りや書き込みが可能かどうかを事前に判定する必要がある。例えば、半二重クローズ後のストリームは書き込み不可だが読み取りは可能である。アプリケーションがストリームの状態を確認し、適切な操作を選択するためにこれらの関数が提供される。

**機能の利用シーン**：ストリームに書き込みを行う前の状態チェック、シャットダウン後のストリーム状態確認、デバッグ目的でのストリーム状態表示に使用される。

**主要な処理内容**：
1. uv_is_readable(): UV_HANDLE_READABLEフラグの確認
2. uv_is_writable(): UV_HANDLE_WRITABLEフラグの確認

**関連システム・外部連携**：特になし。内部フラグの参照のみ。

**権限による制御**：特になし。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 17 | ストリーム | 主機能 | uv_is_readable()/uv_is_writable()による読み書き可能判定のAPI定義 |

## 機能種別

状態照会処理

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| stream | const uv_stream_t* | Yes | 判定対象のストリーム | NULLでないこと |

### 入力データソース

アプリケーションコードからの直接呼び出し。

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| 戻り値 | int | 非ゼロ: 読み取り/書き込み可能、0: 不可 |

### 出力先

戻り値としてアプリケーションに返却。

## 処理フロー

### 処理シーケンス

```
1. uv_is_readable(stream)
   └─ stream->flags & UV_HANDLE_READABLE の結果を返却

2. uv_is_writable(stream)
   └─ stream->flags & UV_HANDLE_WRITABLE の結果を返却
```

### フローチャート

```mermaid
flowchart TD
    A[uv_is_readable 呼び出し] --> B{UV_HANDLE_READABLE フラグ?}
    B -->|Set| C[非ゼロ返却]
    B -->|Not set| D[0 返却]

    E[uv_is_writable 呼び出し] --> F{UV_HANDLE_WRITABLE フラグ?}
    F -->|Set| G[非ゼロ返却]
    F -->|Not set| H[0 返却]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-36-01 | フラグベース判定 | 実際のOS状態ではなく、libuvの内部フラグに基づいて判定する | 常時 |
| BR-36-02 | シャットダウン後 | uv_shutdown()後はUV_HANDLE_WRITABLEがクリアされるためuv_is_writable()は0を返す | シャットダウン後 |
| BR-36-03 | 初期状態 | uv__stream_open()でREADABLE/WRITABLEフラグが設定される | ストリームオープン時 |

### 計算ロジック

`!!(stream->flags & UV_HANDLE_READABLE)` および `!!(stream->flags & UV_HANDLE_WRITABLE)` による二重否定でブール値に変換。

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

該当なし。

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

該当なし。

### テーブル別操作詳細

該当なし。

## エラー処理

### エラーケース一覧

エラーを返す仕組みはない。常に0または非ゼロを返す。

### リトライ仕様

該当なし。

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

該当なし。

## パフォーマンス要件

- フラグのビット演算のみであり、O(1)で即座に結果を返す
- システムコールは一切呼ばない

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

- 特になし。読み取り専用の状態照会のみ。

## 備考

- Unix版とWindows版で全く同一の実装（フラグチェック）
- constポインタを受け取るため、ストリームの状態を変更しない

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | uv.h | `include/uv.h` | **579-580行目**: uv_is_readable()/uv_is_writable()のAPI宣言 |

**読解のコツ**: 引数はconst uv_stream_t*であり、状態の読み取りのみを行う。

#### Step 2: 実装を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | stream.c | `src/unix/stream.c` | **1488-1495行目**: Unix版の実装（フラグチェック） |
| 2-2 | stream.c | `src/win/stream.c` | **258-265行目**: Windows版の実装（同一ロジック） |

**主要処理フロー**:
- **1488-1490行目**: `return !!(stream->flags & UV_HANDLE_READABLE);`
- **1493-1495行目**: `return !!(stream->flags & UV_HANDLE_WRITABLE);`

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

```
uv_is_readable(stream)
    └─ stream->flags & UV_HANDLE_READABLE

uv_is_writable(stream)
    └─ stream->flags & UV_HANDLE_WRITABLE
```

### データフロー図

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

stream ───────▶ flags & UV_HANDLE_READABLE ───▶ 0 or 非ゼロ
stream ───────▶ flags & UV_HANDLE_WRITABLE ───▶ 0 or 非ゼロ
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| uv.h | `include/uv.h` | ヘッダ | API宣言 |
| stream.c | `src/unix/stream.c` | ソース | Unix版実装 |
| stream.c | `src/win/stream.c` | ソース | Windows版実装 |
| uv-common.h | `src/uv-common.h` | ヘッダ | UV_HANDLE_READABLE/UV_HANDLE_WRITABLEフラグ定義 |
