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

Copy
1<?php
2
3/**
4 * PHPのストリームトランスポート情報とストリームメタデータの取得例
5 *
6 * stream_get_transports() 関数でシステムがサポートするストリームトランスポートの一覧を取得します。
7 * その後、利用可能なTCPトランスポートを使用して実際にストリームを開き、
8 * stream_get_meta_data() 関数でそのストリームに関する詳細なメタデータを取得する方法を示します。
9 * これは、システムエンジニアを目指す初心者が、ネットワークストリームの基本と、
10 * PHPが提供するストリーム関連の情報を取得する手段を理解するのに役立ちます。
11 */
12function demonstrateStreamCapabilities(): void
13{
14    echo "### 利用可能なストリームトランスポート一覧 ###\n";
15
16    // stream_get_transports() は、システムで利用可能なストリームトランスポート（例: tcp, udp, ssl, tls）の
17    // リストを文字列の配列として返します。
18    $transports = stream_get_transports();
19
20    if (empty($transports)) {
21        echo "  利用可能なストリームトランスポートが見つかりませんでした。\n";
22        return;
23    }
24
25    foreach ($transports as $transport) {
26        echo "  - " . $transport . "\n";
27    }
28
29    echo "\n";
30
31    // キーワードとして指定された stream_get_meta_data との関連性を示すため、
32    // 実際にストリームを開いてそのメタデータを取得してみます。
33    // ここでは、一般的なTCPトランスポートを使用する例を示します。
34    if (in_array('tcp', $transports)) {
35        echo "### TCPトランスポートを使用してストリームを開き、メタデータを取得 ###\n";
36
37        // 公開されているテスト用のWebサーバー (example.com) のポート80に接続を試みます。
38        // stream_socket_client() は、ネットワークまたはUnixドメインソケット接続を開きます。
39        // @ はエラーを抑制し、$errno と $errstr でエラー情報を取得します。
40        $address = 'tcp://example.com:80';
41        $stream = @stream_socket_client($address, $errno, $errstr, 5); // タイムアウト5秒
42
43        if ($stream === false) {
44            echo "  ストリームのオープンに失敗しました: " . $errstr . " (エラーコード: " . $errno . ")\n";
45        } else {
46            echo "  ストリームが正常にオープンされました (" . $address . ")\n";
47
48            // stream_get_meta_data() は、開かれたストリームに関する詳細な情報を取得します。
49            // これには、トランスポートタイプ、バッファリング情報、タイムアウト、URIなどが含まれます。
50            $metaData = stream_get_meta_data($stream);
51
52            echo "  ストリームメタデータ:\n";
53            foreach ($metaData as $key => $value) {
54                // 配列型の値は、可読性のためカンマ区切りで表示します。
55                if (is_array($value)) {
56                    echo "    " . $key . ": [" . implode(', ', $value) . "]\n";
57                } elseif (is_bool($value)) {
58                    // 真偽値は 'true' または 'false' で表示します。
59                    echo "    " . $key . ": " . ($value ? 'true' : 'false') . "\n";
60                } else {
61                    echo "    " . $key . ": " . $value . "\n";
62                }
63            }
64
65            // オープンしたストリームは、必ず fclose() で閉じます。
66            fclose($stream);
67            echo "  ストリームが閉じられました。\n";
68        }
69    } else {
70        echo "### TCPトランスポートが利用できないため、ストリームのメタデータ取得例はスキップされます。 ###\n";
71    }
72}
73
74// スクリプトが実行されたときに、上記の関数を呼び出します。
75demonstrateStreamCapabilities();
76
77?>

PHPのstream_get_transports関数は、現在実行中のシステムがサポートしているストリームトランスポート（例: tcp, udp, sslなど）の一覧を文字列の配列として取得するものです。この関数は引数を取らず、利用可能なトランスポートのリストを配列で返します。

提供されたサンプルコードでは、まずこの関数を使ってシステムがサポートするストリームトランスポートを確認しています。その後、キーワードとして関連付けられたstream_get_meta_data関数との連携を示すため、実際にtcpトランスポートを使用して外部Webサーバーへストリーム接続を試みています。接続が成功した場合、stream_get_meta_data関数を用いて、開かれたストリームの詳細なメタデータ（トランスポートタイプ、バッファリング情報、タイムアウト、URIなど）を取得し、表示しています。この関数は開かれたストリームリソースを引数に取り、そのストリームに関する情報を連想配列で返します。

この例は、システムエンジニアを目指す初心者が、PHPで利用できるネットワークストリームの基本と、開かれたストリームの内部情報を確認する方法を理解するのに役立ちます。ストリームのトランスポートを把握し、そのメタデータを取得することで、プログラムがネットワーク通信をどのように扱っているかを詳細に把握できます。

