MQTT.Client

説明

このクラスでは、MQTTブローカーへのクライアント接続を作成できます。

クライアントはブローカーにメッセージをパブリッシュすることができます。また、クライアントは、1つ以上のトピックに対してサブスクライブでき、そのトピックに関して他のクライアントからパブリッシュされたメッセージを受信できます。
このクラスは、mosquittoクライアントライブラリを使用します。詳細については、mosquitto.orgとmosquitto.hを参照してください。
このクラスを使用するには、次の手順を実行します。

1. 作成
2. 設定
3. 接続
4. 通信
5. 切断
6. 破棄

作成

クライアントを作成するには、ID、バージョン、クリーンスタートフラグを指定します。

MQTT.Client c = MQTT.Client("my-client-id", MQTT.Version.v31, 1);

デフォルトの引数の使用を選択することもできます。

MQTT.Client c = MQTT.Client("");

IDがブランクの場合、クライアントはIDをランダムに生成します。

上記の場合、作成したクライアントは、FlexScript関数の実行が終了すると、自動的に破棄されます。より永続的な接続を作成するには、次のようにクライアントのツリーノードを指定します。

treenode holder = Model.find("path/to/target/node");
MQTT.Client c = MQTT.Client("my-client-id", MQTT.Version.v31, 1, holder);

ノードをこのように供給すると、クライアントのデータはノードに格納されます。このクライアントに後でアクセスするには、次のように指定します。

treenode holder = Model.find("path/to/target/node");
MQTT.Client c = holder;
// OR
MQTT.Client c = MQTT.Client(holder);

クライアントデータを持たないノードからクライアントを作成すると、エラーになります。

設定

作成したクライアントには、設定を行うことができます。

• 必要な場合は、setWill()でWillメッセージを設定します。Willメッセージの使用は任意であり、クライアントが予期せずに切断された場合にのみパブリッシュされます。
• ブローカーで必要な場合は、setUsernamePassword()でユーザー名とパスワードを設定します。
• ブローカーで必要な場合は、setSSL()でSSLオプションを設定します。

ブローカーからのメッセージをFlexSimで受信する方法も決める必要があります。次の2つのオプションがあります。

• getMessage()でメッセージを待つ。または
• コールバックとして使用するノードをsetDefaultCallback()で指定する。このコールバックは、メッセージが受信されるたびに呼び出されます。

設定は不可逆的

大半の設定関数で行った変更は、クライアントで取り消すことはできません。たとえば、ユーザー名とパスワードを設定すると、そのユーザー名とパスワードを削除することはできません。クライアントの設定を変更する必要がある場合は、新しいクライアントを作成してください。

永続的なクライアントを作成する場合は、まず、正しく接続される永続的ではないクライアントを作成し、設定が正しいことを確認してください。

接続

ブローカーに接続するには、ホスト、ポート、キープアライブ間隔を指定します。

int code = c.connect("localhost", 1883, 60);

接続すると、ブローカーとの間で通信が可能になります。通信を終了した時点で、必ず切断してください。

切断した後で、以前使用したものとまったく同じ設定でクライアントを再接続できます。

int code = c.connect();

接続の簡易バージョンを使用するには、次の条件を満たす必要があります。

1. クライアントが過去に正しく接続しており、どのような設定関数も呼び出していない。または
2. クライアントがノードにバインドされており、すべてのメンバーノードの値が正しく設定されている（開発者向け）。

通信

MQTTでは、クライアントどうしは直接通信を行いません。代わりに、メッセージをパブリッシュします。メッセージにはトピックとペイロードが含まれます。どのクライアントもトピックに対してサブスクライブできます。サブスクライブしたクライアントは、そのトピックについてパブリッシュされたすべてのメッセージを受信します。

ブローカーの主な役割は、パブリッシュされたメッセージを、現在のトピックに対してサブスクライブしているすべてのクライアントに配布することです。接続しているクライアントのみがメッセージを受信します。ブローカーが後で使用するためにメッセージを格納することはありません。唯一の例外は、保持メッセージです。メッセージが保持される場合、ブローカーはそのトピックの最新メッセージを保管します。クライアントがサブスクライブするとすぐに、ブローカーは保持メッセージ（ある場合）を送信します。

接続したクライアントは、1つ以上のトピックに対してサブスクライブできます。

int rc = c.subscribe("some-topic");

コールバックノードが設定されている場合、メッセージが到着するたびに、コールバックノードが評価されます。設定されていない場合、クライアントは着信メッセージをキューに格納し、取り出されるまで維持します。

MQTT.Message msg = c.getMessage(5.0);
// Check if the message was received
if (msg) {
    // use the message
    print(msg.topic, msg.payload);
}

メッセージをパブリッシュするには、MQTT.Messageオブジェクトを作成し、パブリッシュします。

MQTT.Message msg = Message("some-topic", "some-message");
int rc = c.publish(msg);
        

切断

クライアントは次のように切断できます。

int rc = c.disconect();

切断されたクライアントは、以後、ブローカーからメッセージを受信しません。

破棄

クライアントをノードにバインドしていない場合、クライアントが作成されたFlexScript関数が終了すると、クライアントは自動的に破棄されます。クライアントがノードにバインドされている場合、ノードが破棄されるか、ノードのデータが変更されたときに、クライアントは破棄されます。

プロパティ

プロパティは高度な機能であり、大半のユーザーは無視しても問題ありません。

プロパティはMQTT 5.0で導入されました。プロパティはクライアントの大半のメソッドに渡すことができるほか、メッセージに含めることもできます。MQTT.Clientクラスは、プロパティをMapで表します。クライアントはマップ内のキーと値をすべて有効なMQTTプロパティに変換しようとします。キーがテキストであり、有効なプロパティ名でない場合、クライアントはキーと値をユーザープロパティとして使用します。

プロパティの一覧はMQTT 5.0仕様（https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901027）に記載されています。ここには、特定のAPI呼び出しにどのプロパティが有効かも記載されています。

プロパティ

isConnected	クライアントが現在ブローカーに接続しているかどうかを返します。
settings	作成、設定、接続に関するすべての値のセットを返します。

メソッド

connect	クライアントをブローカーに接続します。
disconnect	ブローカーからクライアントを切断します。
getMessage	クライアントがメッセージを受信するのを待ちます。
publish	メッセージをパブリッシュします。
setDefaultCallback	メッセージを受信したときに評価するノードを指定します。
setSSL	TLS/SSLに使用するオプションを指定します。
setUsernamePassword	クライアントのユーザー名とパスワードを指定します。
setWill	クライアントのWillメッセージを設定します。
subscribe	クライアントをトピックに対してサブスクライブします。
unsubscribe	トピックからサブスクライブを解除します。

コンストラクター

MQTT.Client

演算子

=	特定のノードに格納されているクライアントにアクセスします。