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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
|
/****************************************************************************
**
** Copyright (C) 2019 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtCoap 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 "qcoapconnection_p.h"
#include <QtCore/qloggingcategory.h>
QT_BEGIN_NAMESPACE
Q_LOGGING_CATEGORY(lcCoapConnection, "qt.coap.connection")
/*!
\internal
\class QCoapConnection
\inmodule QtCoap
\brief The QCoapConnection class defines an interface for
handling transfers of frames to a server.
It isolates CoAP clients from the transport in use, so that any
client can be used with any supported transport.
*/
/*!
\internal
\enum QCoapConnection::ConnectionState
This enum specifies the state of the underlying transport.
\value Unconnected The underlying transport is not yet ready for data transmission.
\value Bound The underlying transport is ready for data transmission. For example,
if QUdpSocket is used for the transport, this corresponds to
QAbstractSocket::BoundState.
\sa state(), bound()
*/
/*!
\internal
\fn void QCoapConnection::error(QAbstractSocket::SocketError error)
This signal is emitted when a connection error occurs. The \a error
parameter describes the type of error that occurred.
*/
/*!
\internal
\fn void QCoapConnection::readyRead(const QByteArray &data, const QHostAddress &sender)
This signal is emitted when a network reply is available. The \a data
parameter supplies the received data, and the \a sender parameter supplies
the sender address.
*/
/*!
\internal
\fn void QCoapConnection::bound()
This signal is emitted when the underlying transport is ready for data transmission.
Derived implementations must emit this signal whenever they are ready to start
transferring data frames to and from the server.
\sa bind()
*/
/*!
\fn void QCoapConnection::securityConfigurationChanged()
This signal is emitted when the security configuration is changed.
*/
/*!
\internal
\fn void QCoapConnection::bind(const QString &host, quint16 port)
Prepares the underlying transport for data transmission to to the given \a host
address on \a port. Emits the bound() signal when the transport is ready.
This is a pure virtual method.
\sa bound(), close()
*/
/*!
\internal
\fn void QCoapConnection::close()
Closes the open sockets and connections to free the underlying transport.
This is a pure virtual method.
\sa bind()
*/
/*!
\internal
\fn void QCoapConnection::writeData(const QByteArray &data, const QString &host, quint16 port)
Sends the given \a data frame to the host address \a host at port \a port.
This is a pure virtual method.
*/
QCoapConnectionPrivate::QCoapConnectionPrivate(QtCoap::SecurityMode security)
: securityMode(security)
, state(QCoapConnection::ConnectionState::Unconnected)
{}
/*!
Constructs a new CoAP connection for the given \a securityMode and
sets \a parent as its parent.
*/
QCoapConnection::QCoapConnection(QtCoap::SecurityMode securityMode, QObject *parent)
: QCoapConnection(*new QCoapConnectionPrivate(securityMode), parent)
{
}
/*!
\internal
Constructs a new new CoAP connection as a child of \a parent, with \a dd
as its \c d_ptr. This constructor must be used when internally subclassing
the QCoapConnection class.
*/
QCoapConnection::QCoapConnection(QObjectPrivate &dd, QObject *parent)
: QObject(dd, parent)
{
connect(this, &QCoapConnection::bound, this,
[this]() {
Q_D(QCoapConnection);
d->state = ConnectionState::Bound;
startToSendRequest();
});
}
/*!
\internal
Releases any resources held by QCoapConnection.
*/
QCoapConnection::~QCoapConnection()
{
}
/*!
\internal
Prepares the underlying transport for data transmission and sends the given
\a request frame to the given \a host at the given \a port when the transport
is ready.
The preparation of the transport is done by calling the pure virtual bind() method,
which needs to be implemented by derived classes.
*/
void
QCoapConnectionPrivate::sendRequest(const QByteArray &request, const QString &host, quint16 port)
{
Q_Q(QCoapConnection);
CoapFrame frame(request, host, port);
framesToSend.enqueue(frame);
if (state == QCoapConnection::ConnectionState::Unconnected)
q->bind(host, port);
else
q->startToSendRequest();
}
/*!
\internal
Returns \c true if security is used, returns \c false otherwise.
*/
bool QCoapConnection::isSecure() const
{
Q_D(const QCoapConnection);
return d->securityMode != QtCoap::SecurityMode::NoSecurity;
}
/*!
\internal
Returns the security mode.
*/
QtCoap::SecurityMode QCoapConnection::securityMode() const
{
Q_D(const QCoapConnection);
return d->securityMode;
}
/*!
\internal
Returns the connection state.
*/
QCoapConnection::ConnectionState QCoapConnection::state() const
{
Q_D(const QCoapConnection);
return d->state;
}
/*!
\internal
Sends the last stored frame to the server by calling the pure virtual
writeData() method.
*/
void QCoapConnection::startToSendRequest()
{
Q_D(QCoapConnection);
Q_ASSERT(!d->framesToSend.isEmpty());
const CoapFrame frame = d->framesToSend.dequeue();
writeData(frame.currentPdu, frame.host, frame.port);
}
/*!
Sets the security configuration parameters from the \a configuration.
The security configuration will be ignored if the QtCoap::NoSecurity mode is
used for connection.
\note This method must be called before the handshake starts.
*/
void QCoapConnection::setSecurityConfiguration(const QCoapSecurityConfiguration &configuration)
{
Q_D(QCoapConnection);
if (isSecure()) {
d->securityConfiguration = configuration;
emit securityConfigurationChanged();
} else {
qCWarning(lcCoapConnection, "Security is disabled, security configuration will be ignored.");
}
}
/*!
\internal
Returns the security configuration.
*/
QCoapSecurityConfiguration QCoapConnection::securityConfiguration() const
{
Q_D(const QCoapConnection);
return d->securityConfiguration;
}
/*!
\internal
Closes the open sockets and connections to free the transport and clears
the connection state.
*/
void QCoapConnection::disconnect()
{
Q_D(QCoapConnection);
close();
d->framesToSend.clear();
d->state = ConnectionState::Unconnected;
}
QT_END_NAMESPACE
|