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

Copy
1<?php
2
3/**
4 * TCPソケットサーバーを起動し、クライアントからの接続を処理します。
5 *
6 * STREAM_IPPROTO_TCP は、PHPのストリーム拡張機能でTCPプロトコルを識別するための
7 * 整数定数です。stream_socket_server関数で "tcp://" スキームを使用すると、
8 * 内部的にこの定数が示すTCPプロトコルが利用されます。
9 *
10 * @param string $host サーバーがリッスンするホストアドレス (例: '0.0.0.0' はすべてのインターフェース)
11 * @param int $port サーバーがリッスンするポート番号 (例: 8000)
12 */
13function runTcpServer(string $host, int $port): void
14{
15    // サーバーがリッスンするアドレスとポートを定義します。
16    // "tcp://" プレフィックスは、STREAM_IPPROTO_TCP が示すTCPプロトコルを使用することをPHPに伝えます。
17    $serverAddress = "tcp://{$host}:{$port}";
18
19    // stream_socket_server関数を使用してTCPソケットサーバーを作成します。
20    // STREAM_SERVER_BIND は指定されたアドレスにバインドすることを、
21    // STREAM_SERVER_LISTEN は接続待ち状態にすることを意味します。
22    // @ を付けてエラーメッセージを抑制し、独自のハンドリングを行います。
23    $server = @stream_socket_server($serverAddress, $errno, $errstr, STREAM_SERVER_BIND | STREAM_SERVER_LISTEN);
24
25    if (false === $server) {
26        echo "エラー: TCPサーバーの起動に失敗しました ({$errno}) {$errstr}\n";
27        return;
28    }
29
30    echo "TCPサーバーが {$serverAddress} で起動しました。\n";
31    echo "このサーバーは、`STREAM_IPPROTO_TCP` 定数によって識別されるTCPプロトコルを使用しています。\n";
32    echo "クライアントからの接続を待っています...\n\n";
33
34    // サーバーが停止しないように無限ループでクライアントからの接続を待ちます。
35    while (true) {
36        // stream_socket_accept関数でクライアントからの接続要求を受け入れます。
37        // 第2引数に -1 を指定すると、接続があるまで無限に待ちます。
38        $client = @stream_socket_accept($server, -1);
39
40        if (false === $client) {
41            echo "警告: クライアント接続の受け入れ中にエラーが発生しました。\n";
42            continue; // 次の接続待ちへ
43        }
44
45        // 接続してきたクライアントの情報を取得して表示します。
46        echo "新しいクライアントが接続しました: " . stream_socket_get_name($client, true) . "\n";
47
48        // クライアントへウェルカムメッセージを送信します。
49        fwrite($client, "PHP TCP Server へようこそ！'exit'と入力すると切断します。\n");
50
51        // クライアントからのデータを読み込み、エコーバックする簡単なループ
52        while (!feof($client)) {
53            $data = fread($client, 1024); // 最大1024バイト読み込み
54
55            if (false === $data || $data === '') {
56                break; // データがないか、エラーが発生した場合はループを抜ける
57            }
58
59            $trimmedData = trim($data);
60            echo "受信: {$trimmedData}\n";
61
62            // クライアントが 'exit' と入力したら接続を終了します。
63            if (strtolower($trimmedData) === 'exit') {
64                fwrite($client, "サーバーから切断します。さようなら！\n");
65                break;
66            }
67
68            // クライアントに受信したメッセージを返信します。
69            fwrite($client, "サーバーからの返信: あなたは '{$trimmedData}' と言いました。\n");
70        }
71
72        // クライアントとの接続を閉じます。
73        fclose($client);
74        echo "クライアントが切断しました。\n\n";
75    }
76
77    // (この例では無限ループのため通常到達しませんが、サーバーを停止する際は必要です)
78    // fclose($server);
79}
80
81// サーバーを起動します。
82// 例として、すべてのネットワークインターフェース ('0.0.0.0') のポート 8000 でリッスンします。
83runTcpServer('0.0.0.0', 8000);

このサンプルコードは、PHPで基本的なTCPソケットサーバーを構築し、クライアントからの接続を処理する方法を示しています。STREAM_IPPROTO_TCPは、PHPのストリーム拡張機能においてTCPプロトコルを識別するための整数定数です。この定数自体は引数を取らず、TCPプロトコルを表す整数値（int）を返します。

コードの中心となるrunTcpServer関数は、サーバーがリッスンするホストアドレス（string $host）とポート番号（int $port）を引数として受け取ります。この関数はvoidを戻り値とし、直接的な値を返さずにサーバーの起動と接続処理を実行します。

サーバーは"tcp://{$host}:{$port}"という形式のアドレス文字列を使用してstream_socket_server関数を呼び出し、起動します。この"tcp://"プレフィックスが指定されることで、PHPは内部的にSTREAM_IPPROTO_TCP定数が示すTCPプロトコルを利用してソケットを作成します。これにより、開発者が直接プロトコル定数を指定する手間が省かれ、簡単にTCPサーバーを構築できます。

サーバーが起動すると、無限ループでstream_socket_accept関数を使ってクライアントからの接続を待ち受けます。新しいクライアントが接続すると、ウェルカムメッセージを送信し、クライアントからのデータを読み取ってエコーバックします。クライアントが「exit」と入力すると接続は閉じられ、次の接続待ちに戻ります。このコードは、ネットワーク通信の基本的な仕組みを理解し、PHPでサーバーアプリケーションを開発する際の第一歩として役立ちます。

