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

Copy
1<?php
2
3/**
4 * PHPのストリーム関数 `stream_is_local` と `stream_socket_server` の使用例。
5 *
6 * stream_socket_server: サーバーソケットを作成し、ネットワーク接続をリッスンするためのストリームを生成します。
7 * stream_is_local: 指定されたストリームがローカルのストリーム（例: ファイル、TCP/IPソケットなど）であるかどうかをチェックします。
8 *
9 * このスクリプトは、ローカルアドレスにTCP/IPサーバーソケットを作成し、
10 * そのソケットがローカルストリームとして認識されることを示します。
11 */
12function demonstrateStreamIsLocal(): void
13{
14    // サーバーソケットを作成するアドレスとポートを定義
15    // 127.0.0.1 は「ローカルホスト」を意味し、自身のコンピュータのアドレスです。
16    // 8000 は一般的なテスト用のポート番号です。
17    $host = '127.0.0.1';
18    $port = 8000;
19    $address = "tcp://{$host}:{$port}";
20
21    echo "--- stream_is_local のデモンストレーション ---\n";
22    echo "サーバーソケットを {$address} で作成しようとしています...\n";
23
24    // stream_socket_server を使用してサーバーソケットを作成
25    // 第1引数: サーバーアドレス
26    // 第2引数: エラーコードを格納する変数（参照渡し）
27    // 第3引数: エラーメッセージを格納する変数（参照渡し）
28    // @ を付けて、stream_socket_server が失敗した際に出るPHPの警告を抑制します。
29    $serverSocket = @stream_socket_server($address, $errno, $errstr);
30
31    if (!$serverSocket) {
32        // ソケットの作成に失敗した場合のエラー処理
33        echo "エラー: サーバーソケットの作成に失敗しました。\n";
34        echo "エラーコード: {$errno}, メッセージ: {$errstr}\n";
35        echo "既にポート {$port} が使用されているか、他の問題が発生している可能性があります。\n";
36        return;
37    }
38
39    echo "サーバーソケットが正常に作成されました。\n";
40    echo "これで、外部からの接続を待機できる状態になりました。\n";
41
42    // stream_is_local を使用して、作成したソケットストリームがローカルであるかを確認
43    // 戻り値は bool (真偽値) で、true ならローカル、false ならリモート（ネットワーク経由など）です。
44    $isLocal = stream_is_local($serverSocket);
45
46    if ($isLocal) {
47        echo "確認結果: stream_is_local() は TRUE を返しました。\n";
48        echo "これは、作成されたサーバーソケットがローカルストリームとして認識されていることを意味します。\n";
49    } else {
50        echo "確認結果: stream_is_local() は FALSE を返しました。\n";
51        echo "これは通常、リモート接続など、ローカルではないストリームで発生します。\n";
52    }
53
54    // デモンストレーションが完了したので、ソケットを閉じます。
55    // これにより、ポートが解放され、他のプロセスが使用できるようになります。
56    fclose($serverSocket);
57    echo "サーバーソケットを閉じました。\n";
58    echo "--- デモンストレーション終了 ---\n";
59}
60
61// 関数を実行してデモンストレーションを開始
62demonstrateStreamIsLocal();
63
64?>

このPHPコードは、stream_is_local関数が指定されたストリームがローカルであるか（自身のコンピュータ上で動作しているか）を判定する仕組みをデモンストレーションしています。stream_is_localは、引数にストリームリソース（例：ファイル、ソケットなど）を取り、そのストリームがローカルであればtrue（真）、そうでなければfalse（偽）を戻り値として返します。

サンプルではまず、stream_socket_server関数を用いて、自身のコンピューターの特定ポート（例：127.0.0.1:8000）にTCP/IPサーバーソケットを作成しています。stream_socket_serverは、指定したアドレスでネットワークからの接続を待ち受けるための新しいストリームリソースを生成する役割があります。

ソケットが無事に作成されると、その結果として得られるストリームリソースをstream_is_local関数に渡して判定を行います。自身のコンピューター上に直接作成されたソケットであるため、stream_is_localはtrueを返し、これがローカルストリームとして正しく認識されることを示しています。コードはソケット作成時のエラー処理や、デモンストレーション後にソケットを適切に閉じる手順も含んでおり、一連の処理の流れを分かりやすく示しています。

