【PHP8.x】STREAM_PEEK定数の使い方

Copy
1<?php
2
3/**
4 * STREAM_PEEK 定数と stream_get_meta_data 関数の使用例を示します。
5 *
6 * この関数は、簡単なUDPソケット通信を設定し、STREAM_PEEK フラグを使用して
7 * データをキューから削除せずに読み取る方法を実演します。
8 * また、開いているストリームのメタデータを stream_get_meta_data 関数で
9 * 取得して表示する方法も示します。
10 */
11function demonstrateStreamPeekAndMetaData(): void
12{
13    // 1. UDPサーバーソケットを作成します。
14    // "udp://127.0.0.1:0" は、ループバックアドレスの利用可能なポートをOSに割り当てさせます。
15    $serverSocket = stream_socket_server("udp://127.0.0.1:0", $errno, $errstr);
16
17    if (!$serverSocket) {
18        // ソケット作成に失敗した場合、エラーメッセージを出力し終了します。
19        echo "サーバーソケットの作成に失敗しました: $errstr ($errno)\n";
20        return;
21    }
22
23    // サーバーソケットに割り当てられたアドレスとポートを取得します。
24    $serverAddress = stream_socket_get_name($serverSocket, false);
25    echo "サーバーが $serverAddress でリッスンしています。\n";
26
27    // 2. クライアントソケットを作成し、サーバーに接続します。
28    $clientSocket = stream_socket_client("udp://$serverAddress", $errno, $errstr);
29    if (!$clientSocket) {
30        // クライアントソケット作成に失敗した場合、エラーメッセージを出力し終了します。
31        echo "クライアントソケットの作成に失敗しました: $errstr ($errno)\n";
32        fclose($serverSocket); // サーバーソケットも閉じます
33        return;
34    }
35
36    $message = "Hello, PHP STREAM_PEEK Example!";
37    // クライアントからサーバーへメッセージを送信します。
38    fwrite($clientSocket, $message);
39    echo "クライアントがメッセージを送信しました: '$message'\n";
40
41    // 3. サーバー側でデータを受信します（STREAM_PEEKを使用）。
42    // STREAM_PEEK フラグは、データを読み取りますが、ストリームの内部キューから削除しないことを意味します。
43    // そのため、同じデータを再度読み取ることが可能です。
44    $peekedData = stream_socket_recvfrom($serverSocket, 1024, STREAM_PEEK, $remoteAddress);
45    echo "サーバーがデータをピークしました（キューから消費せず）: '$peekedData' (送信元: $remoteAddress)\n";
46
47    // 4. サーバー側でデータを再度受信します（今回は消費）。
48    // STREAM_PEEK フラグがない（または0）場合、データは内部キューから削除されます。
49    $receivedData = stream_socket_recvfrom($serverSocket, 1024, 0, $remoteAddress);
50    echo "サーバーがデータを再度受信しました（キューから消費済み）: '$receivedData' (送信元: $remoteAddress)\n";
51
52    // 5. stream_get_meta_data を使用してサーバーソケットのメタデータを取得します。
53    // この関数は、ストリームに関する詳細な情報（例：ラッパータイプ、ブロックモードなど）を
54    // 連想配列として返します。
55    $metaData = stream_get_meta_data($serverSocket);
56    echo "\n--- サーバーソケットのメタデータ ---\n";
57    foreach ($metaData as $key => $value) {
58        echo "$key: ";
59        if (is_array($value)) {
60            // 配列型の値はカンマで連結して表示します。
61            echo "[" . implode(", ", $value) . "]\n";
62        } elseif (is_bool($value)) {
63            // 真偽値は 'true' または 'false' で表示します。
64            echo ($value ? 'true' : 'false') . "\n";
65        } else {
66            // その他の値はそのまま表示します。
67            echo "$value\n";
68        }
69    }
70
71    // 6. STREAM_PEEK 定数の値も表示します。
72    // これはストリーム操作のフラグとして使われる整数値です。
73    echo "\nSTREAM_PEEK 定数の値: " . STREAM_PEEK . "\n";
74
75    // 7. 使用したソケットを閉じ、リソースを解放します。
76    fclose($clientSocket);
77    fclose($serverSocket);
78    echo "ソケットを閉じました。\n";
79}
80
81// 上記で定義した関数を実行します。
82demonstrateStreamPeekAndMetaData();

PHPのSTREAM_PEEK定数は、ストリームからデータを読み取る際に、そのデータをストリームの内部キューから削除せずに「覗き見」するためのフラグとして使われる整数値です。例えば、stream_socket_recvfrom関数の引数に指定することで、受信データを一時的に確認しつつ、後で完全に読み取るといった操作が可能になります。この定数自体は引数を取りません。

