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

Copy
1<?php
2
3/**
4 * STREAM_IPPROTO_IP 定数を使用してストリームコンテキストを生成するサンプルコード。
5 *
6 * この定数は、IPプロトコルレベルを指定するための整数値です。
7 * PHPのストリームインターフェース（php streaminterface）におけるネットワーク通信で、
8 * 特に stream_context_create() 関数の 'socket' オプション内で、
9 * 生のIPソケット（RAWソケット）のプロトコル番号として使用されます。
10 * 通常、この定数の値は 0 で、これは特定のプロトコルではなくIP層自体を意味する場合や、
11 * プロトコルが未指定であることを示します。
12 *
13 * システムエンジニアを目指す初心者の方へ：
14 * PHPのストリームインターフェースは、ファイル、ネットワークソケット、その他多くの
15 * データソースを統一的に扱うための抽象化された仕組みです。
16 * stream_context_create() は、これらのストリームの動作を詳細に制御するための
17 * 設定情報（コンテキスト）を作成するために使われます。
18 */
19function demonstrateStreamIpprotoIpUsage(): void
20{
21    // STREAM_IPPROTO_IP 定数の値を確認します。
22    // この値は通常 0 であり、IPプロトコルそのものを指します。
23    echo "STREAM_IPPROTO_IP の値: " . STREAM_IPPROTO_IP . PHP_EOL;
24
25    // ストリームコンテキストオプションを定義します。
26    // 'socket' キーの下に、ネットワーク関連のオプションを設定します。
27    // 'ip_protocol' は、IPプロトコルレベルを数値で指定します。
28    // 例えば、ICMPの場合は 1、TCPの場合は 6、UDPの場合は 17 などですが、
29    // STREAM_IPPROTO_IP (0) は特定のプロトコルではなく、IP層全体を指すか
30    // デフォルトのプロトコル指定に任せる場合に使われます。
31    $contextOptions = [
32        'socket' => [
33            'ip_protocol' => STREAM_IPPROTO_IP,
34            // 実際のネットワーク接続では、他にも 'bindto', 'timeout' などの
35            // オプションが必要になる場合があります。
36            // この例では STREAM_IPPROTO_IP の利用に焦点を当てています。
37        ],
38    ];
39
40    // 定義したオプションを使ってストリームコンテキストを作成します。
41    // このコンテキストは、stream_socket_client() や stream_socket_server() などの
42    // 関数に渡して、ネットワークソケットの振る舞いをカスタマイズするために使用できます。
43    $context = stream_context_create($contextOptions);
44
45    if ($context) {
46        echo "ストリームコンテキストが正常に作成されました。" . PHP_EOL;
47
48        // 作成されたコンテキストから 'socket.ip_protocol' の設定値を取得して表示します。
49        $options = stream_context_get_options($context);
50        if (isset($options['socket']['ip_protocol'])) {
51            echo "作成されたコンテキストの 'socket.ip_protocol' 設定: " . $options['socket']['ip_protocol'] . PHP_EOL;
52        }
53        echo "このコンテキストは、ネットワークストリームの接続時に利用できます。" . PHP_EOL;
54    } else {
55        echo "ストリームコンテキストの作成に失敗しました。" . PHP_EOL;
56    }
57}
58
59// サンプル関数を実行します。
60demonstrateStreamIpprotoIpUsage();

STREAM_IPPROTO_IPは、PHPのストリームインターフェースでIPプロトコルレベルを指定するための定数です。この定数の戻り値は整数型です。通常、値は0であり、これは特定のプロトコルではなく、IP層全体を指すか、システムにプロトコルの選択を任せることを示します。

この定数は、主にstream_context_create()関数を使ってストリームコンテキストを生成する際に利用されます。特にネットワーク通信において、socketオプション内のip_protocolキーに設定することで、生のIPソケットのプロトコル番号を指定できます。PHPのストリームインターフェースは、ファイルやネットワークソケットといった様々なデータソースを統一的に扱う抽象化された仕組みであり、stream_context_create()は、これらのストリームの動作を詳細に制御するための設定（コンテキスト）を作成します。

サンプルコードでは、まずSTREAM_IPPROTO_IPの実際の値を確認しています。次に、この定数をip_protocolオプションに指定したストリームコンテキストのオプションを定義し、そのオプションを用いてstream_context_create()でコンテキストを作成します。作成されたコンテキストは、ネットワークソケット接続関数などに渡され、ソケットのプロトコルレベルをカスタマイズするために使用されます。これにより、IPプロトコル層の動作を柔軟に制御することが可能になります。