Copy
1<?php
2
3/**
4 * PHPのストリーム関連関数、特に stream_is_local と stream_set_timeout の使い方を
5 * ネットワークストリームとローカルストリームの両方の例で示します。
6 *
7 * システムエンジニアを目指す初心者が理解しやすいように、各ステップにはコメントを付けています。
8 */
9function demonstrateStreamFunctions(): void
10{
11    echo "--- ネットワークストリーム (リモートホスト) の例 ---" . PHP_EOL;
12
13    // リモートホスト（例: www.google.com のポート80）へのソケット接続を試みます。
14    // この種類のストリームは「ローカルではない」と見なされます。
15    $remoteHost = 'www.google.com';
16    $remotePort = 80;
17    $connectionTimeoutSeconds = 5; // 接続試行のタイムアウト
18
19    echo "{$remoteHost}:{$remotePort} への接続を試行中..." . PHP_EOL;
20    $socket = fsockopen($remoteHost, $remotePort, $errno, $errstr, $connectionTimeoutSeconds);
21
22    if ($socket === false) {
23        // 接続に失敗した場合の処理
24        echo "エラー: 接続に失敗しました ({$errno}) {$errstr}" . PHP_EOL;
25        echo "ネットワークストリームのデモンストレーションはスキップします。" . PHP_EOL;
26    } else {
27        echo "接続成功。" . PHP_EOL;
28
29        // stream_set_timeout(): ストリームの読み書き操作のタイムアウトを設定します。
30        // ネットワークストリームにおいて、データが来ない場合にいつまで待つかを定義するのに役立ちます。
31        // ここでは、1秒と500ミリ秒 (合計1.5秒) をタイムアウトに設定します。
32        if (stream_set_timeout($socket, 1, 500000)) { // 1秒500ミリ秒 (1秒 + 500000マイクロ秒)
33            echo "ストリームの読み書きタイムアウトを1.5秒に設定しました。" . PHP_EOL;
34        } else {
35            echo "ストリームのタイムアウト設定に失敗しました。" . PHP_EOL;
36        }
37
38        // stream_is_local(): ストリームがローカルファイルシステム上のリソースであるかを確認します。
39        // リモートホストへのソケット接続はローカルではないため、falseが返されることを期待します。
40        if (stream_is_local($socket)) {
41            echo "このストリームはローカルです (期待とは異なります)。" . PHP_EOL;
42        } else {
43            echo "このストリームはローカルではありません (期待通りです)。" . PHP_EOL;
44        }
45
46        // ストリームを閉じます。
47        fclose($socket);
48        echo "接続を閉じました。" . PHP_EOL;
49    }
50
51    echo PHP_EOL . "--- ローカルストリーム (一時ファイル) の例 ---" . PHP_EOL;
52
53    // 一時ファイルを作成します。これはローカルファイルシステム上のストリームであり、
54    // 「ローカルな」ストリームの典型的な例です。
55    $localStream = tmpfile(); // 一時ファイルを自動的に作成し、リソースを返します
56
57    if ($localStream === false) {
58        echo "エラー: 一時ファイルの作成に失敗しました。" . PHP_EOL;
59        echo "ローカルストリームのデモンストレーションはスキップします。" . PHP_EOL;
60    } else {
61        echo "一時ファイルをオープンしました。" . PHP_EOL;
62
63        // ローカルファイルストリームに対しても stream_set_timeout は適用できますが、
64        // その効果はオペレーティングシステムやPHPの設定に依存し、ネットワークストリームほど直接的ではありません。
65        // ファイルの読み書きにおけるタイムアウトは通常、ファイルシステムではなくネットワークI/Oでより重要です。
66        if (stream_set_timeout($localStream, 2)) { // 2秒のタイムアウトを設定
67            echo "ローカルストリームのタイムアウトを2秒に設定しました。(ファイルI/Oにはあまり直接的な影響がない場合が多い)" . PHP_EOL;
68        } else {
69            echo "ローカルストリームのタイムアウト設定に失敗しました。" . PHP_EOL;
70        }
71
72        // stream_is_local(): 一時ファイルはローカルファイルシステム上にあるため、trueが返されることを期待します。
73        if (stream_is_local($localStream)) {
74            echo "このストリームはローカルです (期待通りです)。" . PHP_EOL;
75        } else {
76            echo "このストリームはローカルではありません (期待とは異なります)。" . PHP_EOL;
77        }
78
79        // ストリームを閉じます。tmpfile() で作成されたファイルは閉じられると自動的に削除されます。
80        fclose($localStream);
81        echo "一時ファイルを閉じました。(ファイルは自動的に削除されます)" . PHP_EOL;
82    }
83}
84
85// 関数を実行して、デモンストレーションを開始します。
86demonstrateStreamFunctions();

PHPのstream_is_local関数は、指定されたストリームリソースがローカルファイルシステム上のリソースであるかどうかを判定する際に使用されます。この関数は引数としてストリームリソースを受け取り、ローカルであればtrue、そうでなければfalseのブール値を返します。サンプルコードでは、リモートホストへのソケット接続はローカルではないためfalseを、一時ファイルのようなローカルファイルシステム上のリソースに対してはtrueを返すことを示しています。

一方、stream_set_timeout関数は、ストリームの読み書き操作におけるタイムアウトを設定します。この関数もストリームリソースを最初の引数に取り、次に秒数、そしてオプションでマイクロ秒を指定します。これにより、データが一定時間内に利用できない場合に、操作が中断されるように設定できます。特にネットワークストリームでは、接続が応答しないことによるアプリケーションのフリーズを防ぐために有効です。ローカルファイルストリームにも設定できますが、その効果はネットワークI/Oほど直接的ではない場合があります。これらの関数を使い分けることで、さまざまな種類のストリームを適切に制御し、堅牢なアプリケーションを構築できます。