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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
/******************************************************************************
**
** 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$
**
******************************************************************************/
#ifndef QTMQTTCLIENT_H
#define QTMQTTCLIENT_H
#include <QtMqtt/qmqttglobal.h>
#include <QtMqtt/qmqttauthenticationproperties.h>
#include <QtMqtt/qmqttconnectionproperties.h>
#include <QtMqtt/qmqttpublishproperties.h>
#include <QtMqtt/qmqttsubscription.h>
#include <QtMqtt/qmqttsubscriptionproperties.h>
#include <QtMqtt/qmqtttopicfilter.h>
#include <QtCore/QIODevice>
#include <QtCore/QObject>
#include <QtCore/QSharedPointer>
#include <QtNetwork/QTcpSocket>
QT_BEGIN_NAMESPACE
class QMqttClientPrivate;
class Q_MQTT_EXPORT QMqttClient : public QObject
{
public:
enum TransportType {
IODevice = 0,
AbstractSocket,
SecureSocket
};
enum ClientState {
Disconnected = 0,
Connecting,
Connected
};
enum ClientError {
// Protocol states
NoError = 0,
InvalidProtocolVersion = 1,
IdRejected = 2,
ServerUnavailable = 3,
BadUsernameOrPassword = 4,
NotAuthorized = 5,
// Qt states
TransportInvalid = 256,
ProtocolViolation,
UnknownError,
Mqtt5SpecificError
};
enum ProtocolVersion {
MQTT_3_1 = 3,
MQTT_3_1_1 = 4,
MQTT_5_0 = 5
};
private:
Q_OBJECT
Q_ENUMS(ClientState)
Q_ENUMS(ClientError)
Q_PROPERTY(QString clientId READ clientId WRITE setClientId NOTIFY clientIdChanged)
Q_PROPERTY(QString hostname READ hostname WRITE setHostname NOTIFY hostnameChanged)
Q_PROPERTY(quint16 port READ port WRITE setPort NOTIFY portChanged)
Q_PROPERTY(quint16 keepAlive READ keepAlive WRITE setKeepAlive NOTIFY keepAliveChanged)
Q_PROPERTY(ProtocolVersion protocolVersion READ protocolVersion WRITE setProtocolVersion NOTIFY protocolVersionChanged)
Q_PROPERTY(ClientState state READ state WRITE setState NOTIFY stateChanged)
Q_PROPERTY(ClientError error READ error WRITE setError NOTIFY errorChanged)
Q_PROPERTY(QString username READ username WRITE setUsername NOTIFY usernameChanged)
Q_PROPERTY(QString password READ password WRITE setPassword NOTIFY passwordChanged)
Q_PROPERTY(bool cleanSession READ cleanSession WRITE setCleanSession NOTIFY cleanSessionChanged)
Q_PROPERTY(QString willTopic READ willTopic WRITE setWillTopic NOTIFY willTopicChanged)
Q_PROPERTY(QByteArray willMessage READ willMessage WRITE setWillMessage NOTIFY willMessageChanged)
Q_PROPERTY(quint8 willQoS READ willQoS WRITE setWillQoS NOTIFY willQoSChanged)
Q_PROPERTY(bool willRetain READ willRetain WRITE setWillRetain NOTIFY willRetainChanged)
public:
explicit QMqttClient(QObject *parent = nullptr);
void setTransport(QIODevice *device, TransportType transport);
QIODevice *transport() const;
QMqttSubscription *subscribe(const QMqttTopicFilter &topic, quint8 qos = 0);
QMqttSubscription *subscribe(const QMqttTopicFilter &topic,
const QMqttSubscriptionProperties &properties, quint8 qos = 0);
void unsubscribe(const QMqttTopicFilter &topic);
void unsubscribe(const QMqttTopicFilter &topic, const QMqttUnsubscriptionProperties &properties);
Q_INVOKABLE qint32 publish(const QMqttTopicName &topic, const QByteArray &message = QByteArray(),
quint8 qos = 0, bool retain = false);
Q_INVOKABLE qint32 publish(const QMqttTopicName &topic, const QMqttPublishProperties &properties,
const QByteArray &message = QByteArray(),
quint8 qos = 0,
bool retain = false);
bool requestPing();
QString hostname() const;
quint16 port() const;
QString clientId() const;
quint16 keepAlive() const;
ProtocolVersion protocolVersion() const;
Q_INVOKABLE void connectToHost();
#ifndef QT_NO_SSL
Q_INVOKABLE void connectToHostEncrypted(const QString &sslPeerName = QString());
#endif
Q_INVOKABLE void disconnectFromHost();
ClientState state() const;
ClientError error() const;
QString username() const;
QString password() const;
bool cleanSession() const;
QString willTopic() const;
quint8 willQoS() const;
QByteArray willMessage() const;
bool willRetain() const;
void setConnectionProperties(const QMqttConnectionProperties &prop);
QMqttConnectionProperties connectionProperties() const;
void setLastWillProperties(const QMqttLastWillProperties &prop);
QMqttLastWillProperties lastWillProperties() const;
QMqttServerConnectionProperties serverConnectionProperties() const;
void authenticate(const QMqttAuthenticationProperties &prop);
Q_SIGNALS:
void connected();
void disconnected();
void messageReceived(const QByteArray &message, const QMqttTopicName &topic = QMqttTopicName());
void messageStatusChanged(qint32 id, QMqtt::MessageStatus s, const QMqttMessageStatusProperties &properties);
void messageSent(qint32 id);
void pingResponseReceived();
void brokerSessionRestored();
void hostnameChanged(QString hostname);
void portChanged(quint16 port);
void clientIdChanged(QString clientId);
void keepAliveChanged(quint16 keepAlive);
void protocolVersionChanged(ProtocolVersion protocolVersion);
void stateChanged(ClientState state);
void errorChanged(ClientError error);
void usernameChanged(QString username);
void passwordChanged(QString password);
void cleanSessionChanged(bool cleanSession);
void willTopicChanged(QString willTopic);
void willQoSChanged(quint8 willQoS);
void willMessageChanged(QByteArray willMessage);
void willRetainChanged(bool willRetain);
void authenticationRequested(const QMqttAuthenticationProperties &p);
void authenticationFinished(const QMqttAuthenticationProperties &p);
public Q_SLOTS:
void setHostname(const QString &hostname);
void setPort(quint16 port);
void setClientId(const QString &clientId);
void setKeepAlive(quint16 keepAlive);
void setProtocolVersion(ProtocolVersion protocolVersion);
void setState(ClientState state);
void setError(ClientError error);
void setUsername(const QString &username);
void setPassword(const QString &password);
void setCleanSession(bool cleanSession);
void setWillTopic(const QString &willTopic);
void setWillQoS(quint8 willQoS);
void setWillMessage(const QByteArray &willMessage);
void setWillRetain(bool willRetain);
private:
void connectToHost(bool encrypted, const QString &sslPeerName);
Q_DISABLE_COPY(QMqttClient)
Q_DECLARE_PRIVATE(QMqttClient)
};
Q_DECLARE_TYPEINFO(QMqttClient::TransportType, Q_PRIMITIVE_TYPE);
Q_DECLARE_TYPEINFO(QMqttClient::ClientState, Q_PRIMITIVE_TYPE);
Q_DECLARE_TYPEINFO(QMqttClient::ClientError, Q_PRIMITIVE_TYPE);
QT_END_NAMESPACE
Q_DECLARE_METATYPE(QMqttClient::TransportType)
Q_DECLARE_METATYPE(QMqttClient::ClientState)
Q_DECLARE_METATYPE(QMqttClient::ClientError)
#endif // QTMQTTCLIENT_H
|
