QMqttSubscription类
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 | 发生错误。 |
属性文档
[只读] qos : const quint8
此属性包含已订阅的QoS级别。
订阅的QoS级别指定了客户端将接收消息的最大 QoS级别。发布者仍可以以较低级别发送消息。
访问函数
| quint8 | qos() const |
通知信号
| void | qosChanged(quint8) |
[只读] reason : const QString
此属性包含订阅的原因字符串。
原因字符串由服务器用于提供有关订阅的额外信息。对于服务器发送它是可选的。
访问函数
| QString | reason() const |
[只读] reasonCode : const QMqtt::ReasonCode
此属性包含订阅的原因代码。
原因代码指定了如果订阅失败，错误类型，或成功时的QoS级别。
访问函数
| QMqtt::ReasonCode | reasonCode() const |
[只读] sharedSubscription : const bool
此属性包含订阅是否共享。
访问函数
| bool | isSharedSubscription() const |
[只读] sharedSubscriptionName : const QString
此属性包含共享订阅的名称。
访问函数
| QString | sharedSubscriptionName() const |
[只读] state : const SubscriptionState
此属性包含订阅的状态。
访问函数
| QMqttSubscription::SubscriptionState | state() const |
通知信号
| void | stateChanged(QMqttSubscription::SubscriptionState state) |
[只读] topic : const QMqttTopicFilter
此属性包含订阅的主题。
访问函数
| QMqttTopicFilter | topic() const |
成员函数文档
[重写虚函数 noexcept] QMqttSubscription::~QMqttSubscription()
删除订阅。如果主题尚未退订，它将自动退订。
[信号] void QMqttSubscription::messageReceived(QMqttMessage msg)
当接收到新消息msg时，会发出此信号。
[槽函数] void QMqttSubscription::unsubscribe()
取消订阅主题。
注意：这可能会影响由QMqttClient::subscribe()返回的所有共享指针实例。
QMqttUserProperties QMqttSubscription::userProperties() const
返回当订阅被接受时从代理 收到的用户属性。
注意：此函数仅当客户端指定QMqttClient::MQTT_5_0作为QMqttClient::ProtocolVersion时才提供有效数据。
© 2024 Qt公司有限公司。此处包含的文档贡献属于各自的拥有者。本提供的文档受GNU自由文档许可协议版本1.3的条款约束，由自由软件基金会发布。Qt和相应的徽标是芬兰及其它国家Qt公司商标。所有其他商标均为其各自所有者的财产。