Copy
1<?php
2
3/**
4 * 指定されたホストとポートにTCP接続を試み、簡単なデータを送受信する関数。
5 * STREAM_IPPROTO_TCP 定数を使用して、ストリームコンテキストでTCPプロトコルを明示的に指定します。
6 *
7 * @param string $host 接続するホスト名またはIPアドレス
8 * @param int $port 接続するポート番号
9 * @param int $timeout 接続タイムアウト（秒）
10 * @return void
11 */
12function connectToServerWithTcpProto(string $host, int $port, int $timeout = 5): void
13{
14    echo "Attempting to connect to {$host}:{$port} using TCP protocol...\n";
15
16    // ストリームコンテキストを作成し、ソケットオプションを設定します。
17    // 'socket' オプション配列内の 'protocol' キーに STREAM_IPPROTO_TCP 定数を指定することで、
18    // 接続にTCPプロトコルを使用することを明示しています。
19    $context = stream_context_create([
20        'socket' => [
21            'protocol' => STREAM_IPPROTO_TCP, // TCPプロトコルを指定する定数
22        ],
23    ]);
24
25    $errno = 0;     // エラーコードを格納する変数
26    $errstr = '';   // エラーメッセージを格納する変数
27
28    // stream_socket_client 関数を使用してソケット接続を確立します。
29    // 第1引数: 接続先のURI ("tcp://ホスト名:ポート番号")
30    // 第2引数: エラーコードを格納する参照変数
31    // 第3引数: エラーメッセージを格納する参照変数
32    // 第4引数: 接続タイムアウト時間（秒）
33    // 第5引数: ストリームの振る舞いを設定するフラグ（ここではクライアント接続）
34    // 第6引数: 作成したストリームコンテキスト
35    $clientSocket = stream_socket_client(
36        "tcp://{$host}:{$port}",
37        $errno,
38        $errstr,
39        $timeout,
40        STREAM_CLIENT_CONNECT,
41        $context
42    );
43
44    if (!$clientSocket) {
45        // 接続に失敗した場合
46        echo "Error: Could not connect to {$host}:{$port}. ({$errno}) {$errstr}\n";
47        return;
48    }
49
50    echo "Successfully connected to {$host}:{$port}!\n";
51
52    // 接続が成功したら、簡単なデータを送信してみます。
53    $message = "GET / HTTP/1.0\r\nHost: {$host}\r\n\r\n"; // HTTP GETリクエストの例
54    echo "Sending data:\n{$message}";
55    fwrite($clientSocket, $message);
56
57    // サーバーからの応答を読み込みます（最大1024バイト）。
58    echo "Waiting for server response...\n";
59    $response = fread($clientSocket, 1024);
60
61    if ($response !== false && $response !== '') {
62        echo "Received response:\n{$response}\n";
63    } else {
64        echo "No response received or an error occurred while reading.\n";
65    }
66
67    // ソケット接続を閉じます。
68    fclose($clientSocket);
69    echo "Connection closed.\n";
70}
71
72// === 関数使用例 ===
73// 実際のWebサーバー (例: www.example.com のポート80) に接続を試みます。
74// これは生のTCP接続であり、サーバーが正しく応答するには適切なプロトコル（この場合はHTTP）
75// でリクエストを送信する必要があります。
76$targetHost = 'www.example.com'; // 接続先のホスト名
77$targetPort = 80;                // 接続先のポート番号 (HTTPの標準ポート)
78$connectionTimeout = 5;          // 接続タイムアウト（秒）
79
80connectToServerWithTcpProto($targetHost, $targetPort, $connectionTimeout);
81
82echo "\n--- Attempting to connect to a non-existent host (will fail) ---\n";
83connectToServerWithTcpProto('nonexistent.invalid', 80, 2);
84
85?>

このPHPサンプルコードは、STREAM_IPPROTO_TCP定数とstream_socket_client関数を用いて、指定されたホストとポートにTCP接続を確立し、簡単なデータの送受信を行う方法を示しています。

STREAM_IPPROTO_TCPは、TCPプロトコル（Transmission Control Protocol）を明示的に指定するための整数型（int）の定数です。この定数は、stream_context_create関数で作成するストリームコンテキスト内で利用されます。ストリームコンテキストは、ソケット接続に関する詳細なオプションを設定するために使用され、特に'socket'オプションの'protocol'キーにSTREAM_IPPROTO_TCPを指定することで、PHPにTCPプロトコルでの接続を指示します。

stream_socket_client関数は、指定されたURI（例えば「tcp://ホスト名:ポート番号」）に対してクライアントソケット接続を確立します。この関数は、接続先の情報、エラーコードやエラーメッセージを受け取るための参照変数、接続タイムアウト時間、接続の種類を示すフラグ、そしてオプションでストリームコンテキストを引数として受け取ります。接続に成功するとソケットを表すリソースを返し、失敗した場合はfalseを返します。

コードでは、まずストリームコンテキストを作成し、その中にSTREAM_IPPROTO_TCPを設定してstream_socket_client関数でサーバーへの接続を試みます。接続が成功した場合、fwrite関数を使ってサーバーにデータを送信し、fread関数でサーバーからの応答を読み込みます。通信が完了すると、fclose関数でソケット接続を安全に閉じます。この一連の流れにより、TCPを用いた基本的なネットワーク通信の仕組みを理解できます。