【PHP8.x】Dom\Entity::isConnectedプロパティの使い方

Copy
1<?php
2
3/**
4 * MqttClientクラスのシンプルなモシミュレーションです。
5 * 実際のアプリケーションでは、paho-mqtt/php-clientのような
6 * 既存のMQTTクライアントライブラリを使用します。
7 */
8class MqttClient
9{
10    private bool $connected = false;
11    private string $host;
12    private int $port;
13
14    /**
15     * コンストラクタ。MQTTブローカーのホストとポートを設定します。
16     *
17     * @param string $host ブローカーのホスト名またはIPアドレス
18     * @param int $port ブローカーのポート番号
19     */
20    public function __construct(string $host, int $port)
21    {
22        $this->host = $host;
23        $this->port = $port;
24    }
25
26    /**
27     * MQTTブローカーへの接続を試みます。
28     * この例では、接続の成否をランダムにシミュレートします。
29     * 実際のライブラリでは、ネットワーク接続やハンドシェイク処理が行われます。
30     *
31     * @return bool 接続に成功した場合はtrue、失敗した場合はfalse
32     */
33    public function connect(): bool
34    {
35        echo "{$this->host}:{$this->port}への接続を試行中...\n";
36        // 80%の確率で接続成功をシミュレート
37        if (rand(1, 10) <= 8) {
38            $this->connected = true;
39            echo "接続に成功しました。\n";
40            return true;
41        } else {
42            $this->connected = false;
43            echo "接続に失敗しました。\n";
44            return false;
45        }
46    }
47
48    /**
49     * 現在MQTTブローカーに接続されているかを確認します。
50     *
51     * @return bool 接続中の場合はtrue、そうでない場合はfalse
52     */
53    public function isConnected(): bool
54    {
55        return $this->connected;
56    }
57
58    /**
59     * MQTTブローカーから切断します。
60     */
61    public function disconnect(): void
62    {
63        if ($this->connected) {
64            echo "{$this->host}:{$this->port}から切断中...\n";
65            $this->connected = false;
66            echo "切断しました。\n";
67        }
68    }
69}
70
71/**
72 * MQTTクライアントの接続状態を確認するサンプル関数です。
73 * システムエンジニアを目指す初心者向けに、接続のライフサイクルを示します。
74 */
75function demonstrateMqttConnectionStatus(): void
76{
77    // MQTTブローカーの接続情報を設定します。
78    // 実際のアプリケーションでは、適切なブローカーアドレスを使用します。
79    $brokerHost = 'test.mosquitto.org';
80    $brokerPort = 1883;
81
82    // MQTTクライアントのインスタンスを作成します。
83    $client = new MqttClient($brokerHost, $brokerPort);
84
85    // 接続前の状態を確認します。
86    echo "クライアントは接続されていますか？ " . ($client->isConnected() ? 'はい' : 'いいえ') . "\n";
87
88    // 接続を試みます。
89    $client->connect();
90
91    // 接続試行後の状態を確認します。
92    echo "接続試行後、クライアントは接続されていますか？ " . ($client->isConnected() ? 'はい' : 'いいえ') . "\n";
93
94    // 接続されていれば切断します。
95    $client->disconnect();
96
97    // 切断後の状態を確認します。
98    echo "切断後、クライアントは接続されていますか？ " . ($client->isConnected() ? 'はい' : 'いいえ') . "\n";
99}
100
101// サンプル関数を実行します。
102demonstrateMqttConnectionStatus();

このサンプルコードは、PHPで外部システムとの接続状態を確認する一般的な方法を、MQTTクライアントのシミュレーションを通じて示すものです。

MqttClientクラスは、MQTTブローカーへの接続と切断を模倣し、その状態を管理します。このクラスに定義されているisConnected()メソッドは、現在MQTTブローカーに接続しているかどうかを判断するために利用されます。このメソッドは引数を一切取らず、現在の接続状態を示すブール値（真偽値）を戻り値として返します。具体的には、接続が確立されていればtrue（真）、接続されていない状態であればfalse（偽）を返します。

