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
297
298
299
300
301
302
303
304
305
|
/******************************************************************************
**
** Copyright (C) 2018 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtKnx 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 "qknxnetipframeheader.h"
#include "qknxutils.h"
QT_BEGIN_NAMESPACE
constexpr const quint8 QKnxNetIpFrameHeader::HeaderSize10;
constexpr const quint8 QKnxNetIpFrameHeader::KnxNetIpVersion10;
/*!
\class QKnxNetIpFrameHeader
\inmodule QtKnx
\ingroup qtknx-netip
\brief The QKnxNetIpFrameHeader class is a KNXnet/IP frame header.
The QKnxNetIpFrameHeader class contains the data and meta data related
to a KNXnet/IP frame. Every KNXnet/IP frame consists of at least the common
KNXnet/IP header. The common KNXnet/IP header contains information about
the protocol version, the header and total packet size, and a KNXnet/IP
service type identifier.
\sa {Qt KNXnet/IP Connection Classes}
*/
/*!
\fn QKnxNetIpFrameHeader::QKnxNetIpFrameHeader()
Constructs an empty invalid frame header object.
\sa isNull(), isValid()
*/
/*!
\fn QKnxNetIpFrameHeader::~QKnxNetIpFrameHeader()
Destroys the frame header object and releases all allocated resources.
*/
/*!
Constructs a valid frame header object and sets the KNXnet/IP service type
identifier to \a type.
\note By default a KNXnet/IP Version 1.0 frame header is constructed.
\sa isValid(), serviceType(), setServiceType()
*/
QKnxNetIpFrameHeader::QKnxNetIpFrameHeader(QKnxNetIp::ServiceType type)
: QKnxNetIpFrameHeader(type, 0)
{}
/*!
Constructs a valid frame header object. Sets the KNXnet/IP service type
identifier to \a type and the data size to \a dataSize and updates the
total size accordingly.
\note By default a KNXnet/IP Version 1.0 frame header is constructed.
\sa isValid(), serviceType(), setServiceType(), dataSize(), setDataSize()
*/
QKnxNetIpFrameHeader::QKnxNetIpFrameHeader(QKnxNetIp::ServiceType type, quint16 dataSize)
{
m_bytes[0] = HeaderSize10;
m_bytes[1] = KnxNetIpVersion10;
setServiceType(type);
setDataSize(dataSize);
}
/*!
Returns \c true if this is a default constructed header, otherwise returns
\c false. A header is considered null if it contains no initialized values.
*/
bool QKnxNetIpFrameHeader::isNull() const
{
return m_bytes[0] == 0x00 && m_bytes[1] == 0x00;
}
/*!
Returns \c true if the frame header contains initialized values and is in
itself valid, otherwise returns \c false. A valid KNXnet/IP frame header
consist of a header size, protocol version, a known \l serviceType identifier,
and a minimum total size.
\sa isNull()
*/
bool QKnxNetIpFrameHeader::isValid() const
{
if (isNull())
return false;
const auto headerSize = m_bytes[0];
if (m_bytes[1] == KnxNetIpVersion10) {
if (headerSize != HeaderSize10)
return {};
} else { // TODO: Adapt once we support other versions.
return {};
}
const auto totalSize = quint16(quint16(m_bytes[4]) << 8 | m_bytes[5]);
return QKnxNetIp::isServiceType(serviceType()) && totalSize >= headerSize;
}
/*!
Returns the size of the KNXnet/IP frame header.
\sa isNull(), isValid()
*/
quint8 QKnxNetIpFrameHeader::size() const
{
return m_bytes[0];
}
/*!
Sets the size of the KNXnet/IP frame header to \a size.
\sa size()
*/
quint8 QKnxNetIpFrameHeader::setSize(quint8 size)
{
return m_bytes[0] = size;
}
/*!
Returns the protocol version of the KNXnet/IP frame.
\sa isNull(), isValid()
*/
quint8 QKnxNetIpFrameHeader::protocolVersion() const
{
return m_bytes[1];
}
/*!
Sets the protocol version of the KNXnet/IP frame header to \a version.
\sa protocolVersion()
*/
void QKnxNetIpFrameHeader::setProtocolVersion(quint8 version)
{
m_bytes[1] = version;
}
/*!
Returns the total size of the KNXnet/IP frame if the header is valid,
otherwise returns \c null. The total size includes the size of the header
and the size of the KNXnet/IP frame data.
\sa isNull(), isValid(), size(), dataSize()
*/
quint16 QKnxNetIpFrameHeader::totalSize() const
{
if (!isValid())
return 0;
return quint16(quint16(m_bytes[4]) << 8 | m_bytes[5]);
}
/*!
Returns the size of the KNXnet/IP frame's data if the header is valid,
otherwise returns \c null.
The data size excludes the size of the KNXnet/IP frame's header.
\sa isNull(), isValid(), size(), totalSize()
*/
quint16 QKnxNetIpFrameHeader::dataSize() const
{
return totalSize() - size();
}
/*!
Sets the KNXnet/IP frame's data size to \a dataSize and updates the
total size accordingly.
*/
void QKnxNetIpFrameHeader::setDataSize(quint16 dataSize)
{
const auto totalSize = dataSize + size();
m_bytes[4] = quint8((totalSize) >> 8);
m_bytes[5] = quint8(totalSize);
}
/*!
Returns the service type identifier of the KNXnet/IP frame.
*/
QKnxNetIp::ServiceType QKnxNetIpFrameHeader::serviceType() const
{
return QKnxNetIp::ServiceType(quint16(quint16(m_bytes[2]) << 8 | m_bytes[3]));
}
/*!
Sets the service type identifier of the KNXnet/IP frame to \a type.
*/
void QKnxNetIpFrameHeader::setServiceType(QKnxNetIp::ServiceType type)
{
m_bytes[2] = quint8(quint16(type) >> 8);
m_bytes[3] = quint8(quint16(type));
}
/*!
Returns the byte at position \a index in the header.
*/
quint8 QKnxNetIpFrameHeader::byte(quint8 index) const
{
Q_ASSERT_X(index < size(), "QKnxNetIpFrameHeader::byte", "index out of range");
return m_bytes[index];
}
/*!
Returns an array of bytes that represent the KNXnet/IP frame header.
*/
QKnxByteArray QKnxNetIpFrameHeader::bytes() const
{
if (!isValid())
return {};
return { m_bytes[0], m_bytes[1], m_bytes[2], m_bytes[3], m_bytes[4], m_bytes[5] };
}
/*!
Constructs the KNXnet/IP frame header from the byte array \a bytes starting
at position \a index inside the array.
\sa isNull(), isValid()
*/
QKnxNetIpFrameHeader QKnxNetIpFrameHeader::fromBytes(const QKnxByteArray &bytes, quint16 index)
{
const qint32 availableSize = bytes.size() - index;
if (availableSize < 1)
return {}; // Missing header size.
const quint8 headerSize = QKnxUtils::QUint8::fromBytes(bytes, index);
if (availableSize < headerSize || headerSize < 2)
return {}; // Not enough bytes for the header or to read the version info.
if (bytes.at(index + 1) == KnxNetIpVersion10) {
if (headerSize != HeaderSize10)
return {};
} else { // TODO: Adapt once we support other versions.
return {};
}
const quint16 code = QKnxUtils::QUint16::fromBytes(bytes, index + 2);
if (!QKnxNetIp::isServiceType(QKnxNetIp::ServiceType(code)))
return {};
return { QKnxNetIp::ServiceType(code), quint16(QKnxUtils::QUint16::fromBytes(bytes, index + 4)
- headerSize) };
}
/*!
Returns \c true if this object and the given \a other are equal; otherwise
returns \c false.
*/
bool QKnxNetIpFrameHeader::operator==(const QKnxNetIpFrameHeader &other) const
{
return m_bytes == other.m_bytes;
}
/*!
Returns \c true if this object and the given \a other are not equal;
otherwise returns \c false.
*/
bool QKnxNetIpFrameHeader::operator!=(const QKnxNetIpFrameHeader &other) const
{
return !operator==(other);
}
/*!
\relates QKnxNetIpFrameHeader
Writes the KNXnet/IP frame header \a header to the \a debug stream.
*/
QDebug operator<<(QDebug debug, const QKnxNetIpFrameHeader &header)
{
QDebugStateSaver _(debug);
return debug.nospace().noquote() << "0x" << header.bytes().toHex();
}
QT_END_NAMESPACE
|
