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

Copy
1<?php
2
3/**
4 * PHPのSTREAM_SERVER_BIND定数を利用したソケットサーバーのサンプルコード。
5 *
6 * STREAM_SERVER_BINDは、stream_socket_server() 関数に渡すフラグの一つで、
7 * ソケットを特定のアドレス（IPアドレスとポート）にバインドしますが、
8 * クライアントからの接続を待機する「リッスン」状態にはしません。
9 * これにより、ソケット作成後に詳細な設定を行ったり、
10 * 明示的に stream_socket_listen() を呼び出すタイミングを制御したりできます。
11 *
12 * このコードは、ソケットのバインド成功と、定数の値を示すことを目的としています。
13 */
14function demonstrateStreamServerBind(): void
15{
16    // サーバーがリッスンするIPアドレスとポートを設定
17    $host = '127.0.0.1'; // ローカルホスト (このスクリプトと同じマシン)
18    $port = 8000;        // 任意の利用可能なポート番号
19    $address = "tcp://$host:$port"; // 接続アドレス文字列
20
21    echo "--- STREAM_SERVER_BIND デモンストレーション ---" . PHP_EOL;
22    echo "ソケットをアドレス {$address} にバインドしようとしています..." . PHP_EOL;
23
24    // stream_socket_server() を呼び出す際に STREAM_SERVER_BIND フラグを使用
25    // このフラグにより、ソケットは指定されたアドレスにバインドされるが、
26    // すぐにはクライアントからの接続を受け付ける「リッスン」状態にはなりません。
27    $errno = null;  // エラー番号を格納する変数
28    $errstr = null; // エラーメッセージを格納する変数
29    $socket = stream_socket_server(
30        $address,
31        $errno,
32        $errstr,
33        STREAM_SERVER_BIND // ここで STREAM_SERVER_BIND 定数を使用
34    );
35
36    // ソケット作成に失敗した場合のエラー処理
37    if (false === $socket) {
38        echo "エラー: サーバーソケットの作成に失敗しました。 [{$errno}] {$errstr}" . PHP_EOL;
39        echo "ポート {$port} が既に使用されているか、権限がない可能性があります。" . PHP_EOL;
40        return;
41    }
42
43    echo "成功: サーバーソケットはアドレス {$address} にバインドされました。" . PHP_EOL;
44    echo "注意: ソケットはバインドされましたが、まだ接続を待機 (リッスン) していません。" . PHP_EOL;
45
46    // STREAM_SERVER_BIND 定数の値を出力 (int型)
47    echo "STREAM_SERVER_BIND 定数の値: " . STREAM_SERVER_BIND . " (integer)" . PHP_EOL;
48
49    // ソケットが正常にバインドされたら、通常はここで追加設定を行い、
50    // その後 stream_socket_listen() を呼び出して接続待機状態にします。
51    // 例: stream_socket_listen($socket); // この行を有効にするとリッスン状態になります。
52
53    // このデモンストレーションの目的は STREAM_SERVER_BIND の挙動を示すことなので、
54    // ここではリッスン状態にはせず、バインド後にソケットを閉じて終了します。
55    echo "バインドされたサーバーソケットを閉じます。" . PHP_EOL;
56    fclose($socket);
57    echo "ソケットが閉じられました。デモンストレーション終了。" . PHP_EOL;
58}
59
60// 関数を実行してサンプルコードを動作させる
61demonstrateStreamServerBind();
62
63?>

PHPのSTREAM_SERVER_BINDは、ストリーム操作に関連する拡張機能で提供される定数の一つです。これは引数を取らず、その値は整数型（int）で返されます。

この定数は、主にネットワーク通信を扱うstream_socket_server()関数のオプションとして使用されます。STREAM_SERVER_BINDを指定してstream_socket_server()を呼び出すと、サーバーソケットは指定されたIPアドレスとポート番号に結び付けられ（バインド）、通信を受け入れる準備ができます。しかし、この定数だけでは、クライアントからの接続を実際に待機する「リッスン」状態にはなりません。これにより、ソケット作成後にさまざまな設定を適用したり、明示的にstream_socket_listen()関数を呼び出して接続待機を開始するタイミングを制御したりすることが可能になります。

提供されたサンプルコードでは、127.0.0.1:8000というアドレスに対し、STREAM_SERVER_BINDフラグを使用してソケットをバインドする処理が示されています。コードはまずアドレスを準備し、stream_socket_server()でソケットのバインドを試みます。成功すれば、ソケットがアドレスに結び付けられた旨と、STREAM_SERVER_BIND定数自身の整数値が出力されます。失敗した場合はエラーメッセージが表示されます。この例ではバインド後にソケットを閉じていますが、通常はバインド後にstream_socket_listen()でリッスン状態へ移行し、クライアントからの接続を受け付けます。

