EMQX Enterprise

日本語

简体中文
English

日本語

简体中文
English

Appearance

お問い合わせ
お問い合わせ

MQTT リテインドメッセージ ​

EMQX は MQTT のリテインドメッセージ機能を実装しています。特定のトピックでパブリッシュされたメッセージのうち、1つを Retained としてフラグを付け、EMQX 上に永続的なメッセージとして保存できます。新たにそのトピックにサブスクライブしたクライアントは、たとえそのメッセージがサブスクライブ前にパブリッシュされていても、即座にそのメッセージを受け取ることができます。

クライアントツールを使って EMQX に接続し、このメッセージングサービスを試すことができます。本節では、MQTTX Desktop と MQTTX CLI を使ってクライアントをシミュレートし、リテインドメッセージのパブリッシュと受信の動作を確認する方法を紹介します。

前提条件

MQTTX Desktop でリテインドメッセージをパブリッシュする ​

  1. EMQX と MQTTX Desktop を起動します。New Connection をクリックして、パブリッシャーとしてクライアント接続を作成します。

    • Name フィールドに Demo と入力します。
    • Host にローカルホストの 127.0.0.1 を入力します（本デモの例として）。
    • その他の設定はデフォルトのままにして、Connect をクリックします。

    TIP

    MQTT 接続の作成に関する詳細な手順は MQTTX Desktop を参照してください。

    新しい接続の設定

  2. 接続が成功したら、テキストボックスにトピック sensor/t1 を入力し、スクリーンショットのようにメッセージペイロードを作成します。送信ボタンをクリックしてください。トピック sensor/t1 へのメッセージがメッセージダイアログに表示されます。

    メッセージのパブリッシュ1

  3. トピック sensor/t2 でリテインドメッセージを2つパブリッシュします。

    • 最初のメッセージに 1 を入力し、Retain を選択して送信ボタンをクリックします。
    • 次に 2 を入力して送信ボタンをクリックします。
    メッセージのパブリッシュ2

  4. Connections ペインで + -> New Connection をクリックし、メッセージを受信するクライアントとしてサブスクライバー Subscriber を作成します。

  5. + New Subscription をクリックしてトピック sensor/+ をサブスクライブし、Confirm ボタンをクリックします。

    TIP

    トピックを sensor/+ に設定すると、sensor/t1 と sensor/t2 の両方がサブスクライブされます。トピックとワイルドカードの詳細については Understanding MQTT Topics & Wildcards by Case を参照してください。

    クライアント Subscriber は、トピック sensor/t1 の最初のメッセージや、トピック sensor/t2 の最初のリテインドメッセージは受信せず、各トピックの最新のリテインドメッセージのみを受信することが分かります。これは EMQX が各トピックの最新のリテインドメッセージのみを保存しているためです。

    リテインドメッセージの受信

これで MQTTX クライアントを使ったリテインドメッセージの送信を試しました。EMQX のダッシュボードから保存されている最新のリテインドメッセージを確認することもできます。詳細は ダッシュボードでリテインドメッセージを確認する を参照してください。

MQTTX CLI でリテインドメッセージをパブリッシュする ​

  1. クライアントで接続要求を開始します。

  2. 以下のコマンドを使ってリテインドメッセージをパブリッシュします。トピックは t/1、ペイロードは A retained message from MQTTX CLI、retain = true に設定します：

    bash
    mqttx pub -t 't/1' -m 'A retained message from MQTTX CLI' --retain true -h 'localhost' -p 1883

  3. 同じブローカーに対して別の新しいクライアント接続要求を開始し、新しいクライアントでトピック t/1 をサブスクライブします。リテインドメッセージを受信します。

    新しいクライアントを継続的に作成し、トピック t/1 をサブスクライブさせると、作成したすべての新しいクライアントがリテインドメッセージを受信します。

    bash
    $ mqttx sub -t 't/1' -h 'localhost' -p 1883 -v
topic:  t/1
payload:  A retained message from MQTTX CLI
retain: true

  4. 空のメッセージをパブリッシュしてリテインドメッセージをクリアします：

    bash
    mqttx pub -t 't/1' -m '' --retain true -h 'localhost' -p 1883

  5. 新しいクライアント接続を開始し、トピック t/1 をサブスクライブします。リテインドメッセージが受信されず、リテインドメッセージがクリアされたことが確認できます。

ダッシュボードでリテインドメッセージを確認する ​

リテインドメッセージをパブリッシュすると、EMQX はこのメッセージをシステム内に保存します。リテインドメッセージ一覧ページでこのメッセージを確認できます。このリテインドメッセージのトピックをサブスクライブすると、EMQX はこのメッセージをトピックにパブリッシュし、即座に受信できます。

リテインドメッセージのデフォルトの有効期限は無期限であり、手動で削除しない限り期限切れにはなりません。

リテインドメッセージ一覧 ​

Monitoring -> Retained Messages ページでは、システム内のすべてのリテインドメッセージを確認できます。トピック、QoS（サービス品質）、パブリッシュ時間、クライアントIDなどが表示されます。検索ボックスで検索によるフィルタリングが可能で、トピックのワイルドカードもサポートしています。

このページでは、リテインドメッセージのペイロードを表示する Show Payload ボタンや、削除する Delete ボタンが利用できます。Refresh ボタンで一覧を更新し、Settings ボタンからリテインドメッセージの設定ページにアクセスできます。

デフォルトで以下の3種類のリテインドメッセージが システムトピック から確認できます：

  • $SYS/brokers/+/sysdescr: 現在の EMQX ノードのシステム説明
  • $SYS/brokers/+/version: 現在の EMQX ノードのバージョン番号
  • $SYS/brokers: 現在の EMQX のすべてのノードの数と名前
リテインドメッセージ一覧

リテインドメッセージの削除 ​

EMQX でリテインドメッセージを削除するには、クライアントでリテインドメッセージのトピックに空のメッセージをパブリッシュするか、EMQX ダッシュボードを使用します。ダッシュボードでは、特定のリテインドメッセージに対して Delete ボタンをクリックして削除できます。また、クラスター内のすべてのリテインドメッセージを一括削除する Clear All ボタンも利用可能です。さらに、リテインドメッセージの有効期限を設定できるリテインドメッセージ設定ページもあり、有効期限切れに応じて EMQX が自動的に削除します。