1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
/******************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtMqtt module.
**
** $QT_BEGIN_LICENSE:GPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) any later version
** approved by the KDE Free Qt Foundation. The licenses are as published by
** the Free Software Foundation and appearing in the file LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
******************************************************************************/
#include "qmqttmessage.h"
QT_BEGIN_NAMESPACE
/*!
\class QMqttMessage
\inmodule QtMqtt
\brief The QMqttMessage class provides information about a message received
from a message broker based on a subscription.
An MQTT message is created inside the module and returned via the
\l QMqttSubscription::messageReceived() signal.
*/
/*!
\property QMqttMessage::topic
\brief This property holds the topic of a message.
In case a wildcard has been used for a subscription, describes the topic
matching this subscription. This property never contains wildcards.
*/
/*!
\property QMqttMessage::payload
\brief This property holds the payload of a message.
*/
/*!
\property QMqttMessage::id
\brief This property holds the ID of the message.
IDs are used for messages with a QoS level above zero.
*/
/*!
\property QMqttMessage::qos
\brief This property holds the QoS level of a message.
*/
/*!
\property QMqttMessage::duplicate
\brief This property holds whether the message is a duplicate.
Duplicate messages indicate that the message has been sent earlier, but it
has not been confirmed yet. Hence, the broker assumes that it needs to
resend to verify the transport of the message itself. Duplicate messages
can only occur if the QoS level is one or two.
*/
/*!
\property QMqttMessage::retain
\brief This property holds whether the message has been retained.
A retained message is kept on the broker for future clients to subscribe.
Consequently, a retained message has been created previously and is not a
live update. A broker can store only one retained message per topic.
*/
QByteArray QMqttMessage::payload() const
{
return m_payload;
}
quint8 QMqttMessage::qos() const
{
return m_qos;
}
quint16 QMqttMessage::id() const
{
return m_id;
}
QString QMqttMessage::topic() const
{
return m_topic;
}
bool QMqttMessage::duplicate() const
{
return m_duplicate;
}
bool QMqttMessage::retain() const
{
return m_retain;
}
QMqttMessage::QMqttMessage(const QString &topic, const QByteArray &content, quint16 id, quint8 qos, bool dup, bool retain)
: m_topic(topic)
, m_payload(content)
, m_id(id)
, m_qos(qos)
, m_duplicate(dup)
, m_retain(retain)
{
}
QT_END_NAMESPACE
|
