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

Copy
1<?php
2
3/**
4 * PHPのストリーム機能を使い、STREAM_PF_INET で作成したソケットストリームに
5 * stream_filter_prepend でフィルターを適用するサンプルコードです。
6 *
7 * このコードは、単一ファイル内で簡単なソケット通信をシミュレートし、
8 * STREAM_PF_INET 定数の使用例と、ストリームフィルターの動作を
9 * システムエンジニアを目指す初心者にも分かりやすく示すことを目的としています。
10 */
11function runStreamFilterOnSocketExample(): void
12{
13    $host = '127.0.0.1'; // サーバーがリッスンするIPアドレス
14    $port = 8080;        // サーバーがリッスンするポート番号
15    $address = "tcp://{$host}:{$port}"; // 完全なソケットアドレス
16
17    // =======================================================================
18    // サーバー側の処理: ソケットを起動し、クライアントからの接続を待ちます。
19    // =======================================================================
20
21    // STREAM_PF_INET を使用して、IPv4インターネットプロトコルファミリーの
22    // サーバーソケットを作成します。
23    // stream_socket_server() は、指定されたアドレスで接続を待機するサーバーソケットを作成します。
24    // STREAM_SERVER_BIND はアドレスへのバインドを、STREAM_SERVER_LISTEN は接続の待機を開始します。
25    $server = @stream_socket_server($address, $errno, $errstr, STREAM_SERVER_BIND | STREAM_SERVER_LISTEN, STREAM_PF_INET);
26
27    if (!$server) {
28        // サーバーの起動に失敗した場合の処理
29        error_log("サーバーの起動に失敗しました: {$errstr} ({$errno})");
30        echo "エラー: サーバーを起動できませんでした。ポート {$port} は既に使用されているかもしれません。\n";
31        return;
32    }
33
34    echo "サーバーが {$address} で起動しました。\n";
35    echo "クライアントからの接続を待機中...\n";
36
37    // サーバーソケットを非ブロッキングモードに設定します。
38    // これにより、stream_socket_accept() が接続がない場合でもすぐに戻り、
39    // 他の処理を続けたり、ループで接続を待機したりできるようになります。
40    stream_set_blocking($server, false);
41
42    // =======================================================================
43    // クライアント側の処理: サーバーが起動するのを待ってから接続を試みます。
44    // =======================================================================
45
46    $client = null;
47    $maxAttempts = 10; // 接続試行回数の上限
48    $attempt = 0;      // 現在の試行回数
49
50    // サーバーが完全に起動し、接続を受け入れ可能になるまで、少し待機しながら接続を試みます。
51    while ($attempt < $maxAttempts && $client === null) {
52        usleep(100000); // 100ミリ秒待機
53        $attempt++;
54        // STREAM_PF_INET を使用して、IPv4インターネットプロトコルファミリーの
55        // クライアントソケットをサーバーに接続します。
56        // stream_socket_client() は、指定されたサーバーに接続を試みます。
57        $client = @stream_socket_client($address, $errno, $errstr, 1, STREAM_CLIENT_CONNECT, STREAM_PF_INET);
58    }
59
60    if (!$client) {
61        // クライアントがサーバーに接続できなかった場合の処理
62        error_log("クライアントの接続に失敗しました: {$errstr} ({$errno})");
63        echo "エラー: クライアントがサーバーに接続できませんでした。\n";
64        fclose($server); // サーバーソケットを閉じます
65        return;
66    }
67
68    echo "クライアントがサーバーに接続しました。\n";
69
70    // クライアントからサーバーへテストデータを送信します。
71    $originalMessage = "hello, php stream filter example!";
72    fwrite($client, $originalMessage . "\n"); // 改行を追加して送信
73    echo "クライアント: 「{$originalMessage}」を送信しました。\n";
74
75    // =======================================================================
76    // サーバー側の処理 (クライアント接続後): 接続されたストリームにフィルターを適用します。
77    // =======================================================================
78
79    $acceptedClientSocket = null;
80    $attempt = 0;
81    // サーバーがクライアントからの接続を受け入れます。
82    // 非ブロッキングモードのため、ループで接続を待機します。
83    while ($attempt < $maxAttempts && $acceptedClientSocket === null) {
84        $acceptedClientSocket = @stream_socket_accept($server, 1); // 1秒タイムアウトで接続を受け入れ
85        usleep(50000); // 50ミリ秒待機
86        $attempt++;
87    }
88
89    if (!$acceptedClientSocket) {
90        // サーバーがクライアント接続を受け入れられなかった場合の処理
91        error_log("サーバーがクライアント接続を受け入れられませんでした。");
92        echo "エラー: サーバーがクライアント接続を受け入れられませんでした。\n";
93        fclose($client);
94        fclose($server);
95        return;
96    }
97
98    echo "サーバー: クライアント接続を受け入れました。\n";
99
100    // 接続されたクライアントソケットストリームにフィルターを先頭に追加します。
101    // stream_filter_prepend() は、ストリームが読み込まれる前にデータを変換するフィルターを追加します。
102    // ここでは 'string.toupper' フィルターを使用して、受信した文字列を大文字に変換します。
103    if (stream_filter_prepend($acceptedClientSocket, 'string.toupper') === false) {
104        // フィルター追加に失敗した場合の処理
105        error_log("ストリームフィルターの追加に失敗しました。");
106        echo "エラー: ストリームフィルターの追加に失敗しました。\n";
107        fclose($acceptedClientSocket);
108        fclose($client);
109        fclose($server);
110        return;
111    }
112
113    echo "サーバー: 受信ストリームに 'string.toupper' フィルターを追加しました。\n";
114
115    // クライアントからのデータを受信します。
116    // フィルターが適用されているため、受信データは大文字に変換されます。
117    $receivedData = stream_get_contents($acceptedClientSocket);
118
119    // 受信データを表示します。rtrim() で末尾の改行を削除し、見やすくします。
120    echo "サーバー: 受信したデータ (フィルター適用後): " . rtrim($receivedData) . "\n";
121    echo "サーバー: 期待されるデータ (大文字): " . strtoupper(rtrim($originalMessage)) . "\n";
122
123    // =======================================================================
124    // 後処理: 開いたソケットを閉じます。
125    // =======================================================================
126
127    fclose($acceptedClientSocket);
128    echo "サーバー: クライアントとの接続を閉じました。\n";
129
130    fclose($client);
131    echo "クライアント: サーバーとの接続を閉じました。\n";
132
133    fclose($server);
134    echo "サーバー: サーバーソケットを閉じました。\n";
135}
136
137// 上記で定義した関数を実行し、サンプルコードの動作を確認します。
138runStreamFilterOnSocketExample();
139