Copy
1<?php
2
3/**
4 * STREAM_IPPROTO_IP 定数を利用したシンプルなTCPサーバーを起動します。
5 *
6 * STREAM_IPPROTO_IP は、IPプロトコルファミリーを表す整数値です。
7 * stream_socket_server 関数では通常、URIスキーム (例: tcp://) によって使用する
8 * プロトコル (TCPやUDP) が指定されます。
9 * この定数を明示的にストリームコンテキストの `protocol` オプションとして指定することで、
10 * 基盤となるソケットがIPプロトコルファミリーを使用することを強調できますが、
11 * `tcp://` や `udp://` といったスキームを使用する場合は通常は省略可能です。
12 *
13 * このコードは、指定されたアドレスとポートでTCPサーバーを起動し、
14 * クライアントからの接続を受け付けて簡単なメッセージの送受信を行います。
15 */
16function runSimpleTcpServer(): void
17{
18    // サーバーが待ち受けるホストとポートを設定します。
19    // '0.0.0.0' は、利用可能なすべてのネットワークインターフェースからの接続を許可します。
20    $host = '0.0.0.0';
21    $port = 8000;
22    $address = "tcp://{$host}:{$port}";
23
24    // ストリームコンテキストを作成します。
25    // このコンテキストは stream_socket_server の動作に影響を与えます。
26    $context = stream_context_create([
27        'socket' => [
28            // STREAM_IPPROTO_IP は IP プロトコルファミリーを示す定数です (値は 0)。
29            // tcp:// スキームを使用する場合、プロトコルは暗黙的に TCP となりますが、
30            // ここで明示的にIPプロトコルファミリーを指定しています。
31            'protocol' => STREAM_IPPROTO_IP,
32        ],
33    ]);
34
35    // stream_socket_server 関数を使用してサーバーソケットを作成します。
36    // 第1引数: サーバーアドレス (tcp://host:port)
37    // 第2引数: エラー番号が格納される変数への参照
38    // 第3引数: エラーメッセージが格納される変数への参照
39    // 第4引数: ソケットの動作モード (バインドとリッスン)
40    // 第5引数: 作成したストリームコンテキスト
41    $server = stream_socket_server(
42        $address,
43        $errno,
44        $errstr,
45        STREAM_SERVER_BIND | STREAM_SERVER_LISTEN,
46        $context
47    );
48
49    // サーバーソケットの作成に失敗した場合の処理
50    if (false === $server) {
51        error_log("サーバーの起動に失敗しました: {$errstr} ({$errno})\n");
52        exit(1);
53    }
54
55    echo "TCPサーバーが {$address} で起動しました。クライアントからの接続を待っています...\n";
56    echo "停止するには Ctrl+C を押してください。\n";
57
58    // サーバーが稼働し続けるための無限ループ
59    while (true) {
60        // stream_socket_accept 関数でクライアントからの新しい接続を受け入れます。
61        // 第2引数 -1 は、タイムアウトせずに接続を無限に待機することを示します。
62        $client = stream_socket_accept($server, -1);
63
64        // 接続受け入れに失敗した場合の処理
65        if (false === $client) {
66            error_log("クライアント接続の受け入れに失敗しました。\n");
67            continue;
68        }
69
70        // 接続したクライアントのアドレスを表示
71        echo "クライアントが接続しました: " . stream_socket_get_name($client, true) . "\n";
72
73        // クライアントからのデータを最大1024バイト読み込みます。
74        $data = fread($client, 1024);
75        echo "受信データ: '" . trim($data) . "'\n";
76
77        // クライアントへの応答メッセージを作成し、送信します。
78        $response = "PHP Server: Received '" . trim($data) . "'. Hello!\n";
79        fwrite($client, $response);
80        echo "返信しました: '" . trim($response) . "'\n";
81
82        // クライアントとの接続を閉じます。
83        fclose($client);
84        echo "クライアント接続を閉じました。\n";
85    }
86
87    // この部分は無限ループのため通常到達しませんが、サーバーシャットダウン時のクリーンアップとして。
88    fclose($server);
89}
90
91// サーバーを起動する関数を呼び出します。
92runSimpleTcpServer();

このサンプルコードは、PHPを用いてTCPサーバーを起動し、クライアントからの接続を受け入れて簡単なメッセージを送受信する方法を示しています。

核となるSTREAM_IPPROTO_IPは、IPプロトコルファミリーを示す整数値（0）の定数です。stream_socket_server関数でサーバーを起動する際、tcp://のようなURIスキームを使用するとプロトコルが自動的に決定されますが、本コードではstream_context_createで作成したストリームコンテキストのprotocolオプションにこの定数を明示的に指定し、基盤となるソケットがIPプロトコルファミリーを使用することを強調しています。

まず、サーバーが待ち受けるアドレス（tcp://0.0.0.0:8000）と上記ストリームコンテキストを用意し、stream_socket_server関数を呼び出します。この関数は、指定されたアドレスでサーバーソケットを作成し、接続待ち状態にする役割を持ち、成功するとソケットリソースを返します。引数にはアドレス、エラー情報を受け取る変数、ソケットの動作モード（STREAM_SERVER_BINDとSTREAM_SERVER_LISTEN）などを渡します。

サーバーが起動すると、無限ループ内でstream_socket_accept関数を使ってクライアントからの接続を待機します。この関数は新しい接続を受け入れるたびにクライアントソケットのリソースを返します。接続が確立すると、fread関数でクライアントからのデータを受信し、fwrite関数で応答メッセージを送信します。データ送受信後、fclose関数でクライアントとの接続を閉じ、次の接続を待ちます。これにより、基本的なリクエスト・レスポンス型のサーバー処理が実現されます。