diff options
author | Maurice Kalinowski <maurice.kalinowski@qt.io> | 2019-11-14 13:45:09 +0100 |
---|---|---|
committer | Maurice Kalinowski <maurice.kalinowski@qt.io> | 2019-11-15 19:14:28 +0100 |
commit | 0e360b6b6e71ec871782306ad13e4fc58ab6f852 (patch) | |
tree | c2de51a30789c9c09e81e8c65e02d831e27af111 | |
parent | 38610dd856ee2969e82d23cb28b68576023e3b07 (diff) |
Add documentation for QMqttMessageStatusProperties
Fixes: QTBUG-76427
Change-Id: Ibc9cb2abe1260b9b478965316ed1c0d24904ce8e
Reviewed-by: Maurice Kalinowski <maurice.kalinowski@qt.io>
-rw-r--r-- | src/mqtt/qmqttpublishproperties.cpp | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/src/mqtt/qmqttpublishproperties.cpp b/src/mqtt/qmqttpublishproperties.cpp index 77e2118..b3372b1 100644 --- a/src/mqtt/qmqttpublishproperties.cpp +++ b/src/mqtt/qmqttpublishproperties.cpp @@ -269,6 +269,24 @@ void QMqttPublishProperties::setContentType(const QString &type) data->contentType = type; } +/*! + \class QMqttMessageStatusProperties + + \inmodule QtMqtt + \since 5.12 + + \brief The QMqttMessageStatusProperties class represents additional + information provided by the server during message delivery. + + 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. +*/ QMqttMessageStatusProperties::QMqttMessageStatusProperties() : data(new QMqttMessageStatusPropertiesData) { @@ -281,16 +299,25 @@ QMqttMessageStatusProperties &QMqttMessageStatusProperties::operator=(const QMqt return *this; } +/*! + Returns the reason code of a failed message delivery. +*/ QMqtt::ReasonCode QMqttMessageStatusProperties::reasonCode() const { return data->reasonCode; } +/*! + Returns the reason string of a failed message delivery. +*/ QString QMqttMessageStatusProperties::reason() const { return data->reasonString; } +/*! + Returns properties specified in conjunction with a message. +*/ QMqttUserProperties QMqttMessageStatusProperties::userProperties() const { return data->userProperties; |