Copy
1<?php
2
3/**
4 * PHPのストリームトランスポートの確認と、ストリームからの行読み込みの例を示します。
5 *
6 * stream_get_transports() を使用して利用可能なネットワークトランスポートプロトコルを確認し、
7 * stream_get_line() を使用して、開かれたソケットストリームからデータを1行ずつ読み取ります。
8 * この例では、一般的なHTTPサーバーに接続し、簡単なリクエストを送信してレスポンスを読み込みます。
9 */
10function demonstrateStreamOperations(): void
11{
12    // 1. stream_get_transports() で利用可能なソケットトランスポートの一覧を取得し表示
13    echo "--- 利用可能なストリームトランスポート ---" . PHP_EOL;
14    $transports = stream_get_transports();
15    foreach ($transports as $transport) {
16        echo "- " . $transport . PHP_EOL;
17    }
18    echo PHP_EOL;
19
20    // HTTPサーバーへの接続情報を設定
21    $host = 'www.example.com'; // テスト用ドメイン
22    $port = 80;                // HTTPの標準ポート
23    $timeout = 10;             // 接続タイムアウト（秒）
24
25    // TCPプロトコルを使用して接続アドレスを構築
26    $socketAddress = "tcp://{$host}:{$port}";
27
28    echo "--- {$socketAddress} への接続を試行中 ---" . PHP_EOL;
29
30    // 2. stream_socket_client() でTCPソケットストリームをオープン
31    //    第2引数にエラー番号、第3引数にエラーメッセージが格納される
32    $socket = stream_socket_client(
33        $socketAddress,
34        $errno,
35        $errstr,
36        $timeout
37    );
38
39    if (!$socket) {
40        // 接続に失敗した場合
41        echo "エラー: ソケット接続に失敗しました ({$errno}): {$errstr}" . PHP_EOL;
42        return;
43    }
44
45    echo "接続に成功しました。HTTPリクエストを送信します..." . PHP_EOL;
46
47    // 3. fwrite() で簡単なHTTP GETリクエストをソケットに書き込む
48    //    'Connection: close' ヘッダは、サーバーに接続を閉じるように要求します。
49    $request = "GET / HTTP/1.0\r\n";
50    $request .= "Host: {$host}\r\n";
51    $request .= "Connection: close\r\n"; // サーバーに接続終了を通知
52    $request .= "\r\n";                   // ヘッダの終わりを示す空行
53
54    fwrite($socket, $request);
55
56    echo "HTTPレスポンスを受信中..." . PHP_EOL;
57
58    // 4. stream_get_line() でソケットストリームからデータを1行ずつ読み込む
59    //    feof() はファイルの終端（ソケットが閉じられた場合も含む）に達したかを確認します。
60    //    第2引数は最大読み込みバイト数、第3引数は行の区切り文字です。
61    $lineNumber = 1;
62    while (!feof($socket) && ($line = stream_get_line($socket, 1024, "\r\n")) !== false) {
63        echo sprintf("Line %d: %s\n", $lineNumber++, $line);
64    }
65
66    // 5. ストリームを閉じる
67    fclose($socket);
68
69    echo "ストリームの読み込みが完了し、接続を閉じました。" . PHP_EOL;
70}
71
72// 関数を実行
73demonstrateStreamOperations();
74

このPHPコードは、現在の環境で利用可能なストリームトランスポートプロトコルを確認し、実際のネットワークストリームからデータを1行ずつ読み込む一連の操作を示しています。

最初に登場するstream_get_transports()関数は、PHPがサポートするネットワークソケットトランスポート（例: tcp, udp, sslなど）のリストを配列として返します。この関数は引数を必要とせず、利用可能なプロトコルの名前が格納された文字列の配列を戻り値として返します。これにより、どのような方法で外部と通信できるかを確認できます。

次に、コードはwww.example.comのHTTPサーバーにTCPで接続し、簡単なHTTP GETリクエストを送信しています。サーバーからのレスポンスを受信する際、stream_get_line()関数が活躍します。この関数は、開かれたストリームリソース（この場合はソケット）から、指定された最大バイト数まで、または指定された区切り文字（通常は改行コードなど）が見つかるまでデータを1行ずつ読み込みます。引数にはストリームリソース、最大読み込みバイト数、そして行の区切り文字を指定します。関数は読み込んだ文字列を返し、ストリームの終端に達したりエラーが発生したりした場合はfalseを返します。この例ではfeof()関数と組み合わせることで、ソケットの終端まで効率的にレスポンス全体を読み込み、表示しています。これにより、ネットワーク通信におけるデータ受信処理の基本を学ぶことができます。