【PHP8.x】socket_get_status()関数の使い方

Copy
1<?php
2
3// ソケットサーバーのホストとポート
4$host = '127.0.0.1';
5$port = 12345;
6
7/**
8 * ノンブロッキングなストリームソケットサーバーの例。
9 * socket_get_status と stream_select を組み合わせて、
10 * 接続されたストリームの状態を取得しつつI/O多重化を実現します。
11 *
12 * キーワードの 'php socket_select' はソケット拡張の関数ですが、
13 * socket_get_status はストリームリソース（ファイルポインタ）を対象とするため、
14 * 機能が類似しているストリーム拡張の stream_select を使用します。
15 * PHP 8では、socket_create()で作成されたSocketオブジェクトは
16 * socket_get_status()の引数としては使用できません。
17 * このコードは、stream_socket_server()で作成されるストリームリソースを
18 * socket_get_status()に渡して使用する例です。
19 */
20function runStreamSelectSocketServer(string $host, int $port): void
21{
22    // ストリームソケットサーバーを作成
23    // "tcp://..." スキームを使用して TCP ソケットストリームを作成します。
24    $server = stream_socket_server("tcp://{$host}:{$port}", $errno, $errstr);
25    if (false === $server) {
26        die("Could not create server socket: {$errstr} ({$errno})\n");
27    }
28
29    // サーバーソケットをノンブロッキングモードに設定
30    // これにより、accept() や read() がすぐに戻り、他の処理をブロックしません。
31    stream_set_blocking($server, false);
32
33    echo "Listening on tcp://{$host}:{$port}\n";
34
35    $clients = []; // 接続されているクライアントストリームを保持する配列
36    $readStreams = [$server]; // stream_select で監視する読み込み可能なストリームの初期値（サーバー自身）
37
38    while (true) {
39        // stream_select の引数は参照渡しのため、ループごとに配列をコピー
40        $currentReadStreams = $readStreams;
41        $writeStreams = []; // この例では書き込み可能なストリームは監視しない
42        $exceptStreams = []; // この例では例外発生ストリームは監視しない
43
44        // stream_select で読み込み可能なストリームを待つ (タイムアウトは1秒)
45        // 戻り値は変更されたストリームの数、エラー時は false
46        $numChangedStreams = stream_select($currentReadStreams, $writeStreams, $exceptStreams, 1);
47
48        if ($numChangedStreams === false) {
49            echo "stream_select() failed.\n";
50            break;
51        }
52
53        if ($numChangedStreams === 0) {
54            // タイムアウト、何も起こらなかった場合は次のループへ
55            continue;
56        }
57
58        // 変更されたストリームを処理
59        foreach ($currentReadStreams as $stream) {
60            if ($stream === $server) {
61                // サーバーソケットにイベントがあった場合、新しいクライアント接続
62                $client = stream_socket_accept($server);
63                if (false === $client) {
64                    echo "stream_socket_accept() failed.\n";
65                    continue;
66                }
67                // 新しいクライアントソケットもノンブロッキングに設定
68                stream_set_blocking($client, false); 
69                $clients[] = $client;
70                $readStreams[] = $client; // 監視対象に追加
71                echo "Client connected: " . stream_socket_get_name($client, true) . "\n";
72                fwrite($client, "Welcome to the PHP stream server!\n");
73
74                // 新規接続のストリーム状態を socket_get_status で取得し表示
75                $status = socket_get_status($client);
76                if ($status !== false) {
77                    echo "  New client stream status: " . json_encode($status) . "\n";
78                } else {
79                    echo "  Failed to get status for new client stream.\n";
80                }
81
82            } else {
83                // 既存クライアントからのデータ受信、または切断
84                $data = fread($stream, 1024); // 最大1024バイト読み込み
85                if ($data === false || $data === '') {
86                    // クライアントが切断したか、読み込みエラーが発生
87                    // 監視対象とクライアントリストから削除し、ソケットをクローズ
88                    $index = array_search($stream, $clients);
89                    if ($index !== false) {
90                        unset($clients[$index]);
91                    }
92                    $index = array_search($stream, $readStreams);
93                    if ($index !== false) {
94                        unset($readStreams[$index]);
95                    }
96                    fclose($stream);
97                    echo "Client disconnected: " . stream_socket_get_name($stream, true) . "\n";
98                } else {
99                    // クライアントからデータを受信した場合
100                    $message = trim($data);
101                    echo "Received from client " . stream_socket_get_name($stream, true) . ": " . $message . "\n";
102                    fwrite($stream, "Server received: " . $message . "\n");
103
104                    // データ受信後のストリーム状態を socket_get_status で取得し表示
105                    $status = socket_get_status($stream);
106                    if ($status !== false) {
107                        echo "  Client stream status after read: " . json_encode($status) . "\n";
108                    } else {
109                        echo "  Failed to get status for client stream after read.\n";
110                    }
111                }
112            }
113        }
114    }
115
116    // サーバーソケットをクローズ
117    fclose($server);
118    echo "Server stopped.\n";
119}
120
121// サーバーを起動
122runStreamSelectSocketServer($host, $port);
123

PHPのsocket_get_status関数は、指定されたストリームリソースの状態に関する詳細な情報を配列で取得する関数です。処理が失敗した場合はfalseを返します。引数にはstream_socket_serverやstream_socket_acceptなどで作成されたストリームリソース（ファイルポインタ）を渡します。PHP 8では、socket_createで作成されたSocketオブジェクトは直接この関数の引数としては使用できません。