demonstrateMqttConnectionStatus()関数では、MqttClientのインスタンスを作成し、接続前、接続試行後、切断後の各段階でisConnected()を呼び出して、接続状態がどのように変化するかを具体的に確認しています。これにより、アプリケーションが外部サービスと連携する際に、現在の接続状態を正確に把握し、それに応じた適切な処理を行うための基本的なロジックを学ぶことができます。paho-mqtt/php-clientのような実際のMQTTクライアントライブラリでも、同様のisConnected機能が提供されており、外部サービス連携における接続管理の基本となります。

Copy
1<?php
2
3require_once 'vendor/autoload.php';
4
5use PhpMqtt\Client\MqttClient;
6use PhpMqtt\Client\Exceptions\MqttClientException;
7
8/**
9 * Paho MQTT クライアントを使用して、接続ロストを処理するサンプルコード。
10 *
11 * システムエンジニアを目指す初心者が、ネットワーク接続の問題（Paho接続ロスト）を
12 * どのようにコードで扱うかを理解するのに役立ちます。
13 *
14 * このコードを実行する前に、Composerで `php-mqtt/client` ライブラリをインストールしてください。
15 * `composer require php-mqtt/client`
16 */
17class MqttConnectionHandler
18{
19    private MqttClient $mqttClient;
20    private string $brokerHost;
21    private int $brokerPort;
22    private string $clientId;
23
24    /**
25     * コンストラクタ。MQTTクライアントを初期化し、イベントハンドラを設定します。
26     *
27     * @param string $brokerHost MQTTブローカーのホスト名またはIPアドレス
28     * @param int $brokerPort MQTTブローカーのポート番号
29     * @param string $clientId クライアントID
30     */
31    public function __construct(string $brokerHost, int $brokerPort, string $clientId)
32    {
33        $this->brokerHost = $brokerHost;
34        $this->brokerPort = $brokerPort;
35        $this->clientId = $clientId;
36
37        // MQTTクライアントのインスタンスを作成
38        $this->mqttClient = new MqttClient($brokerHost, $brokerPort, $clientId);
39
40        // 接続ロスト時のコールバックを設定
41        // ブローカーとの接続が予期せず切断された場合に呼び出されます。
42        $this->mqttClient->onConnectionLost(function (Throwable $exception) {
43            echo "WARN: MQTT Connection Lost! " . $exception->getMessage() . PHP_EOL;
44            // ここに再接続ロジックやエラー通知ロジックを実装します。
45            // 自動再接続を試みる例:
46            $this->reconnect();
47        });
48
49        // メッセージ受信時のコールバック（任意）
50        $this->mqttClient->onMessage(function (string $topic, string $message, bool $retained, MqttClient $mqtt) {
51            echo "INFO: Received message on topic '{$topic}': {$message}" . PHP_EOL;
52        });
53    }
54
55    /**
56     * MQTTブローカーに接続します。
57     * 接続に失敗した場合はエラーメッセージを出力し、アプリケーションを終了します。
58     */
59    public function connect(): void
60    {
61        try {
62            $this->mqttClient->connect();
63            echo "INFO: Connected to MQTT broker {$this->brokerHost}:{$this->brokerPort}" . PHP_EOL;
64
65            // 接続成功後にトピックを購読
66            $this->mqttClient->subscribe('test/topic', function (string $topic, string $message, bool $retained, MqttClient $mqtt) {
67                echo "INFO: Received message on topic '{$topic}': {$message}" . PHP_EOL;
68            });
69        } catch (MqttClientException $e) {
70            echo "ERROR: Failed to connect to MQTT broker: " . $e->getMessage() . PHP_EOL;
71            // 接続失敗時はアプリケーションを終了
72            exit(1);
73        }
74    }
75
76    /**
77     * 接続がロストした場合に再接続を試みます。
78     * 複数回リトライし、指数バックオフで待機します。
79     */
80    private function reconnect(): void
81    {
82        echo "INFO: Attempting to reconnect to MQTT broker..." . PHP_EOL;
83        $maxAttempts = 5;
84        for ($attempt = 1; $attempt <= $maxAttempts; $attempt++) {
85            try {
86                $this->mqttClient->connect();
87                echo "INFO: Successfully reconnected after {$attempt} attempts." . PHP_EOL;
88                // 再接続後、購読を再設定する必要がある場合が多い
89                $this->mqttClient->subscribe('test/topic', function (string $topic, string $message, bool $retained, MqttClient $mqtt) {
90                    echo "INFO: Received message on topic '{$topic}': {$message}" . PHP_EOL;
91                });
92                return; // 再接続成功
93            } catch (MqttClientException $e) {
94                echo "WARN: Reconnection attempt {$attempt} failed: " . $e->getMessage() . PHP_EOL;
95                if ($attempt < $maxAttempts) {
96                    sleep(2 ** $attempt); // 指数バックオフで待機 (1s, 2s, 4s, 8s...)
97                }
98            }
99        }
100        echo "CRITICAL: Failed to reconnect after {$maxAttempts} attempts. Exiting." . PHP_EOL;
101        exit(1); // 再接続に失敗した場合はアプリケーションを終了
102    }
103
104    /**
105     * クライアントがメッセージを待ち受け、ループ処理を行います。
106     * この関数は通常、長時間実行されるデーモンプロセスなどで使用されます。
107     * ループ中に接続がロストした場合、`onConnectionLost`コールバックが呼び出され、
108     * 再接続が試みられます。
109     */
110    public function loop(): void
111    {
112        // loop(true) はメッセージを受信するまでブロックし、内部でコールバックを処理します。
113        // これにより、接続ロストやメッセージ受信イベントが適切に処理されます。
114        $this->mqttClient->loop(true); 
115    }
116
117    /**
118     * クライアントを切断します。
119     * 接続されている場合のみ切断処理を行います。
120     */
121    public function disconnect(): void
122    {
123        if ($this->mqttClient->isConnected()) {
124            $this->mqttClient->disconnect();
125            echo "INFO: Disconnected from MQTT broker." . PHP_EOL;
126        }
127    }
128}
129
130$brokerHost = 'localhost';
131$brokerPort = 1883;
132// 実行ごとにユニークなクライアントIDを生成
133$clientId = 'php_connection_lost_example_' . getmypid(); 
134
135$handler = new MqttConnectionHandler($brokerHost, $brokerPort, $clientId);
136$handler->connect();
137
138echo "INFO: MQTTクライアントのループを開始しました。接続ロストの動作を確認するには、このスクリプトの実行中にMQTTブローカーを停止してください。" . PHP_EOL;
139try {
140    $handler->loop();
141} catch (MqttClientException $e) {
142    echo "ERROR: MQTTクライアントのループ中にエラーが発生しました: " . $e->getMessage() . PHP_EOL;
143} catch (Throwable $e) {
144    echo "CRITICAL: 予期せぬエラーが発生しました: " . $e->getMessage() . PHP_EOL;
145} finally {
146    // スクリプト終了時にクリーンアップ
147    $handler->disconnect();
148}

