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

Copy
1<?php
2
3/**
4 * ストリームイベント発生時に呼び出されるコールバック関数。
5 * STREAM_NOTIFY_CONNECT を含め、様々なイベントの通知を受け取ります。
6 *
7 * @param int $notification_code イベントの種類を示す定数 (例: STREAM_NOTIFY_CONNECT)。
8 * @param int $severity イベントの重大度。
9 * @param string $message イベントに関するメッセージ。
10 * @param string $message_code イベントのメッセージコード。
11 * @param int $bytes_transferred 転送されたバイト数。
12 * @param int $bytes_max 転送される最大バイト数。
13 * @return void
14 */
15function stream_notification_callback(
16    int $notification_code,
17    int $severity,
18    string $message,
19    string $message_code,
20    int $bytes_transferred,
21    int $bytes_max
22): void {
23    // 発生したイベントに関する情報を出力します。
24    // STREAM_NOTIFY_CONNECT はストリーム接続が確立されたことを示す定数で、int型です。
25    echo "通知: コード={$notification_code}, メッセージ='{$message}'";
26
27    // STREAM_NOTIFY_CONNECT イベントを特に検出した場合の処理
28    if ($notification_code === STREAM_NOTIFY_CONNECT) {
29        echo " -> 接続が確立されました！(STREAM_NOTIFY_CONNECT検出)";
30    }
31    echo PHP_EOL;
32}
33
34/**
35 * 指定されたホストへノンブロッキングHTTP接続を試み、データを取得します。
36 * stream_set_blocking() を使用してストリームの挙動を制御し、
37 * STREAM_NOTIFY_CONNECT 定数で接続確立イベントを監視します。
38 *
39 * @param string $host 接続先のホスト名（例: 'www.example.com'）
40 * @param int $port 接続先のポート番号（デフォルト: 80）
41 * @param string $path HTTPリクエストパス（デフォルト: '/'）
42 * @return string|false 取得したHTTPレスポンス、または失敗した場合はfalse
43 */
44function fetchNonBlockingHttp(string $host, int $port = 80, string $path = '/'): string|false
45{
46    echo "--- ノンブロッキングHTTPフェッチを開始 ---" . PHP_EOL;
47    echo "ターゲット: tcp://{$host}:{$port}{$path}" . PHP_EOL;
48
49    // ストリームコンテキストを作成し、stream_notification_callback を設定します。
50    // これにより、接続の進行状況やイベントをコールバック関数で受け取ることができます。
51    $context = stream_context_create([
52        'socket' => [
53            'notification' => 'stream_notification_callback', // 通知コールバック関数を指定
54            'bindto' => '0:0', // 任意のローカルIPとポートを使用
55        ],
56        'http' => [
57            'timeout' => 5, // HTTPリクエストのタイムアウトを5秒に設定
58        ]
59    ]);
60
61    $socket = null;
62    $errno = null;
63    $errstr = null;
64
65    // stream_socket_client を使用して、非同期接続を開始します。
66    // STREAM_CLIENT_ASYNC_CONNECT フラグは、接続処理をノンブロッキングで行うように指示します。
67    // タイムアウトも指定し、接続が完了しない場合でも処理がブロックされないようにします。
68    echo "stream_socket_client で非同期接続を開始中..." . PHP_EOL;
69    $socket = @stream_socket_client(
70        "tcp://{$host}:{$port}",
71        $errno,
72        $errstr,
73        10, // 接続全体のタイムアウト (秒)
74        STREAM_CLIENT_ASYNC_CONNECT | STREAM_CLIENT_CONNECT, // 非同期接続を有効にする
75        $context
76    );
77
78    if (!$socket) {
79        echo "エラー: 接続に失敗しました ({$errno}: {$errstr})" . PHP_EOL;
80        return false;
81    }
82
83    // ここで stream_set_blocking() を明示的に使用して、ストリームをノンブロッキングモードに設定します。
84    // STREAM_CLIENT_ASYNC_CONNECT フラグが指定されている場合、通常は既にノンブロッキングですが、
85    // 明示的に設定することで、ストリームのIOモードを確実に制御できます。
86    echo "ストリームを明示的にノンブロッキングモードに設定: stream_set_blocking(\$socket, false)" . PHP_EOL;
87    stream_set_blocking($socket, false);
88
89    // ノンブロッキング接続が完了するまで待機します。
90    // stream_select() は、ソケットが読み書き可能になるまで待つために使用されます。
91    // これにより、CPUを無駄に消費せず、効率的に待機できます。
92    $connect_timeout = 5; // 接続完了までの最大待機時間 (秒)
93    $start_time = microtime(true);
94    $connected = false;
95
96    while (microtime(true) - $start_time < $connect_timeout) {
97        $read = [];
98        $write = [$socket]; // 書き込み可能になるまで待機（接続確立を意味することが多い）
99        $except = [$socket];
100        $timeout_seconds = 1; // stream_select のタイムアウト
101
102        // stream_select() は、監視対象のソケットにイベントが発生するまで待機します。
103        // 第4引数に0を指定すると、ノンブロッキングで即座に返ります。
104        // ここでは1秒待機し、CPU使用率を抑えます。
105        $num_changed_sockets = stream_select($read, $write, $except, $timeout_seconds);
106
107        if ($num_changed_sockets === false) {
108            echo "stream_select エラー発生。" . PHP_EOL;
109            break;
110        } elseif ($num_changed_sockets > 0) {
111            // ソケットが書き込み可能になった場合（通常、接続が確立されたことを意味します）
112            $meta = stream_get_meta_data($socket);
113            if (isset($meta['timed_out']) && $meta['timed_out']) {
114                echo "接続中にタイムアウトしました。" . PHP_EOL;
115                break;
116            }
117            if (!empty($except)) { // エラーソケットがあれば
118                 echo "接続中に例外が発生しました。" . PHP_EOL;
119                 break;
120            }
121            if (!empty($write)) { // 接続が確立され書き込み可能
122                $connected = true;
123                echo "ノンブロッキング接続が確立されました。" . PHP_EOL;
124                break;
125            }
126        } else {
127            // タイムアウトしてもイベントが発生しない場合、接続を待機中
128            echo "接続待機中..." . PHP_EOL;
129        }
130        usleep(100000); // 0.1秒待機してから再度ループ
131    }
132
133    if (!$connected) {
134        echo "エラー: ノンブロッキング接続を完了できませんでした (タイムアウトまたは失敗)。" . PHP_EOL;
135        fclose($socket);
136        return false;
137    }
138
139    // 接続が確立されたらHTTPリクエストを送信
140    $request = "GET {$path} HTTP/1.0\r\nHost: {$host}\r\nConnection: close\r\n\r\n";
141    echo "HTTPリクエストを送信中..." . PHP_EOL;
142    fwrite($socket, $request);
143
144    // ノンブロッキングモードでのレスポンス読み込み
145    $response = '';
146    $read_timeout = 5; // レスポンス読み込みの最大待機時間 (秒)
147    $start_time = microtime(true);
148
149    while (!feof($socket) && (microtime(true) - $start_time < $read_timeout)) {
150        $read = [$socket];
151        $write = [];
152        $except = [];
153        $timeout_seconds = 1; // stream_select のタイムアウト
154
155        // ソケットが読み取り可能になるまで待機
156        $num_changed_sockets = stream_select($read, $write, $except, $timeout_seconds);
157
158        if ($num_changed_sockets === false) {
159            echo "stream_select エラー発生 (読み取り時)。" . PHP_EOL;
160            break;
161        } elseif ($num_changed_sockets > 0) {
162            // 読み取り可能になったらデータを取得
163            $chunk = fread($socket, 4096);
164            if ($chunk === false || $chunk === '') {
165                // 読み取りエラーまたはEOF（ストリームの終了）
166                break;
167            }
168            $response .= $chunk;
169        } else {
170            // タイムアウトしてもデータが来ていない場合、待機を継続
171            echo "データ受信待機中..." . PHP_EOL;
172        }
173    }
174
175    fclose($socket);
176    echo "接続を閉じました。" . PHP_EOL;
177
178    // レスポンスのヘッダーと最初の数行だけを表示
179    echo PHP_EOL . "--- 受信したHTTPレスポンスの一部 ---" . PHP_EOL;
180    $lines = explode(PHP_EOL, $response);
181    echo implode(PHP_EOL, array_slice($lines, 0, 10)) . (count($lines) > 10 ? PHP_EOL . "[...以下省略...]" : '') . PHP_EOL;
182    echo "-------------------------------------" . PHP_EOL;
183
184    return $response;
185}
186
187// サンプル実行: www.example.com のルートパスにノンブロッキング接続でHTTP GETリクエストを送信
188fetchNonBlockingHttp('www.example.com', 80, '/');