このサンプルコードは、ノンブロッキングなTCPストリームソケットサーバーの動作例です。複数のクライアントからの接続やデータ受信を効率的に処理するため、stream_select関数によるI/O多重化を利用しています。キーワードとして示されたphp socket_selectはソケット拡張の関数ですが、socket_get_statusがストリームリソースを対象とするため、本コードではストリーム拡張のstream_selectを使用しています。

コード中では、新しいクライアントがサーバーに接続された直後や、クライアントからデータを受信した後にsocket_get_statusを呼び出しています。これにより、その時点のストリームの状態（例えば、バッファの状況やEOFフラグなど）を具体的な配列情報として確認でき、ネットワーク通信の状態を把握するのに役立ちます。

Copy
1<?php
2
3/**
4 * ストリームソケットからのデータ送受信と、そのストリームの状態取得の例を示します。
5 *
6 * この関数は、TCP/IPソケット（ストリームリソース）を介してHTTPリクエストを送信し、
7 * サーバーからの応答を受信した後、socket_get_status() 関数を使用して
8 * ストリームの状態を取得する方法を実演します。
9 * キーワードの 'socket_recv' は、この例では fread() によるソケットからのデータ受信操作に対応します。
10 */
11function demonstrateSocketGetStatus(): void
12{
13    // 接続先ホストとポート
14    // ローカル環境でウェブサーバーが動いていれば localhost:80 に接続できます。
15    // 必要に応じて、動作しているサーバーのIPアドレスやポートに変更してください。
16    $host = 'localhost';
17    $port = 80;
18
19    // テスト用のHTTP GETリクエストを作成
20    $request = "GET / HTTP/1.1\r\n";
21    $request .= "Host: {$host}\r\n";
22    $request .= "Connection: Close\r\n\r\n";
23
24    // fsockopen() を使用してソケットストリームをオープンします。
25    // これはストリームリソースを返し、socket_get_status() の引数として使用できます。
26    // @ を付けてエラーメッセージを抑制し、カスタムエラーハンドリングを行います。
27    $socketStream = @fsockopen($host, $port, $errno, $errstr, 5);
28
29    if (!$socketStream) {
30        echo "エラー: {$host}:{$port} への接続に失敗しました - {$errstr} ({$errno})\n";
31        return;
32    }
33
34    echo "{$host}:{$port} に接続しました。\n";
35
36    // データをソケットストリームに書き込み (送信)
37    if (fwrite($socketStream, $request) === false) {
38        echo "エラー: ソケットストリームへの書き込みに失敗しました。\n";
39        fclose($socketStream);
40        return;
41    }
42    echo "HTTPリクエストを送信しました。\n";
43
44    // ソケットストリームからデータを読み込み (受信)
45    // これは 'socket_recv' が示唆するソケットからのデータ受信操作に相当します。
46    $response = '';
47    echo "データを受信中...\n";
48    while (!feof($socketStream)) {
49        // 最大8192バイト（8KB）ずつ読み込みます。
50        $chunk = fread($socketStream, 8192);
51        if ($chunk === false) {
52            echo "エラー: ソケットストリームからの読み込みに失敗しました。\n";
53            break;
54        }
55        $response .= $chunk;
56    }
57    echo "データを受信しました。\n";
58    // 受信した応答全体を表示すると大量になる可能性があるため、コメントアウトしています。
59    // echo "受信した応答:\n" . substr($response, 0, 500) . (strlen($response) > 500 ? "..." : "") . "\n";
60
61    // socket_get_status() を使用してソケットストリームの状態を取得します。
62    // これはストリームに関する詳細な情報を含む配列を返します。
63    $status = socket_get_status($socketStream);
64
65    if ($status === false) {
66        echo "エラー: ソケットストリームの状態を取得できませんでした。\n";
67    } else {
68        echo "\nソケットストリームの状態:\n";
69        foreach ($status as $key => $value) {
70            // ブール値は 'true' または 'false' として表示
71            echo "  {$key}: " . (is_bool($value) ? ($value ? 'true' : 'false') : $value) . "\n";
72        }
73    }
74
75    // ソケットストリームを閉じます。
76    fclose($socketStream);
77    echo "\nソケットストリームを閉じました。\n";
78}
79
80// 関数を実行します。
81demonstrateSocketGetStatus();
82

socket_get_status関数は、PHP 8において利用できる、ストリームソケットの状態を取得するための関数です。この関数は、fsockopenなどの関数で開かれたストリームリソース（resource $stream）を引数に受け取ります。戻り値は、ソケットに関する詳細な情報を含む連想配列か、エラーが発生した場合はfalseとなります。

サンプルコードでは、まずfsockopen関数を使用してウェブサーバー（localhost:80など）へのTCP接続を確立し、HTTP GETリクエストを送信しています。サーバーからの応答は、fread関数を使ってソケットストリームから順次読み込まれます。このfreadによるデータ受信操作が、キーワードであるphp socket_recvが示すソケットからのデータ受信処理に相当します。

データ送受信が完了した後、socket_get_status関数が呼び出され、確立されたソケットストリームの現在の状態（例：接続が閉じているか、読み書き可能かなど）を取得しています。取得された状態情報は連想配列として返され、その内容が一覧表示されます。これにより、ソケット接続後のストリームの状態を具体的に把握することができ、デバッグやアプリケーションの振る舞いの理解に役立ちます。最後に、fclose関数でソケット接続を閉じています。