Copy
1<?php
2
3/**
4 * STREAM_SERVER_BIND 定数と stream_set_blocking 関数を使用したPHPソケットサーバーの例。
5 *
6 * このスクリプトはTCPソケットサーバーを起動し、単一のクライアントからの接続を受け入れ、
7 * クライアントソケットのブロックモードを設定し、メッセージをエコーバックします。
8 *
9 * 実行方法:
10 * 1. ターミナルでこのスクリプトを実行します: `php your_script_name.php`
11 * 2. 別のターミナルでクライアントとして接続します (例: `nc localhost 12345` または `telnet localhost 12345`)
12 * 3. クライアントからメッセージを送信し、サーバーからの応答を確認します。
13 *    (例: `Hello PHP!`)
14 * 4. メッセージを送るとサーバーは接続を切断します。再度接続するにはサーバーを再起動してください。
15 */
16function runSimpleSocketServerWithBlockingControl(): void
17{
18    // サーバーが待ち受けるIPアドレスとポート
19    $host = '127.0.0.1';
20    $port = 12345;
21    $serverAddress = "tcp://{$host}:{$port}";
22
23    echo "サーバーを起動中: {$serverAddress}\n";
24
25    // stream_socket_server 関数を使用してサーバーソケットを作成し、指定されたアドレスにバインドします。
26    // STREAM_SERVER_BIND は、ソケットの作成とアドレスへのバインドのみを指定するフラグです。
27    // これにより、サーバーソケットが指定されたアドレスとポートで接続を待ち受ける準備ができます。
28    $server = stream_socket_server($serverAddress, $errno, $errstr, STREAM_SERVER_BIND);
29
30    if (false === $server) {
31        die("サーバーの作成に失敗しました: {$errstr} ({$errno})\n");
32    }
33
34    echo "サーバーは接続を待機しています...\n";
35
36    // サーバーソケットをブロッキングモードに設定します（通常、デフォルトでブロッキングです）。
37    // stream_set_blocking($server, true) は、このソケットに対する操作 (例: stream_socket_accept()) が、
38    // 完了するまでスクリプトの実行を停止することを示します。
39    stream_set_blocking($server, true);
40    echo "サーバーソケットはブロッキングモードです。\n";
41
42    // クライアントからの接続を待機します。
43    // サーバーソケットがブロッキングモードなので、接続があるまでスクリプトの実行はこの行で停止します。
44    $client = stream_socket_accept($server);
45
46    if (false === $client) {
47        // 接続受け入れ中にエラーが発生した場合
48        fclose($server);
49        die("クライアント接続の受け入れに失敗しました。\n");
50    }
51
52    echo "クライアントが接続しました。\n";
53
54    // 接続されたクライアントソケットを非ブロッキングモードに設定する例。
55    // stream_set_blocking($client, false) を呼び出すことで、
56    // このソケットに対する読み書き操作 (例: fread(), fwrite()) は、
57    // データがない場合やバッファが満杯の場合でも、すぐに制御を返します。
58    stream_set_blocking($client, false);
59    echo "クライアントソケットを非ブロッキングモードに設定しました。\n";
60
61    // クライアントからデータを読み込む試行
62    $readAttempts = 0;
63    $receivedData = '';
64    // 非ブロッキングモードでの読み込みの挙動を示すため、短い間隔で複数回試行します。
65    // 実際には stream_select() などのイベントループと組み合わせて使われます。
66    while ($readAttempts < 5) {
67        $data = fread($client, 1024); // 最大1024バイト読み込み
68        if ($data === false) {
69            echo "データの読み込み中にエラーが発生しました。\n";
70            break;
71        }
72        if ($data !== '') {
73            $receivedData .= $data;
74            // データが受信できたら、これ以上待機せずループを抜ける
75            break; 
76        }
77        // データがまだ来ていない場合は少し待機 (非ブロッキングの挙動を示すため)
78        usleep(100000); // 100ミリ秒待機
79        $readAttempts++;
80    }
81
82    if ($receivedData === '') {
83        echo "クライアントからメッセージを受信しませんでした。\n";
84        $response = "サーバー: メッセージがありませんでした。\n";
85    } else {
86        echo "受信: " . trim($receivedData) . "\n";
87        $response = "Echo: " . $receivedData . "\n";
88    }
89    
90    // クライアントに応答を送信します。
91    fwrite($client, $response);
92    echo "応答を送信しました。\n";
93
94    // クライアントソケットを閉じます。
95    fclose($client);
96    echo "クライアントが切断されました。\n";
97
98    // サーバーソケットを閉じます。
99    fclose($server);
100    echo "サーバーが停止しました。\n";
101}
102
103// 関数を実行してサーバーを起動します。
104runSimpleSocketServerWithBlockingControl();

このPHPサンプルコードは、基本的なTCPソケットサーバーを構築し、クライアントとの通信を扱う方法を示しています。特にSTREAM_SERVER_BIND定数とstream_set_blocking関数の使い方に焦点を当てています。

STREAM_SERVER_BIND定数は、stream_socket_server関数と組み合わせて使用され、ソケットを作成し、指定されたIPアドレスとポートにバインドする（接続を受け入れる準備をする）ためのフラグです。この定数の値は整数型（int）です。これにより、サーバーはクライアントからの接続を待機できる状態になります。

stream_set_blocking関数は、ソケットの操作がブロックするかどうかを制御します。第1引数にソケットリソース、第2引数にブロッキングモードを表す真偽値（trueでブロッキング、falseで非ブロッキング）を指定します。この関数を呼び出すことで、ソケットの動作モードを設定します。

ブロッキングモード（true）では、stream_socket_acceptによるクライアント接続の受け入れやfreadによるデータ読み込みなどの操作は、処理が完了するまでスクリプトの実行を一時停止します。一方、非ブロッキングモード（false）では、これらの操作はすぐに制御を返し、データが利用可能でなくても待機しません。このサンプルでは、サーバーソケットはブロッキングモードで接続を待ち、クライアントソケットは非ブロッキングモードでデータの有無を確認する例として設定されています。これにより、サーバーはクライアントからの入力を効率的に処理できるようになります。