QMqttMessageStatusProperties Class

The QMqttMessageStatusProperties class represents additional information provided by the server during message delivery. More...

Header: #include <QMqttMessageStatusProperties>
CMake: find_package(Qt6 REQUIRED COMPONENTS Mqtt)
target_link_libraries(mytarget PRIVATE Qt6::Mqtt)
qmake: QT += mqtt

Public Functions

QString reason() const
QMqtt::ReasonCode reasonCode() const
QMqttUserProperties userProperties() const

Detailed Description

Depending on the QoS level of a message being sent by QMqttClient::publish(), a server reports the state of delivery. Additionally to the QMqtt::MessageStatus, complementary information might be included by the server. These are exposed to users via QMqttMessageStatusProperties.

Note: Message status properties are part of the MQTT 5.0 specification and cannot be used when connecting with a lower protocol level. See QMqttClient::ProtocolVersion for more information.

Member Function Documentation

QString QMqttMessageStatusProperties::reason() const

Returns the reason string of a failed message delivery.

QMqtt::ReasonCode QMqttMessageStatusProperties::reasonCode() const

Returns the reason code of a failed message delivery.

QMqttUserProperties QMqttMessageStatusProperties::userProperties() const

Returns properties specified in conjunction with a message.

© 2024 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.