このPHPサンプルコードは、STREAM_NOTIFY_CONNECT定数とノンブロッキングI/Oを用いたHTTP接続処理の基礎を示しています。STREAM_NOTIFY_CONNECTは、ネットワーク接続が正常に確立されたことを示す整数型の定数です。

コードでは、stream_notification_callbackという関数がストリームイベントの通知を受け取る役割を担います。この関数は、イベントの種類を示す$notification_codeなどの引数を受け取り、特にSTREAM_NOTIFY_CONNECTイベントが発生した際に接続確立のメッセージを出力します。

主要なfetchNonBlockingHttp関数は、指定されたホスト（$host）とポート（$port）へノンブロッキングでHTTPリクエストを送信し、取得したレスポンスを文字列として返すか、失敗時にfalseを返します。 この関数では、stream_context_createでstream_notification_callbackをイベント通知のために設定します。そして、stream_socket_client関数を使って非同期にサーバーへの接続を開始します。接続後、stream_set_blocking($socket, false)によりストリームをノンブロッキングモードに明示的に設定することで、データの送受信が完了するまでプログラムが待機せずに他の処理を続行できる状態にします。 接続が完了するまでの待機や、レスポンスの読み込みにはstream_select関数が使われます。これにより、CPUを効率的に使いながら、データが読み書き可能になるまで監視し、準備ができたときにのみ処理を進めることが可能になります。 この方法により、ネットワークI/O処理中にプログラム全体がブロックされることを防ぎ、より応答性の高いアプリケーションを開発できます。

