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

Copy
1<?php
2
3/**
4 * UNIXドメインソケットのストリームに対して書き込みバッファリングを設定し、データ書き込みを行う関数。
5 *
6 * この関数は、`STREAM_PF_UNIX` が内部的に利用されるUNIXドメインソケットを作成し、
7 * そのソケットストリームに対して `stream_set_write_buffer` を適用するデモンストレーションを行います。
8 * システムエンジニアを目指す初心者にも分かりやすいように、コメントで詳細を説明しています。
9 *
10 * @param string $socketPath UNIXドメインソケットファイルのパス（一時ファイルとして使用）
11 * @return void
12 */
13function demonstrateStreamWriteBufferWithUnixSocket(string $socketPath): void
14{
15    // 以前の実行で残ったソケットファイルがあれば削除し、クリーンな状態にする
16    if (file_exists($socketPath)) {
17        unlink($socketPath);
18        echo "既存のソケットファイル '{$socketPath}' を削除しました。\n";
19    }
20
21    // サーバー側のUNIXドメインソケットを作成し、接続待ち状態にする
22    // 'unix://' スキームを使用すると、PHP は内部的に STREAM_PF_UNIX (UNIXプロトコルファミリ) を利用して
23    // ソケットを作成します。UNIXドメインソケットは、ファイルシステムパスを介してプロセス間通信を行います。
24    $server = @stream_socket_server("unix://$socketPath", $errno, $errstr);
25
26    if (!$server) {
27        echo "エラー: UNIXドメインソケットサーバーの作成に失敗しました: {$errstr} ({$errno})\n";
28        return;
29    }
30    // サーバーソケットをノンブロッキングモードに設定し、後続の処理に進める
31    stream_set_blocking($server, false);
32    echo "UNIXドメインソケットサーバーが '{$socketPath}' で起動しました。\n";
33
34    // クライアントとして同じUNIXドメインソケットに接続を試みる
35    // サーバーが完全に準備できていない可能性があるため、何度か接続を試行する
36    $client = null;
37    $maxAttempts = 5;
38    $attempt = 0;
39    while ($client === null && $attempt < $maxAttempts) {
40        $client = @stream_socket_client("unix://$socketPath", $errno, $errstr, 1); // 1秒タイムアウト
41        if ($client === null) {
42            echo "クライアント接続試行 {$attempt}/{$maxAttempts}回目... 待機中。\n";
43            usleep(200000); // 200ミリ秒待機
44            $attempt++;
45        }
46    }
47
48    if (!$client) {
49        echo "エラー: UNIXドメインソケットサーバーへの接続に失敗しました: {$errstr} ({$errno})\n";
50        fclose($server); // サーバーソケットを閉じる
51        unlink($socketPath); // ソケットファイルを削除
52        return;
53    }
54    echo "クライアントがUNIXドメインソケットに接続しました。\n";
55
56    // ここで stream_set_write_buffer を使用して、クライアントストリームの書き込みバッファリングを設定します。
57    // バッファサイズを 0 に設定すると、バッファリングが無効になり、書き込みは即座に行われます。
58    // 正の値を設定すると、指定されたバイト数のバッファが使用されます。
59    // -1 (デフォルト) は、システムのデフォルトバッファリングを使用します。
60    $bufferSize = 0; // 例: バッファリングを無効にする
61    if (stream_set_write_buffer($client, $bufferSize) === 0) {
62        echo "クライアントストリームの書き込みバッファリングを {$bufferSize} バイトに設定しました。\n";
63    } else {
64        echo "警告: 書き込みバッファリングの設定に失敗しました。\n";
65    }
66
67    // クライアントからデータをソケットに書き込む
68    $message = "これはUNIXドメインソケットを介したテストメッセージです。\n";
69    if (fwrite($client, $message) !== false) {
70        echo "クライアントから '{$message}' をソケットに書き込みました。\n";
71    } else {
72        echo "エラー: ソケットへの書き込みに失敗しました。\n";
73    }
74
75    // サーバー側でクライアントからの接続を受け入れ、書き込まれたデータを読み込む
76    $acceptedClient = stream_socket_accept($server, 1); // 1秒待機
77    if ($acceptedClient) {
78        echo "サーバーがクライアントからの接続を受け入れました。\n";
79        $readData = fread($acceptedClient, 1024); // 最大1024バイト読み込む
80        echo "サーバーが読み込んだデータ: '{$readData}'\n";
81        fclose($acceptedClient); // 受け入れたクライアント接続を閉じる
82    } else {
83        echo "サーバーはクライアントからの接続を受け入れられませんでした (タイムアウト)。\n";
84    }
85
86    // 開いたストリームとサーバーを閉じる
87    fclose($client);
88    fclose($server);
89
90    // ソケットファイルをクリーンアップ
91    unlink($socketPath);
92    echo "ソケット接続を閉じ、ファイル '{$socketPath}' を削除しました。\n";
93}
94
95// サンプル関数の実行
96// 一時的なファイルパスを使用してUNIXドメインソケットファイルを作成する
97$unixSocketPath = sys_get_temp_dir() . '/php_sample_unix_socket.sock';
98demonstrateStreamWriteBufferWithUnixSocket($unixSocketPath);
99
100?>

