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

Copy
1<?php
2
3/**
4 * STREAM_CLIENT_CONNECT 定数を使用して、非同期クライアントソケット接続を実演します。
5 *
6 * STREAM_CLIENT_CONNECT は、stream_socket_client 関数に渡すフラグの一つで、
7 * ソケットの接続確立を試みることを示します。これは stream_socket_client のデフォルトの動作ですが、
8 * 他のフラグと組み合わせて使用することで、接続の意図を明確にしたり、特定の動作を有効にしたりします。
9 *
10 * このサンプルコードでは、キーワード「async_connect」に関連付け、
11 * STREAM_CLIENT_ASYNC_CONNECT と組み合わせることで、ノンブロッキング（非同期）接続を試みます。
12 * 非同期接続では、ソケットの作成直後に接続が完了しない可能性があるため、
13 * 接続が実際に確立されるまで待機する処理（通常は stream_select を使用）が必要になります。
14 *
15 * @param string $host 接続先ホスト名またはIPアドレス (例: 'example.com')
16 * @param int $port 接続先ポート番号 (例: 80)
17 * @param int $timeout 接続試行のタイムアウト時間 (秒)
18 */
19function demonstrateStreamClientConnectAsync(string $host, int $port, int $timeout = 5): void
20{
21    echo "--- PHP STREAM_CLIENT_CONNECT 定数を使用した非同期クライアント接続のデモンストレーション ---\n";
22    echo "接続先: {$host}:{$port}\n";
23
24    // STREAM_CLIENT_CONNECT: 接続確立を試みることを明示します。
25    // STREAM_CLIENT_ASYNC_CONNECT: ノンブロッキングモードでの接続を有効にします。
26    // これら2つのフラグをOR結合することで、非同期接続を実現します。
27    $flags = STREAM_CLIENT_CONNECT | STREAM_CLIENT_ASYNC_CONNECT;
28
29    $errno = null;  // 接続失敗時のエラーコードを格納する変数
30    $errstr = null; // 接続失敗時のエラーメッセージを格納する変数
31
32    // stream_socket_client を使用して、指定されたホストとポートにソケットを接続します。
33    // $flags に STREAM_CLIENT_ASYNC_CONNECT が含まれるため、接続はノンブロッキングで行われます。
34    // つまり、TCPハンドシェイクが完了するのを待たずに、関数はすぐに制御を返します。
35    $socket = stream_socket_client(
36        "tcp://{$host}:{$port}",
37        $errno,
38        $errstr,
39        $timeout, // 接続試行のタイムアウト（秒）
40        $flags
41    );
42
43    if (false === $socket) {
44        echo "エラー: 接続開始に失敗しました。[$errno] {$errstr}\n";
45        return;
46    }
47
48    echo "非同期接続を開始しました。ソケットリソースが作成されました。\n";
49    echo "この時点では、接続がまだ完全に確立されていない可能性があります。\n";
50
51    // 非同期接続の利点は、接続確立を待つ間に他の処理を実行できる点です。
52    // 例: echo "接続を待つ間に別の処理を実行中...\n";
53
54    // 接続の完了を待つ処理。
55    // stream_select を使用して、ソケットが書き込み可能になる（＝接続が確立される）のを待ちます。
56    $write_sockets = [$socket]; // 書き込み可能かチェックするソケットの配列
57    $read_sockets = null;       // 読み込み可能かチェックするソケットの配列（ここでは不要）
58    $except_sockets = null;     // 例外発生かチェックするソケットの配列（ここでは不要）
59
60    // stream_select は、指定されたソケットがI/O準備完了になるまで待機します。
61    // $timeout は待機する最大時間（秒）です。
62    $num_changed_streams = stream_select($read_sockets, $write_sockets, $except_sockets, $timeout);
63
64    if (false === $num_changed_streams) {
65        echo "エラー: stream_select でソケット状態の監視中に問題が発生しました。\n";
66    } elseif ($num_changed_streams > 0 && in_array($socket, $write_sockets, true)) {
67        echo "接続が正常に確立されました。\n";
68        // ここからデータを送受信できます。例:
69        // fwrite($socket, "GET / HTTP/1.0\r\nHost: {$host}\r\n\r\n");
70        // while (!feof($socket)) {
71        //     echo fgets($socket, 1024);
72        // }
73    } else {
74        echo "エラー: 指定時間内に接続が確立されませんでした（タイムアウトまたは接続失敗）。\n";
75    }
76
77    // ソケットリソースをクローズします。
78    if (is_resource($socket)) {
79        fclose($socket);
80        echo "ソケットがクローズされました。\n";
81    }
82}
83
84// サンプル使用例: 実際のWebサーバー（例: example.com の HTTP ポート）に非同期接続を試みます。
85// 接続結果はネットワーク状況やターゲットサーバーの可用性に依存します。
86demonstrateStreamClientConnectAsync("example.com", 80);
87
88// ローカルでテストサーバー (例: PHPのビルトインサーバー `php -S localhost:8080`) を
89// 起動している場合は、以下の行をコメント解除して試すことができます。
90// demonstrateStreamClientConnectAsync("127.0.0.1", 8080);

PHPのSTREAM_CLIENT_CONNECTは、stream_socket_client関数で使用される定数で、外部サーバーへのソケット接続の確立を試みることを明示します。この定数は、STREAM_CLIENT_ASYNC_CONNECT定数と組み合わせることで、非同期接続（ノンブロッキング接続）を実現する方法をサンプルコードで示しています。

非同期接続とは、stream_socket_client関数がソケットの接続処理をバックグラウンドで実行し、接続完了を待たずにすぐに次の処理へ移る挙動です。これにより、プログラムが接続待ちで停止することなく、他のタスクを同時に進めることが可能になります。

サンプルコードでは、STREAM_CLIENT_CONNECTとSTREAM_CLIENT_ASYNC_CONNECTをOR結合したフラグをstream_socket_client関数に渡して非同期接続を開始します。この時点では接続がまだ確立されていない可能性があるため、その後stream_select関数を使用して、ソケットが実際に接続され、データ送信が可能になるまで待機します。stream_select関数は、複数のソケットの読み書き可能状態や例外発生を監視し、指定されたタイムアウト時間内でソケットの状態が変化するのを待つことができます。

STREAM_CLIENT_CONNECT定数自体には引数や戻り値はありませんが、stream_socket_client関数は接続先ホスト、ポート、タイムアウトなどを引数として受け取り、成功時にはソケットリソースを、失敗時にはfalseを返します。このサンプルは、非同期接続のメリットと、それに伴う状態監視の必要性を学ぶ良い例となります。