QMqttSubscription Class
QMqttSubscription クラスは、MQTT ブローカーから指定したトピックに関する通知を受け取ります。詳細...
ヘッダー | #include <QMqttSubscription> |
CMake: | find_package(Qt6 REQUIRED COMPONENTS Mqtt) target_link_libraries(mytarget PRIVATE Qt6::Mqtt) |
qmake: | QT += mqtt |
継承: | 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::ProtocolVersion としてQMqttClient::MQTT_5_0 を指定した場合にのみ有効なデータを提供します。
© 2025 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.