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

Copy
1<?php
2
3/**
4 * STREAM_SOCK_SEQPACKET 定数と、
5 * stream_socket_server を用いた基本的なTCPサーバーのサンプルコードです。
6 *
7 * STREAM_SOCK_SEQPACKET は、シーケンスパケット型ソケット（SOCK_SEQPACKET）を
8 * 示すための定数です。このタイプのソケットは、データグラム（UDPに似ている）でありながら、
9 * 信頼性、順序保証、非重複性を提供します（例: SCTPプロトコル）。
10 *
11 * 通常、PHPの stream_socket_server 関数では、'tcp://' や 'udp://' といった
12 * URIスキーマでソケットの種類を指定するため、この定数を直接引数として渡すことはありません。
13 * この定数は、より低レベルなソケット操作を行う socket_create() 関数などで、
14 * ソケットタイプとして利用されることを想定しています。
15 *
16 * このサンプルでは、stream_socket_server を使用して標準的なTCPサーバーを構築し、
17 * クライアントからの接続を待ち受け、簡単なメッセージを送受信します。
18 */
19function runBasicTcpServer(string $address = 'tcp://127.0.0.1:8000'): void
20{
21    // stream_socket_server を使用して、指定されたアドレスでサーバーソケットを作成します。
22    // 'tcp://' は、トランスポートとしてTCPを使用し、ソケットタイプがストリーム（STREAM_SOCK_STREAM）
23    // であることを内部的に指定します。
24    $server = stream_socket_server($address, $errorCode, $errorMessage);
25
26    if (false === $server) {
27        // サーバーの起動に失敗した場合のエラー処理
28        echo "サーバーの起動に失敗しました: {$errorMessage} (エラーコード: {$errorCode})" . PHP_EOL;
29        return;
30    }
31
32    echo "サーバーが {$address} で起動しました。クライアントの接続を待機中..." . PHP_EOL;
33
34    // サーバーが停止するまで無限ループでクライアントからの接続を待ち受けます
35    while (true) {
36        // stream_socket_accept() でクライアントからの接続を受け入れます。
37        // 接続があるまで処理はここでブロック（待機）されます。
38        $client = stream_socket_accept($server);
39
40        if (false === $client) {
41            // クライアント接続の受け入れに失敗した場合
42            echo "クライアント接続の受け入れに失敗しました。" . PHP_EOL;
43            continue; // 次の接続試行へ
44        }
45
46        echo "クライアントが接続しました。" . PHP_EOL;
47
48        // 接続してきたクライアントに歓迎メッセージを送信します
49        fwrite($client, "PHP TCP Server: Welcome!\n");
50
51        // クライアントから送信されたデータを読み取ります（最大1024バイト）
52        $data = fread($client, 1024);
53        if ($data !== false && $data !== '') {
54            echo "クライアントからのメッセージ: " . trim($data) . PHP_EOL;
55            // 受信確認のメッセージをクライアントに返します
56            fwrite($client, "PHP TCP Server: Your message was received.\n");
57        }
58
59        // クライアントとの接続を閉じます
60        fclose($client);
61        echo "クライアント接続を閉じました。" . PHP_EOL;
62    }
63
64    // 通常、上記の無限ループによりこのコードには到達しませんが、
65    // サーバーを適切にシャットダウンする際にはここでサーバーソケットを閉じます。
66    // fclose($server);
67}
68
69// サーバーを起動します。デフォルトのアドレスは 'tcp://127.0.0.1:8000' です。
70runBasicTcpServer();

PHPの定数STREAM_SOCK_SEQPACKETは、シーケンスパケット型ソケット（SOCK_SEQPACKET）を表す整数値です。このソケットは、データグラムのように独立したパケットを扱いますが、信頼性、順序保証、非重複性を提供する特徴があります。PHPのストリーム関数では直接使用されることは稀で、主にsocket_create()のような低レベルなソケット操作関数でソケットタイプを指定する際に利用されます。

このサンプルコードは、stream_socket_server関数を用いて基本的なTCPサーバーを構築する方法を示しています。stream_socket_serverは、第1引数で指定されたアドレス（例: 'tcp://127.0.0.1:8000'）とポートでサーバーソケットを作成し、クライアントからの接続を待ち受ける準備をします。成功時にはソケットリソースを、失敗時にはfalseを返します。第2、第3引数にはエラーコードとエラーメッセージが格納されます。

サーバーが起動すると、無限ループ内でstream_socket_accept関数が、第1引数で渡されたサーバーソケットに対しクライアントからの接続を待ち受けます。この関数は、新しいクライアント接続があるまで処理を一時停止し、接続が確立されると、そのクライアントとの通信に使う新しいソケットリソースを返します。その後、fwrite関数でメッセージを送信したり、fread関数でクライアントからのデータを受信したりします。fwriteは書き込んだバイト数を、freadは読み取ったデータを返します。通信が終わると、fclose関数でクライアントとの接続を閉じます。これにより、基本的なメッセージの送受信を行うTCPサーバーが動作します。