一方、stream_get_meta_data関数は、開いているファイルやソケットなどのストリームに関する詳細なメタデータ（付加情報）を連想配列として取得する関数です。この関数にはストリームリソースを引数として渡し、ストリームのラッパータイプや読み書きモード、ブロックモードなど、さまざまな状態情報が連想配列として返されます。

サンプルコードでは、まずUDP通信のサーバーとクライアントを構築します。クライアントが送信したメッセージをサーバーが受信する際、一度目はSTREAM_PEEK定数を使用してデータをキューから消費せずに読み取ります。これにより、同じデータを二度目の受信時に再度読み取れることが示されます。二度目の受信ではSTREAM_PEEKを使用しないため、データが消費され、キューから削除されます。さらに、サーバーソケットのメタデータをstream_get_meta_data関数で取得し、その内容を表示することで、ストリームの内部状態がどのように確認できるかを示しています。これらの機能は、ネットワーク通信やファイル操作において、データの事前確認やストリームの状態把握に役立ちます。

Copy
1<?php
2
3/**
4 * PHPのストリーム選択 (stream_select) とデータ覗き見 (STREAM_PEEK) を使った
5 * シンプルなソケットサーバーの例です。
6 *
7 * この関数は、TCPソケットサーバーを起動し、複数のクライアントからの接続とデータをノンブロッキングで監視します。
8 * クライアントからデータを受信した際、STREAM_PEEKフラグを使用してデータをソケットバッファから消費せずに内容を覗き見し、
9 * その後、実際にデータをバッファから読み取ってクライアントにエコーバックします。
10 *
11 * 実行方法:
12 * 1. このスクリプトを実行します: php your_script_name.php
13 * 2. 別のターミナルからクライアントとして接続します (netcat など):
14 *    nc 127.0.0.1 8000
15 * 3. クライアント側でメッセージを入力してEnterキーを押すと、サーバーに送信されます。
16 *    サーバー側のコンソールとクライアント側の両方でデータのやり取りを確認できます。
17 *    サーバーはメッセージを「覗き見」した後、実際に読み取り、クライアントにエコーバックします。
18 */
19function runStreamSelectPeekServer(): void
20{
21    $host = '127.0.0.1';
22    $port = 8000;
23    $serverAddress = "tcp://{$host}:{$port}";
24
25    // サーバーソケットを作成します。
26    // stream_socket_server() はサーバー側のソケットを作成し、指定されたアドレスにバインドします。
27    $server = stream_socket_server($serverAddress, $errno, $errstr);
28    if (!$server) {
29        echo "エラー: サーバーの起動に失敗しました: {$errstr} ({$errno})\n";
30        return;
31    }
32
33    // サーバーソケットをノンブロッキングモードに設定します。
34    // これにより、stream_socket_accept() や stream_select() がブロックされず、
35    // 複数の接続を同時に処理できるようになります。
36    stream_set_blocking($server, false);
37    echo "サーバーが {$serverAddress} で起動しました。クライアントの接続を待機しています...\n";
38
39    // 監視対象の「読み込みストリーム」の配列を初期化します。
40    // 最初はサーバーソケット自身が監視対象です（新しい接続を受け入れるため）。
41    $reads = [$server];
42    $clients = []; // 接続済みクライアントを管理する配列 (リソースIDをキーとして使用)
43
44    // サーバーのメインループ: 無限に実行され、接続とデータ受信を監視します。
45    while (true) {
46        // stream_select() は、監視対象のストリームのうち、読み書き可能になったストリームを特定します。
47        // $readyToRead: 読み込み可能か監視するストリームの配列 (in/out パラメータ)。
48        // $null (writes, excepts): この例では書き込み可能、例外を監視しないため null を渡します。
49        // タイムアウト: 1秒。これにより、ループが完全にブロックされるのを防ぎ、定期的に処理を実行できます。
50        $readyToRead = $reads; // stream_selectは配列を変更するため、毎回コピーを作成
51        $null = null;
52        if (stream_select($readyToRead, $null, $null, 1) === false) {
53            echo "エラー: stream_select() でエラーが発生しました。\n";
54            break; // エラー発生時はループを終了
55        }
56
57        // 読み込み可能になったストリームがない場合、次のループイテレーションへ。
58        if (empty($readyToRead)) {
59            continue;
60        }
61
62        // サーバーソケットが $readyToRead に含まれている場合、新しい接続要求があることを意味します。
63        if (in_array($server, $readyToRead)) {
64            // 新しいクライアント接続を受け入れます。
65            // stream_socket_accept() は新しいクライアントソケットのリソースを返します。
66            $client = stream_socket_accept($server);
67            if ($client) {
68                // クライアントソケットもノンブロッキングモードに設定します。
69                stream_set_blocking($client, false);
70                $clientId = (int) $client; // ストリームリソースのユニークなIDを取得
71                $reads[$clientId] = $client; // 新しいクライアントを監視対象に追加
72                $clients[$clientId] = $client; // クライアント管理リストに追加
73                echo "クライアント #{$clientId} が接続しました。\n";
74            }
75            // サーバーソケットは既に処理されたので、$readyToRead から削除します。
76            unset($readyToRead[array_search($server, $readyToRead)]);
77        }
78
79        // 読み込み可能になった残りのストリーム（既存のクライアントソケット）を処理します。
80        foreach ($readyToRead as $clientId => $client) {
81            // クライアントが既に切断されている可能性があるので確認します。
82            if (!isset($clients[$clientId])) {
83                continue;
84            }
85
86            // STREAM_PEEK フラグを使用して、データを消費せずにソケットバッファからデータを「覗き見」します。
87            // 第2引数は最大読み取りバイト数、第3引数はフラグです。
88            // 覗き見されたデータはソケットバッファに残るため、後で再度読み取ることができます。
89            $peekedData = stream_socket_recvfrom($client, 1024, STREAM_PEEK);
90
91            // peekedData が空文字列または false の場合、EOF (End Of File) に達したか、
92            // 接続が切断されたことを示します。
93            if ($peekedData === '' || $peekedData === false) {
94                echo "クライアント #{$clientId} が切断しました。\n";
95                // 監視リストとクライアントリストから削除し、ソケットを閉じます。
96                unset($reads[$clientId], $clients[$clientId]);
97                fclose($client);
98                continue;
99            }
100
101            // 覗き見したデータを表示します。このデータはまだソケットバッファに残っています。
102            echo "クライアント #{$clientId} からの覗き見データ: '{$peekedData}'\n";
103
104            // 実際にデータをソケットバッファから読み取ります。
105            // STREAM_PEEKなしで呼び出すか、fread() を使うと、データはバッファから消費されます。
106            $receivedData = fread($client, 1024);
107
108            // 受信データが空文字列の場合、クライアントがデータを送信していないか、切断された可能性があります。
109            if ($receivedData === '' || $receivedData === false) {
110                // 通常、peekedData があったのにreceivedDataがない場合は異常。
111                // ただし、非常に短い間隔で切断された場合などもありうる。
112                echo "クライアント #{$clientId} からデータを受信できませんでした。\n";
113                // 必要であれば、ここでクライアントを切断する処理を追加することもできます。
114                continue;
115            }
116
117            echo "クライアント #{$clientId} からの受信データ: '{$receivedData}'\n";
118
119            // 受信したデータをクライアントにエコーバックします。
120            fwrite($client, "Echo from server: '{$receivedData}'\n");
121        }
122    }
123
124    // メインループが終了した場合（通常はエラー時）、サーバーソケットを閉じます。
125    fclose($server);
126    echo "サーバーをシャットダウンしました。\n";
127}
128
129// 関数を実行します。
130runStreamSelectPeekServer();

このPHPサンプルコードは、stream_select関数とSTREAM_PEEK定数を利用し、TCPソケットサーバーを構築する例です。サーバーは指定されたポートで起動し、複数のクライアントからの接続やデータ受信をノンブロッキングで監視します。stream_selectは、読み込み可能になったストリームを効率的に特定するために利用されます。

STREAM_PEEKはPHPのストリーム関連の定数であり、引数はありません。この定数は、stream_socket_recvfrom関数などでデータを受信する際に使用するフラグで、戻り値は整数値です。STREAM_PEEKを使うと、ソケットの受信バッファからデータを一時的に「覗き見」することができます。重要なのは、覗き見されたデータはバッファから削除されず、そのまま残る点です。

サンプルコードでは、まずSTREAM_PEEKフラグを指定してクライアントからのデータを覗き見し、その内容をサーバーのコンソールに表示します。その後、改めてfread関数を使って同じデータをソケットバッファから実際に読み取り、クライアントにエコーバックしています。これにより、データを消費する前に内容を事前に確認し、柔軟な処理を行うことが可能です。このコードは、ノンブロッキングI/Oにおけるデータの効率的な処理と、STREAM_PEEKによるデータハンドリングの理解を深めるのに役立ちます。