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

Copy
1<?php
2
3/**
4 * PHPスクリプトとクライアント間の現在の接続状態をチェックし、
5 * CONNECTION_NORMAL定数を用いて接続が正常であるかを確認するサンプルです。
6 *
7 * CONNECTION_NORMALは、接続が正常であることを示す定数（値は0）です。
8 * connection_status()関数は、現在の接続状態を示すビットフィールドを返します。
9 */
10function checkAndDisplayConnectionStatus(): void
11{
12    // connection_status()関数を呼び出して現在の接続状態を取得します。
13    // この関数は、CONNECTION_NORMAL、CONNECTION_ABORTED、CONNECTION_TIMEOUTなどの
14    // 定数のビット値を組み合わせた整数を返します。
15    $currentStatus = connection_status();
16
17    echo "現在の接続ステータスの値: " . $currentStatus . PHP_EOL;
18
19    // 取得したステータスが CONNECTION_NORMAL (接続が正常) であるかを確認します。
20    // CONNECTION_NORMALは値が0なので、厳密な比較 (===) で確認できます。
21    if ($currentStatus === CONNECTION_NORMAL) {
22        echo "接続は正常です (CONNECTION_NORMAL)。" . PHP_EOL;
23    } else {
24        echo "接続は正常ではありません。" . PHP_EOL;
25        // 他の接続異常状態（例: CONNECTION_ABORTED, CONNECTION_TIMEOUT）も確認できますが、
26        // このサンプルではCONNECTION_NORMALに焦点を当てています。
27        // これらの状態はビットフラグとしてセットされるため、ビット演算子 '&' を使用してチェックします。
28        // 例: if ($currentStatus & CONNECTION_ABORTED) { ... }
29    }
30}
31
32// 定義した関数を実行します。
33checkAndDisplayConnectionStatus();
34
35?>

このサンプルコードは、PHPスクリプトとクライアント間の現在の接続状態を確認する方法を、初心者の方にも分かりやすく示しています。CONNECTION_NORMALは、PHPが提供する組み込み定数の一つで、接続が正常な状態であることを意味し、その値は0です。この定数自体には引数も戻り値もありません。

コードでは、まずconnection_status()関数を呼び出しています。この関数は引数を取らず、現在の接続状態を表す整数値を戻り値として返します。この戻り値は、接続が正常なCONNECTION_NORMALや、クライアントが切断したCONNECTION_ABORTED、接続がタイムアウトしたCONNECTION_TIMEOUTといった複数の状態を示す定数のビット値が組み合わされたものです。

取得した接続状態の値がCONNECTION_NORMALと厳密に等しいかどうかをif文で判定し、その結果を画面に出力しています。これにより、スクリプト実行中にクライアントとの接続が正常に維持されているかを判断することが可能です。例えば、長時間かかる処理を行うスクリプトで、接続が途中で切断されていないかを確認する際に役立ちます。

Copy
1<?php
2
3/**
4 * 長時間実行される処理中にクライアントの接続状態を監視するデモンストレーションです。
5 * CONNECTION_NORMAL 定数を使用して、接続が正常かどうかを判断します。
6 *
7 * このスクリプトを実行し、ブラウザを途中で閉じたり、リロードしたりすると、
8 * 接続中断のメッセージが表示され、処理が終了します。
9 */
10
11// スクリプトの実行時間制限を無効にします。
12// これにより、クライアントが接続を維持している限り、スクリプトは無限に実行できます。
13set_time_limit(0);
14
15// 出力バッファリングをクリアし、現在の出力を即座にクライアントに送信できるようにします。
16// これがないと、メッセージがブラウザに表示されるまでに遅延が生じることがあります。
17ob_end_clean();
18header('Content-Type: text/plain'); // テキスト形式で出力することを指定
19
20echo "処理を開始します。クライアントの接続状態を監視中です...\n";
21flush(); // ここまでの出力をクライアントに送信します。
22
23$counter = 0;
24while (true) {
25    // connection_aborted() は、クライアントが接続を中断した場合に 1 (または非ゼロ) を返します。
26    // CONNECTION_NORMAL 定数は、接続が正常である場合に connection_aborted() が返す値 (0) と等しいです。
27    // したがって、接続が中断されたかどうかをチェックするには、
28    // connection_aborted() の戻り値が CONNECTION_NORMAL と異なるかどうかを確認します。
29    if (connection_aborted() !== CONNECTION_NORMAL) {
30        echo "クライアントが接続を中断しました。処理を終了します。\n";
31        break; // 接続が中断されたらループを抜けて処理を終了
32    }
33
34    echo "処理中... 経過時間: " . $counter . "秒\n";
35    flush(); // 現在のメッセージをクライアントに送信します。
36
37    sleep(1); // 1秒間待機します。
38
39    $counter++;
40
41    // デモンストレーションのため、10秒で処理を強制終了する条件を追加します。
42    // 実際の長時間処理ではこの条件は不要です。
43    if ($counter >= 10) {
44        echo "デモンストレーションのため、" . $counter . "秒で処理を完了します。\n";
45        break;
46    }
47}
48
49echo "処理が正常に完了しました。\n";
50flush();
51
52?>

CONNECTION_NORMALはPHPの組み込み定数の一つで、クライアントとの接続が「正常な状態」であることを示します。これは主に、サーバーで実行中の処理がクライアントからの接続に依存している場合に、その接続状態を監視するために使用されます。引数はなく、定数であるため特定の値を返しません。

この定数は、主にconnection_aborted()関数と組み合わせて使用されます。connection_aborted()関数は、クライアントがブラウザを閉じたりページ遷移したりするなどして、サーバーとの接続を中断した場合に非ゼロの値を返します。一方、接続が正常である場合は0を返します。CONNECTION_NORMAL定数もまた、接続が正常な状態を示す値として0を持っています。

したがって、サンプルコードのようにconnection_aborted() !== CONNECTION_NORMALという条件式を用いることで、connection_aborted()の戻り値が0（正常）ではない場合に、クライアントからの接続が中断されたと判断し、サーバー側の処理を適切に終了させることができます。これにより、クライアントが待機していない無駄な処理の継続を防ぎ、サーバーのリソースを効率的に利用できるようになります。サンプルコードは、長時間実行される処理中にクライアントが接続を中断すると、サーバー側の処理が停止する様子をデモンストレーションしています。