このサンプルコードは、PHPのストリーム機能を用いた基本的なソケット通信において、STREAM_PF_INET定数とstream_filter_prepend関数の具体的な使い方を示しています。

STREAM_PF_INETは、ソケット通信でIPv4インターネットプロトコルファミリーを使用することを指定する定数です。この定数は引数を持たず、特定の戻り値もありませんが、stream_socket_server関数でサーバーソケットを作成する際や、stream_socket_client関数でクライアントソケットをサーバーに接続する際に使用され、通信のアドレスタイプを定義する重要な役割を果たします。

クライアントがサーバーに接続し、テストデータを送信した後、サーバー側ではstream_filter_prepend関数が利用されます。この関数は、指定されたストリームにフィルターを先頭に追加するものです。引数には対象のストリームリソースと適用するフィルター名を指定し、成功するとフィルターリソースを返し、失敗するとfalseを返します。サンプルでは、接続されたクライアントソケットストリームにstring.toupperフィルターが追加され、クライアントから送信された「hello, php stream filter example!」という文字列が、サーバーが読み込む直前に自動的に大文字の「HELLO, PHP STREAM FILTER EXAMPLE!」に変換されて表示されます。この一連の処理により、ネットワークを介したデータがストリームフィルターによってどのように加工されるかを分かりやすく理解できます。