Copy
1<?php
2
3/**
4 * PHPのストリームにおけるブロッキング/ノンブロッキングモードの動作を実演する関数。
5 *
6 * stream_set_blocking() は、ストリームリソース（例: ソケット、ファイル）がデータを読み書きする際に、
7 * 操作が完了するまでプログラムの実行を待機するか（ブロッキング）、
8 * またはすぐに制御を返すか（ノンブロッキング）を決定します。
9 *
10 * リファレンス情報にある STREAM_SOCK_SEQPACKET は、int型の定数で、
11 * 特殊なソケットタイプ（シーケンシャルパケット、主にSCTP）を定義する際に socket_create() 関数と
12 * ともに使用されます。しかし、stream_set_blocking() はストリームリソースに適用されるため、
13 * この例では一般的なTCPストリームを使用してその動作を示します。
14 */
15function demonstrateStreamBlocking(): void
16{
17    $host = '127.0.0.1';
18    $port = 8000;
19    $serverAddress = "tcp://{$host}:{$port}";
20
21    // サーバーソケットを作成します。
22    // stream_socket_server() は、指定されたアドレスで接続を待機するストリームソケットを作成します。
23    $server = @stream_socket_server($serverAddress, $errno, $errstr);
24
25    if (!$server) {
26        // サーバー作成に失敗した場合のエラーハンドリング
27        echo "エラー: サーバーの作成に失敗しました: ($errno) $errstr\n";
28        return;
29    }
30
31    echo "サーバーが {$serverAddress} でリッスンを開始しました。\n";
32    echo "クライアントからの接続を待っています... (別のターミナルで 'netcat {$host} {$port}' などと入力してください)\n";
33
34    // クライアントからの接続を受け入れます。
35    // stream_socket_accept() は、新しい接続を待機し、接続が確立されるまでブロックします（デフォルト）。
36    // 第2引数を -1 に設定することで、無限に接続を待機します。
37    $client = @stream_socket_accept($server, -1);
38
39    if (!$client) {
40        // クライアント接続受け入れに失敗した場合のエラーハンドリング
41        echo "エラー: クライアント接続の受け入れに失敗しました。\n";
42        fclose($server);
43        return;
44    }
45
46    echo "クライアントが接続しました。\n";
47
48    // クライアントとの通信ストリームをノンブロッキングモードに設定します。
49    // stream_set_blocking($client, false) により、fread() などの読み込み操作は、
50    // データが利用可能でなくてもすぐに制御を返します。
51    if (!stream_set_blocking($client, false)) {
52        echo "エラー: クライアントストリームのノンブロッキング設定に失敗しました。\n";
53        fclose($client);
54        fclose($server);
55        return;
56    }
57
58    echo "クライアントストリームをノンブロッキングモードに設定しました。\n";
59    echo "ノンブロッキングモードでデータ読み取りを試行中...\n";
60
61    // ノンブロッキングモードでの読み取り試行ループ
62    // データがない場合でもプログラムはブロックされず、ループが続行されます。
63    $readAttempts = 0;
64    while ($readAttempts < 5) { // 5回試行
65        $data = fread($client, 1024);
66        if ($data === false || $data === '') {
67            echo "  データなし (またはエラー)。しばらく待機して再試行します。\n";
68            usleep(500000); // 0.5秒待機
69        } else {
70            echo "  データを受信しました: '{$data}'\n";
71            break; // データを受信したらループを抜けます
72        }
73        $readAttempts++;
74    }
75
76    // クライアントとの通信ストリームをブロッキングモードに戻します。
77    // stream_set_blocking($client, true) により、fread() などの読み込み操作は、
78    // データが利用可能になるまでプログラムの実行を停止します。
79    echo "\nクライアントストリームをブロッキングモードに戻します。\n";
80    if (!stream_set_blocking($client, true)) {
81        echo "エラー: クライアントストリームのブロッキング設定に失敗しました。\n";
82        fclose($client);
83        fclose($server);
84        return;
85    }
86
87    echo "ブロッキングモードでデータ読み取りを試行中... (クライアントからの入力を待機します)\n";
88    echo "（クライアントからデータが送信されるまで、このプログラムは一時停止します）\n";
89    $data = fread($client, 1024);
90    if ($data === false) {
91        echo "  ブロッキングモードでの読み取り中にエラーが発生しました。\n";
92    } else {
93        echo "  ブロッキングモードでデータを受信しました: '{$data}'\n";
94    }
95
96    echo "リソースをクリーンアップ中...\n";
97    fclose($client); // クライアントソケットを閉じます
98    fclose($server); // サーバーソケットを閉じます
99    echo "完了しました。\n";
100}
101
102// 関数を実行して、ストリームのブロッキング動作をデモンストレーションします。
103demonstrateStreamBlocking();

このサンプルコードは、PHPのstream_set_blocking関数を用いて、ストリームリソースがデータを読み書きする際の挙動を実演します。リファレンス情報にあるSTREAM_SOCK_SEQPACKETは、主に特定のソケットタイプ（シーケンシャルパケット）を定義する際に使われるint型の定数であり、本サンプルコードのstream_set_blockingとは直接関係はありませんが、PHPのストリーム関連機能の一部です。

stream_set_blocking関数は、ファイルやソケットなどのストリームリソースに対して、データの読み書き操作が完了するまでプログラムの実行を待機するか（ブロッキングモード）、またはすぐに制御を返すか（ノンブロッキングモード）を設定します。第1引数には対象となるストリームリソースを渡し、第2引数にはブロッキングモードにする場合はtrue、ノンブロッキングモードにする場合はfalseを指定します。関数は設定に成功した場合true、失敗した場合falseを整数値で返します。

コードでは、まずTCPサーバーを起動し、クライアントからの接続を確立します。次に、クライアントとの通信ストリームをノンブロッキングモードに設定すると、データがない場合でもfread関数がすぐに制御を返し、プログラムが待機せずに他の処理を続行できる様子が示されます。その後、ストリームをブロッキングモードに戻すと、fread関数はクライアントからデータが送信されるまでプログラムの実行を停止し、両モードの動作の違いが明確に理解できます。