QMqttSubscription Class
QMqttSubscription クラスは、MQTT ブローカーから指定したトピックに関する通知を受け取ります。詳細...
| Header: | #include <QMqttSubscription> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Mqtt)target_link_libraries(mytarget PRIVATE Qt6::Mqtt) |
| qmake: | QT += mqtt |
| Inherits: | QObject |
パブリックタイプ
| enum | SubscriptionState { Unsubscribed, SubscriptionPending, Subscribed, UnsubscriptionPending, Error } |
プロパティ
|
|
パブリック関数
| virtual | ~QMqttSubscription() override |
| bool | isSharedSubscription() const |
| quint8 | qos() const |
| QString | reason() const |
| QMqtt::ReasonCode | reasonCode() const |
| QString | sharedSubscriptionName() const |
| QMqttSubscription::SubscriptionState | state() const |
| QMqttTopicFilter | topic() const |
| QMqttUserProperties | userProperties() const |
パブリックスロット
| void | unsubscribe() |
シグナル
| void | messageReceived(QMqttMessage msg) |
| void | qosChanged(quint8) |
| void | stateChanged(QMqttSubscription::SubscriptionState state) |
メンバ型の説明
enum QMqttSubscription::SubscriptionState
この列挙型は、サブスクリプションが持つことができる状態を記述する。
| 定数 | 値 | 説明 |
|---|---|---|
QMqttSubscription::Unsubscribed | 0 | トピックは購読解除されました。 |
QMqttSubscription::SubscriptionPending | 1 | サブスクリプションのリクエストが送信されましたが、ブローカによってまだ確認されていません。 |
QMqttSubscription::Subscribed | 2 | 購読は成功し、メッセージは受信されます。 |
QMqttSubscription::UnsubscriptionPending | 3 | トピックの購読を解除するリクエストが送信されましたが、まだブローカによって確認されていません。 |
QMqttSubscription::Error | 4 | エラーが発生しました。 |
プロパティの説明
[read-only] qos : const quint8
このプロパティは、サブスクリプションが行われた QoS レベルを保持する。
サブスクリプションの QoS レベルは、クライアントがメッセージを受信する最大QoS レベルを指定する。パブリッシャーはより低いレベルでメッセージを送信することができる。
アクセス機能
| quint8 | qos() const |
ノーティファイアシグナル：
| void | qosChanged(quint8) |
[read-only] reason : const QString
このプロパティはサブスクリプションの理由文字列を保持する。
理由文字列はサブスクリプションに関する追加情報を提供するためにサーバーによって使用される。サーバーが送信するのは任意である。
アクセス関数：
| QString | reason() const |
[read-only] reasonCode : const QMqtt::ReasonCode
このプロパティはサブスクリプションの理由コードを保持する。
このプロパティはサブスクリプションの理由コードを保持する。理由コードは、サブスクリプションが失敗した場合はエラータイプを、成功した場合は QoS のレベルを指定する。
アクセス関数：
| QMqtt::ReasonCode | reasonCode() const |
[read-only] sharedSubscription : const bool
このプロパティはサブスクリプションが共有されているかどうかを保持する。
アクセス関数：
| bool | isSharedSubscription() const |
[read-only] sharedSubscriptionName : const QString
このプロパティは共有サブスクリプションの名前を保持する。
アクセス関数：
| QString | sharedSubscriptionName() const |
[read-only] state : const SubscriptionState
このプロパティはサブスクリプションの状態を保持する。
このプロパティはサブスクリプションの状態を保持する：
| QMqttSubscription::SubscriptionState | state() const |
通知シグナル
| void | stateChanged(QMqttSubscription::SubscriptionState state) |
[read-only] topic : const QMqttTopicFilter
このプロパティはサブスクリプションのトピックを保持する。
このプロパティはサブスクリプションのトピックを保持する：
| QMqttTopicFilter | topic() const |
メンバー関数 ドキュメント
[override virtual noexcept] QMqttSubscription::~QMqttSubscription()
購読を削除します。topic がまだ購読解除されていなければ、自動的に購読解除される。
[signal] void QMqttSubscription::messageReceived(QMqttMessage msg)
このシグナルは新しいメッセージmsg を受信したときに発行される。
[slot] void QMqttSubscription::unsubscribe()
topic から購読を解除します。
注意: これは、QMqttClient::subscribe() によって返されたすべての共有ポインタ・インスタンスに影響する可能性があります。
QMqttUserProperties QMqttSubscription::userProperties() const
サブスクリプションが受け入れられたときにブローカから受け取ったユーザープロパティを返します。
注意: この関数は、クライアントがQMqttClient::MQTT_5_0 をQMqttClient::ProtocolVersion として指定した場合にのみ有効なデータを提供します。
©2024 The Qt Company Ltd. 本書に含まれるドキュメントのコントリビューションの著作権は、それぞれの所有者に帰属します。 本書で提供されるドキュメントは、Free Software Foundation が発行したGNU Free Documentation License version 1.3に基づいてライセンスされています。 Qtおよびそれぞれのロゴは、フィンランドおよびその他の国におけるThe Qt Company Ltd.の 商標です。その他すべての商標は、それぞれの所有者に帰属します。