このPHPサンプルコードは、STREAM_PF_UNIXが内部的に利用されるUNIXドメインソケットによるプロセス間通信と、stream_set_write_buffer関数によるストリームの書き込みバッファリング設定をデモンストレーションします。

STREAM_PF_UNIXは、同じシステム内のプロセス間通信に特化したUNIXドメインソケットを作成する際に利用されるプロトコルファミリを示します。PHPでは、stream_socket_serverやstream_socket_clientでunix://スキームを指定することで、このソケットが使用され、ファイルパスを介した効率的なデータ交換が可能になります。

stream_set_write_buffer関数は、指定されたストリームリソース（第一引数）への書き込み操作において、内部的なバッファリングの挙動を制御します。第二引数でバッファサイズをバイト単位で指定し、0を設定するとバッファリングは無効化され、データは即座に書き込まれます。正の値を指定すると、そのバイト数のバッファが使用されます。成功時には0、失敗時には-1が戻り値として返されます。

このコードでは、まずUNIXドメインソケットのサーバーとクライアントを準備し、接続を確立します。その後、クライアント側のストリームに対してstream_set_write_bufferを適用し、書き込みバッファリングを無効にした状態でデータを書き込みます。サーバー側でそのデータを受け取り、読み込むことで、UNIXドメインソケットを通じたデータ通信が正しく行われ、バッファリング設定が適用されたことを確認できます。このサンプルは、プロセス間通信の基本とストリームの高度な制御方法を理解するのに役立ちます。