Copy
1<?php
2
3/**
4 * ストリームイベント発生時に呼び出されるコールバック関数。
5 * stream_socket_clientなどのストリーム操作中に発生する様々なイベントを捕捉します。
6 *
7 * @param int $notification_code 通知の種類を示すコード (例: STREAM_NOTIFY_CONNECT)。
8 * @param int $severity 通知の重大度。
9 * @param string $message 通知に関連するメッセージ。
10 * @param int $message_code メッセージに関連するコード。
11 * @param int $bytes_transferred 転送されたバイト数。
12 * @param int $bytes_max 最大転送バイト数。
13 * @return void
14 */
15function myStreamNotifier(
16    int $notification_code,
17    int $severity,
18    string $message,
19    int $message_code,
20    int $bytes_transferred,
21    int $bytes_max
22): void {
23    echo "--- Stream Notification ---\n";
24    // STREAM_NOTIFY_CONNECT はソケット接続が開始されたときに通知されます。
25    if ($notification_code === STREAM_NOTIFY_CONNECT) {
26        echo "イベント: 接続が開始されました (STREAM_NOTIFY_CONNECT)!\n";
27    } elseif ($notification_code === STREAM_NOTIFY_FAILURE) {
28        echo "イベント: 接続に失敗しました (STREAM_NOTIFY_FAILURE)!\n";
29    } else {
30        echo "イベント: その他のストリーム通知 (Code: {$notification_code})\n";
31    }
32    echo "メッセージ: {$message}\n";
33    // その他の詳細情報も必要に応じて表示できます。
34    // echo "重大度: {$severity}, コード: {$message_code}, 転送バイト: {$bytes_transferred}/{$bytes_max}\n";
35    echo "---------------------------\n\n";
36}
37
38/**
39 * STREAM_NOTIFY_CONNECT定数を利用して、stream_socket_clientでの接続開始イベントを
40 * コールバック関数で捕捉するデモンストレーションを行います。
41 *
42 * @param string $host 接続先ホスト (例: 'www.example.com', 'localhost')
43 * @param int $port 接続先ポート (例: 80, 443)
44 * @return void
45 */
46function demonstrateStreamNotifyConnect(string $host, int $port): void
47{
48    echo "--------------------------------------------------\n";
49    echo "  ターゲット {$host}:{$port} への接続を試行中...\n";
50    echo "--------------------------------------------------\n\n";
51
52    // 1. ストリームコンテキストを作成します。
53    //    ストリーム操作のオプションや設定をまとめるオブジェクトです。
54    $context = stream_context_create([
55        // 'notification'キーに、ストリームイベント発生時に呼び出すコールバック関数名を指定します。
56        'notification' => 'myStreamNotifier',
57    ]);
58
59    $errno = 0; // 接続エラーが発生した場合のエラー番号
60    $errstr = ''; // 接続エラーが発生した場合のエラーメッセージ
61    $timeout = 5; // 接続試行のタイムアウト時間 (秒)
62
63    // 2. stream_socket_client を使用してリモートホストへの接続を試みます。
64    //    作成したコンテキストを第三引数に渡すことで、コールバック関数が有効になります。
65    //    接続中に myStreamNotifier 関数が STREAM_NOTIFY_CONNECT などのイベントで呼び出されます。
66    $client = @stream_socket_client( // エラーメッセージを抑制するために @ を使用
67        "tcp://{$host}:{$port}", // 接続先アドレス (tcp://プロトコル名://ホスト名:ポート番号)
68        $errno,
69        $errstr,
70        $timeout,
71        STREAM_CLIENT_CONNECT, // 接続モード: クライアント接続を開始
72        $context // 作成したストリームコンテキスト
73    );
74
75    // 3. 接続結果を確認します。
76    if ($client === false) {
77        echo "エラー: 接続に失敗しました。詳細: ({$errno}) {$errstr}\n";
78    } else {
79        echo "成功: ホスト {$host}:{$port} に接続しました。\n";
80        // 接続が確立されたら、ここでデータの送受信などのネットワーク操作が行えます。
81        // 例: fwrite($client, "GET / HTTP/1.0\r\nHost: {$host}\r\n\r\n");
82        //     echo stream_get_contents($client);
83
84        fclose($client); // 接続を閉じます
85        echo "接続を閉じました。\n";
86    }
87
88    echo "\n--------------------------------------------------\n";
89    echo "  デモンストレーション終了\n";
90    echo "--------------------------------------------------\n";
91}
92
93// --- サンプルコードの実行 ---
94// 以下の行のコメントを外して実行することで、様々なシナリオを試すことができます。
95
96// 例1: 存在するWebサーバー (www.example.com のポート80) への接続試行
97//     接続開始、データ転送、接続終了などのイベントが発生する可能性があります。
98// demonstrateStreamNotifyConnect('www.example.com', 80);
99
100// 例2: ローカルホストのWebサーバー (ポート80) への接続試行
101//     ローカル環境にWebサーバーが稼働していれば接続成功、なければ接続失敗となるでしょう。
102//     どちらの場合でも STREAM_NOTIFY_CONNECT イベントは発生します。
103demonstrateStreamNotifyConnect('localhost', 80);
104
105// 例3: 通常は閉じているローカルホストのランダムなポート (接続失敗が期待されます)
106// demonstrateStreamNotifyConnect('localhost', 12345);

PHPのSTREAM_NOTIFY_CONNECTは、ネットワーク接続などの「ストリーム操作」中に発生する特定のイベントを識別するための定数です。この定数自体は引数を持たず、整数（int）として定義されており、その値によってイベントの種類を表します。

主にstream_context_create関数と組み合わせて使用され、stream_socket_clientのようなネットワーク通信を行う際に、接続状況を監視するためのコールバック関数を指定するのに役立ちます。具体的にSTREAM_NOTIFY_CONNECTは、リモートホストへの接続が開始された直後に発生するイベントを指します。

サンプルコードでは、myStreamNotifierというコールバック関数を用意し、この関数がSTREAM_NOTIFY_CONNECTイベントを受け取った際に「接続が開始されました」というメッセージを表示する例が示されています。demonstrateStreamNotifyConnect関数内でstream_context_createを通じてmyStreamNotifierを登録し、その後stream_socket_clientで接続を試みることで、接続開始のタイミングでイベント通知がトリガーされる様子を確認できます。これにより、システムは接続の進行状況をリアルタイムで把握し、より詳細なログ記録やエラーハンドリングを実装することが可能になります。