Copy
1<?php
2
3/**
4 * PHPストリームフィルターの基本的な使い方と、
5 * ネットワークプロトコルファミリー定数 STREAM_PF_INET の利用例をデモンストレーションします。
6 *
7 * STREAM_PF_INET は、stream_socket_client や stream_context_create などで
8 * IPv4プロトコルファミリーを指定する際に使用される定数です。
9 * このサンプルでは、主に stream_filter_append の動作を示し、
10 * STREAM_PF_INET の存在と一般的な用途をコメントで説明します。
11 */
12function demonstrateStreamFilterUsage(): void
13{
14    // STREAM_PF_INET 定数の値を出力します。
15    // これはネットワークストリーム（ソケット）を作成する際に、IPv4プロトコルファミリーを指定するために使われます。
16    // 例: stream_context_create(['socket' => ['protocol_family' => STREAM_PF_INET]])
17    echo "STREAM_PF_INET 定数の値: " . STREAM_PF_INET . "\n\n";
18
19    // 一時的なメモリ内ストリームを作成します。
20    // これにより、実際のファイルシステムに影響を与えることなく、ストリーム操作をデモンストレーションできます。
21    $stream = fopen('php://memory', 'r+');
22    if (!$stream) {
23        echo "エラー: メモリストリームを開けませんでした。\n";
24        return;
25    }
26
27    // ストリームにフィルターを追加します。
28    // 'string.rot13' フィルターは、書き込まれたテキストにROT13変換を適用します。
29    // STREAM_FILTER_WRITE は、書き込み操作時にフィルターを適用することを示します。
30    $filter = stream_filter_append($stream, 'string.rot13', STREAM_FILTER_WRITE);
31
32    if (!$filter) {
33        echo "エラー: ストリームフィルターを追加できませんでした。\n";
34        fclose($stream);
35        return;
36    }
37
38    $originalString = 'Hello, PHP Streams!';
39    echo "元の文字列: '{$originalString}'\n";
40
41    // フィルターを介してストリームにデータを書き込みます。
42    // データは書き込まれる際に 'string.rot13' フィルターによって変換されます。
43    fwrite($stream, $originalString);
44
45    // ストリームポインタを先頭に戻し、書き込まれたデータを読み込む準備をします。
46    fseek($stream, 0);
47
48    // フィルターが適用された（ROT13変換された）データを読み込みます。
49    $filteredData = fread($stream, 1024);
50    echo "フィルター適用後の文字列 (ROT13): '{$filteredData}'\n";
51
52    // ストリームを閉じます。
53    fclose($stream);
54}
55
56// 関数を実行します。
57demonstrateStreamFilterUsage();

このサンプルコードは、PHPにおけるストリームフィルターの基本的な使い方と、ネットワークプロトコルファミリーを指定する定数STREAM_PF_INETの利用例を示しています。

STREAM_PF_INETは、stream_socket_clientなどの関数でIPv4プロトコルファミリーを指定する際に使用される定数です。これ自体に引数はなく、戻り値という概念もありませんが、特定の整数値を持ち、その値がプロトコルファミリーの識別子として機能します。サンプルでは、この定数の値を出力し、その役割を説明しています。

主要なデモンストレーションは、stream_filter_append関数によるストリームフィルターの適用です。まず、一時的なメモリ内ストリームを作成します。次に、stream_filter_append($stream, 'string.rot13', STREAM_FILTER_WRITE) を用いて、書き込み時に文字列をROT13変換するフィルターをストリームに追加しています。stream_filter_appendは、第一引数で指定されたストリームにフィルターを追加し、成功した場合はそのフィルターを表すリソースを、失敗した場合はfalseを返します。第三引数のSTREAM_FILTER_WRITEは、フィルターを書き込み操作に適用することを示します。これにより、元の文字列をストリームに書き込むと自動的にROT13変換が適用され、読み出し時には変換後のデータが取得できる様子が確認できます。このように、ストリームフィルターはデータの読み書き時に自動的な変換処理を実現します。