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
|
/******************************************************************************
**
** 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 "qknxnetipconnectionheader.h"
QT_BEGIN_NAMESPACE
/*!
\class QKnxNetIpConnectionHeader
\inmodule QtKnx
\ingroup qtknx-netip
\brief The QKnxNetIpConnectionHeader class is a KNXnet/IP frame connection
header.
The body of every KNXnet/IP frame sent over an established communication
channel starts with a data field that contains additional general
information about the data connection. The amount of this data and what
type of information is included there in particular is determined by
several options during the connection phase of a communication channel.
The total of these data fields is called connection header and its
appearance varies greatly depending on the already mentioned connection
options. Only the order in which the different data fields are stored in
the connection header is fixed.
\sa {Qt KNXnet/IP Connection Classes}
*/
/*!
\fn QKnxNetIpConnectionHeader::QKnxNetIpConnectionHeader()
Constructs an empty invalid frame header object.
\sa isNull(), isValid()
*/
/*!
\fn QKnxNetIpConnectionHeader::~QKnxNetIpConnectionHeader()
Destroys the frame header object and releases all allocated resources.
*/
/*!
Constructs a valid frame header object. Sets the object's communication
channel ID to \a channelId and the sequence number to \a seqNumber. The
header size is updated accordingly.
\sa isValid(), channelId(), sequenceNumber()
*/
QKnxNetIpConnectionHeader::QKnxNetIpConnectionHeader(quint8 channelId, quint8 seqNumber)
: QKnxNetIpConnectionHeader(channelId, seqNumber, 0)
{}
/*!
Constructs a valid frame header object. Sets the object's communication
channel ID to \a channelId, the sequence number to \a seqNumber, and the
service specific value to \a serviceTypeSpecificValue. The header size is
updated accordingly.
\sa isValid(), channelId(), sequenceNumber(), serviceTypeSpecificValue()
*/
QKnxNetIpConnectionHeader::QKnxNetIpConnectionHeader(quint8 channelId, quint8 seqNumber,
quint8 serviceTypeSpecificValue)
{
m_bytes.set(0, 4);
m_bytes.set(1, channelId);
m_bytes.set(2, seqNumber);
m_bytes.set(3, serviceTypeSpecificValue);
}
/*!
Returns \c true if this is a default constructed header, otherwise returns
\c false. A header is considered null if its header size is not initialized.
*/
bool QKnxNetIpConnectionHeader::isNull() const
{
return m_bytes.at(0) == 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
connection header consist of a header size, communication channel ID,
sequence Number and a service specific type. All values can be \c null
except the header size.
\sa isNull()
*/
bool QKnxNetIpConnectionHeader::isValid() const
{
if (isNull())
return false;
return (m_bytes.at(0) >= 4) && (m_bytes.at(0) == m_bytes.size());
}
/*!
Returns the total size of the header including all items. The minimum size
for a valid header is 4 bytes.
*/
quint8 QKnxNetIpConnectionHeader::size() const
{
return m_bytes.at(0);
}
/*!
Returns the communication channel ID of the KNXnet/IP frame.
*/
quint8 QKnxNetIpConnectionHeader::channelId() const
{
return m_bytes.at(1);
}
/*!
Sets the communication channel ID of the KNXnet/IP frame to \a channelId.
*/
void QKnxNetIpConnectionHeader::setChannelId(quint8 channelId)
{
m_bytes.set(1, channelId);
m_bytes.set(0, (m_bytes.at(0) == 0x00 ? 4 : m_bytes.at(0)));
}
/*!
Returns the sequence number of the KNXnet/IP frame.
*/
quint8 QKnxNetIpConnectionHeader::sequenceNumber() const
{
return m_bytes.at(2);
}
/*!
Sets the sequence number of the KNXnet/IP frame to \a seqNumber.
*/
void QKnxNetIpConnectionHeader::setSequenceNumber(quint8 seqNumber)
{
m_bytes.set(2, seqNumber);
m_bytes.set(0, (m_bytes.at(0) == 0x00 ? 4 : m_bytes.at(0)));
}
/*!
Returns the service type specific value of the KNXnet/IP frame.
*/
quint8 QKnxNetIpConnectionHeader::serviceTypeSpecificValue() const
{
return m_bytes.at(3);
}
/*!
Sets the service type specific value of the KNXnet/IP frame to \a value.
*/
void QKnxNetIpConnectionHeader::setServiceTypeSpecificValue(quint8 value)
{
m_bytes.set(3, value);
m_bytes.set(0, (m_bytes.at(0) == 0x00 ? 4 : m_bytes.at(0)));
}
/*!
Returns a byte array with connection type specific header items of the
KNXnet/IP frame.
*/
QKnxByteArray QKnxNetIpConnectionHeader::connectionTypeSpecificHeaderItems() const
{
return m_bytes.mid(4);
}
/*!
Sets the connection type specific header items of the KNXnet/IP frame to
\a items.
*/
void QKnxNetIpConnectionHeader::setConnectionTypeSpecificHeaderItems(const QKnxByteArray &items)
{
m_bytes.set(0, items.size() + 4);
m_bytes.resize(items.size() + 4);
m_bytes.replace(4, items.size(), items);
}
/*!
Returns the byte at position \a index in the header.
*/
quint8 QKnxNetIpConnectionHeader::byte(quint8 index) const
{
Q_ASSERT_X(index < size(), "QKnxNetIpConnectionHeader::byte", "index out of range");
return m_bytes.at(index);
}
/*!
Returns an array of bytes that represent the KNXnet/IP frame connection
header.
*/
QKnxByteArray QKnxNetIpConnectionHeader::bytes() const
{
if (!isValid())
return {};
return m_bytes;
}
/*!
Constructs the KNXnet/IP frame connection header from the byte array \a bytes
starting at the position \a index inside the array.
\sa isNull(), isValid()
*/
QKnxNetIpConnectionHeader QKnxNetIpConnectionHeader::fromBytes(const QKnxByteArray &bytes, quint16 index)
{
const qint32 availableSize = bytes.size() - index;
if (availableSize < 1)
return {}; // total size missing
const auto totalSize = bytes.at(index);
// header needs at least 4 bytes and total size needs to match
if (availableSize < 4 && availableSize < totalSize)
return {}; // header might be corrupted
QKnxNetIpConnectionHeader hdr { bytes.at(index + 1), bytes.at(index + 2), bytes.at(index + 3) };
if (totalSize > 4)
hdr.setConnectionTypeSpecificHeaderItems(bytes.mid(index + 4, totalSize - 4));
return hdr;
}
/*!
Returns \c true if this object and the given \a other are equal; otherwise
returns \c false.
*/
bool QKnxNetIpConnectionHeader::operator==(const QKnxNetIpConnectionHeader &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 QKnxNetIpConnectionHeader::operator!=(const QKnxNetIpConnectionHeader &other) const
{
return !operator==(other);
}
/*!
\relates QKnxNetIpConnectionHeader
Writes the KNXnet/IP connection header \a header to the \a debug stream.
*/
QDebug operator<<(QDebug debug, const QKnxNetIpConnectionHeader &header)
{
QDebugStateSaver _(debug);
return debug.nospace().noquote() << "0x" << header.bytes().toHex();
}
QT_END_NAMESPACE
|