このPHPサンプルコードは、Paho MQTTクライアントライブラリ（php-mqtt/client）を用いて、MQTTブローカーとの接続が予期せず切断された場合の処理（接続ロストハンドリング）を学ぶためのものです。システムエンジニアを目指す初心者が、ネットワーク接続の問題をコードでどのように扱い、アプリケーションの堅牢性を高めるかを理解するのに役立ちます。

MqttConnectionHandlerクラスはMqttClientインスタンスを管理し、特にonConnectionLostメソッドを通じて、接続ロスト時に自動で再接続を試みるコールバックロジックを実装しています。これにより、一時的なネットワーク障害から回復し、アプリケーションの安定稼働を支援します。connectメソッドで初期接続を行い、loopメソッドでメッセージの受信やイベント処理を継続的に行います。

接続が失われた場合、登録されたonConnectionLostコールバックが呼び出され、プライベートメソッドreconnectが複数回のリトライと指数バックオフを用いて再接続を試みます。

また、disconnectメソッド内では$this->mqttClient->isConnected()が利用されています。このメソッドは、現在のMQTTクライアントがブローカーにアクティブに接続しているかどうかを真偽値（trueまたはfalse）で確認するために使用されます。引数はなく、現在の接続状態を明確に示しますので、不必要な切断処理を避け、安全にリソースを解放するのに役立ちます。このコードは、不安定なネットワーク環境下でも信頼性の高いMQTT通信を維持するための、基本的な接続管理戦略を示しています。