Copy
1<?php
2
3/**
4 * UNIXドメインソケットストリームにフィルタを適用するサンプルコード。
5 *
6 * この関数は、`STREAM_PF_UNIX` 定数を使用してUNIXドメインソケットを作成し、
7 * そのソケットストリームに `stream_filter_prepend` を用いてフィルタを適用する例を示します。
8 * システムエンジニアを目指す初心者にも分かりやすいよう、各ステップを簡潔に説明しています。
9 */
10function demonstrateUnixDomainSocketStreamFilter(): void
11{
12    // 1. 一時的なUNIXドメインソケットファイルのパスを生成
13    //    UNIXドメインソケットはファイルシステム上にソケットファイルを作成して通信します。
14    $socketPath = sys_get_temp_dir() . DIRECTORY_SEPARATOR . uniqid('php_uds_') . '.sock';
15
16    // 2. サーバーソケットの作成
17    //    "unix://$socketPath" はUNIXドメインソケットのアドレス形式です。
18    //    `STREAM_PF_UNIX` 定数により、UNIXドメインソケットプロトコルファミリーを指定しています。
19    $server = @stream_socket_server("unix://$socketPath", $errno, $errstr);
20    if (!$server) {
21        echo "エラー: UNIXドメインソケットサーバーの作成に失敗しました: ($errno) $errstr\n";
22        return;
23    }
24    echo "サーバーソケットを作成しました: $socketPath\n";
25
26    // サーバーソケットをノンブロッキングモードに設定し、クライアントからの接続を待機します。
27    // これにより、クライアントが接続を試みる際にサーバーがフリーズすることなく、
28    // 即座に次の処理（クライアント接続）に進むことができます。
29    stream_set_blocking($server, false);
30
31    // 3. クライアントソケットの作成とサーバーへの接続
32    //    タイムアウトを5秒に設定し、接続が確立するまで待機します。
33    $client = @stream_socket_client("unix://$socketPath", $errno, $errstr, 5);
34    if (!$client) {
35        fclose($server);
36        unlink($socketPath); // エラー時はソケットファイルを削除
37        echo "エラー: クライアントの接続に失敗しました: ($errno) $errstr\n";
38        return;
39    }
40    echo "クライアントがサーバーに接続しました。\n";
41
42    // 4. サーバー側でクライアント接続を受け入れ
43    //    ノンブロッキングモードのため、接続が確立するまで少し待機する場合があります。
44    //    数回リトライして接続の受け入れを試みます。
45    $acceptedClient = null;
46    $retries = 10; // 最大10回リトライ (計0.5秒*10=5秒待機)
47    while ($retries > 0 && $acceptedClient === null) {
48        $acceptedClient = stream_socket_accept($server, 0.5); // 0.5秒待機して接続を試行
49        if ($acceptedClient === false) {
50            $retries--;
51            usleep(50000); // 50ミリ秒待機
52        }
53    }
54
55    if (!$acceptedClient) {
56        fclose($client);
57        fclose($server);
58        unlink($socketPath);
59        echo "エラー: サーバーがクライアント接続を受け入れられませんでした。\n";
60        return;
61    }
62    echo "サーバーがクライアント接続を受け入れました。\n";
63
64    // --- stream_filter_prepend の使用例 ---
65    // ここからストリームフィルタを適用し、データの送受信がどのように変換されるかを確認します。
66
67    // 5. クライアント側: 送信ストリームに 'string.rot13' フィルタを追加
68    //    `stream_filter_prepend` は、ストリームにフィルタを連結し、
69    //    データがストリームを通過する際に変換処理を施します。
70    //    `string.rot13` は、テキストをROT13方式で変換する組み込みフィルタです。
71    echo "\n[クライアント側] 送信ストリームに 'string.rot13' フィルタを追加。\n";
72    stream_filter_prepend($client, 'string.rot13');
73
74    $originalMessage = "Hello, PHP Stream Filters!";
75    fwrite($client, $originalMessage); // クライアントがデータを送信
76    echo "[クライアント側] 送信データ (オリジナル): \"$originalMessage\"\n";
77
78    // 6. サーバー側: クライアントからデータを受信
79    //    サーバーの受信ストリームにはフィルタが適用されていないため、
80    //    ROT13変換されたデータがそのまま届きます。
81    $receivedRot13 = fread($acceptedClient, 1024);
82    echo "[サーバー側] 受信データ (ROT13済み): \"$receivedRot13\"\n";
83
84    // 7. サーバー側: 応答メッセージを送信する前に、送信ストリームに 'string.rot13' フィルタを追加
85    //    これにより、サーバーが書き込むデータもROT13で変換されて送信されます。
86    echo "[サーバー側] 送信ストリームに 'string.rot13' フィルタを追加。\n";
87    stream_filter_prepend($acceptedClient, 'string.rot13');
88
89    $responseMessage = "Server received and responded!";
90    fwrite($acceptedClient, $responseMessage); // サーバーが応答データを送信
91    echo "[サーバー側] 送信データ (オリジナル): \"$responseMessage\"\n";
92
93    // 8. クライアント側: 応答メッセージを受信する前に、受信ストリームに 'string.rot13' フィルタを追加
94    //    これにより、受信したROT13変換済みのデータは、フィルタによって元の形式に戻されます。
95    echo "[クライアント側] 受信ストリームに 'string.rot13' フィルタを追加。\n";
96    stream_filter_prepend($client, 'string.rot13');
97
98    $receivedResponse = fread($client, 1024); // クライアントが応答データを受信
99    echo "[クライアント側] 受信データ (フィルタ適用済み): \"$receivedResponse\"\n";
100
101    // 9. ストリームとソケットファイルをクリーンアップ
102    //    使用したリソースを解放し、一時ファイルを削除します。
103    fclose($acceptedClient);
104    fclose($client);
105    fclose($server);
106    unlink($socketPath);
107    echo "\nUNIXドメインソケットを閉じ、ソケットファイルを削除しました: $socketPath\n";
108    echo "サンプルコードの実行が完了しました。\n";
109}
110
111// 関数を実行してサンプルコードの動作を確認します。
112demonstrateUnixDomainSocketStreamFilter();

このサンプルコードは、PHPでUNIXドメインソケットを使用したプロセス間通信と、ストリームフィルタによるデータ変換の仕組みを解説しています。

STREAM_PF_UNIXはPHPの定数で、UNIXドメインソケットのプロトコルファミリーを指定するために利用されます。この定数は引数や戻り値を持たず、ファイルシステム上のソケットファイルを通じてプロセス間で通信を行うソケットを作成する際に、stream_socket_serverなどの関数に渡すことで、ソケットの種類を決定します。

コードではまず、UNIXドメインソケットファイルを作成し、サーバーソケットとクライアントソケットを確立して接続を行います。接続が確立された後、データの送受信にstream_filter_prepend関数が活用されます。

stream_filter_prependは、指定されたストリームにフィルタを追加し、データがストリームを通過する際に特定の変換処理を適用する関数です。この関数は、対象となるストリームと適用したいフィルタ名を引数として受け取り、フィルタが正常に適用されるとフィルタリソースを返します。サンプルでは、組み込みのstring.rot13フィルタを使用して、クライアントからサーバーへ、またサーバーからクライアントへの送受信データをROT13方式で自動的に変換しています。これにより、送信側でフィルタを適用したデータが、受信側で再びフィルタを適用することで元の形に戻る様子が確認でき、データの透過的な変換処理がどのように行われるかを示しています。