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
|
/******************************************************************************
**
** 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 "qknxnetipextendeddevicedib.h"
#include "qknxutils.h"
QT_BEGIN_NAMESPACE
/*!
\class QKnxNetIpExtendedDeviceDibProxy
\since 5.12
\inmodule QtKnx
\ingroup qtknx-netip
\brief The QKnxNetIpExtendedDeviceDibProxy class provides the means to
read the extended device information of a KNXnet/IP device from the generic
\l QKnxNetIpDib class and to create a KNXnet/IP extended device information
block (DIB) structure.
A KNXnet/IP extended device information DIB structure contains specific
information about a KNXnet/IP device, such as the KNX medium status,
\l {QKnxInterfaceObjectProperty::MaxLocalApduLength} {maximum local APDU}
length and the \l {QKnxInterfaceObjectProperty::DeviceDescriptor} {device
descriptor type} (mask version).
In most programs, this class will not be used directly. Instead, the
\l QKnxNetIpServerDiscoveryAgent and \l QKnxNetIpServerInfo are provided.
\note When using QKnxNetIpExtendedDeviceDibProxy, care must be taken to
ensure that the referenced KNXnet/IP DIB structure outlives the proxy on
all code paths, lest the proxy ends up referencing deleted data.
Reading the extended device information can be achieved like this:
\code
auto dib = QKnxNetIpDib::fromBytes(...);
QKnxNetIpExtendedDeviceDibProxy proxy(dib);
if (!proxy.isValid())
return;
auto mediumStatus = proxy.mediumStatus();
auto adpuLength = proxy.maximumLocalApduLength();
auto descriptorType = proxy.deviceDescriptorType0();
\endcode
\sa builder(), {Qt KNXnet/IP Connection Classes}
*/
/*!
\internal
\fn QKnxNetIpExtendedDeviceDibProxy::QKnxNetIpExtendedDeviceDibProxy()
*/
/*!
\internal
\fn QKnxNetIpExtendedDeviceDibProxy::~QKnxNetIpExtendedDeviceDibProxy()
*/
/*!
\internal
\fn QKnxNetIpExtendedDeviceDibProxy::QKnxNetIpExtendedDeviceDibProxy(const QKnxNetIpDib &&)
*/
/*!
Constructs a proxy object with the specified KNXnet/IP DIB structure
\a dib to read the extended device information of a KNXnet/IP device.
*/
QKnxNetIpExtendedDeviceDibProxy::QKnxNetIpExtendedDeviceDibProxy(const QKnxNetIpDib &dib)
: m_dib(dib)
{}
/*!
Returns \c true if the KNXnet/IP structure to create the object is a valid
KNXnet/IP DIB structure; otherwise returns \c false.
*/
bool QKnxNetIpExtendedDeviceDibProxy::isValid() const
{
return m_dib.isValid() && m_dib.size() == 8
&& m_dib.code() == QKnxNetIp::DescriptionType::ExtendedDeviceInfo;
}
/*!
Returns the description type of this KNXnet/IP structure if the
object that was passed during construction was valid; otherwise
returns \l QKnx::NetIp::Unknown.
*/
QKnxNetIp::DescriptionType QKnxNetIpExtendedDeviceDibProxy::descriptionType() const
{
if (isValid())
return m_dib.code();
return QKnxNetIp::DescriptionType::Unknown;
}
/*!
Returns the medium status contained inside the KNXnet/IP DIB structure
if the object that was passed during construction was valid; otherwise
returns \l QKnx::Unknown.
*/
QKnx::MediumStatus QKnxNetIpExtendedDeviceDibProxy::mediumStatus() const
{
if (isValid())
return QKnx::MediumStatus(m_dib.constData().value(0));
return QKnx::MediumStatus::Unknown;
}
/*!
Returns the \l {QKnxInterfaceObjectProperty::MaxLocalApduLength}
{maximum local APDU} length carried by this KNXnet/IP DIB structure if
the object that was passed during construction was valid; otherwise
returns a \l {default-constructed value} which can be \c 0.
*/
quint16 QKnxNetIpExtendedDeviceDibProxy::maximumLocalApduLength() const
{
if (isValid())
return QKnxUtils::QUint16::fromBytes(m_dib.constData(), 2);
return 0u;
}
/*!
Returns the \l {QKnxInterfaceObjectProperty::DeviceDescriptor} {device
descriptor type} (mask version) carried by this KNXnet/IP DIB structure
if the object that was passed during construction was valid; otherwise
returns a \l {default-constructed value} which can be \c 0.
*/
quint16 QKnxNetIpExtendedDeviceDibProxy::deviceDescriptorType0() const
{
if (isValid())
return QKnxUtils::QUint16::fromBytes(m_dib.constData(), 4);
return 0u;
}
/*!
Returns a builder object to create a KNXnet/IP device information DIB
structure.
*/
QKnxNetIpExtendedDeviceDibProxy::Builder QKnxNetIpExtendedDeviceDibProxy::builder()
{
return QKnxNetIpExtendedDeviceDibProxy::Builder();
}
/*!
\class QKnxNetIpExtendedDeviceDibProxy::Builder
\inmodule QtKnx
\inheaderfile QKnxNetIpExtendedDeviceDibProxy
\brief The QKnxNetIpExtendedDeviceDibProxy::Builder class creates a
KNXnet/IP extended device information DIB structure.
A KNXnet/IP extended device information DIB structure contains specific
information about a KNXnet/IP device, such as the KNX medium status,
\l {QKnxInterfaceObjectProperty::MaxLocalApduLength} {maximum local APDU}
length and the \l {QKnxInterfaceObjectProperty::DeviceDescriptor} {device
descriptor type} (mask version).
The common way to create such a DIB structure is:
\code
// fetch the medium status
auto dib = QKnxNetIpExtendedDeviceDibProxy::builder()
.setMediumStatus(mediumStatus)
.setMaximumLocalApduLength(0xffff);
.setDeviceDescriptorType0(0x091a)
.create();
\endcode
*/
class QKnxNetIpExtendedDeviceDibBuilderPrivate : public QSharedData
{
public:
QKnxNetIpExtendedDeviceDibBuilderPrivate() = default;
~QKnxNetIpExtendedDeviceDibBuilderPrivate() = default;
qint16 m_mediumStatus { -1 };
qint32 m_maxApduLength { -1 };
qint32 m_descriptorType = { -1 };
};
/*!
Creates a new empty extended device information DIB structure builder object.
*/
QKnxNetIpExtendedDeviceDibProxy::Builder::Builder()
: d_ptr(new QKnxNetIpExtendedDeviceDibBuilderPrivate)
{}
/*!
Destroys the object and frees any allocated resources.
*/
QKnxNetIpExtendedDeviceDibProxy::Builder::~Builder() = default;
/*!
Sets the medium status to \a status and returns a reference to the builder.
*/
QKnxNetIpExtendedDeviceDibProxy::Builder &
QKnxNetIpExtendedDeviceDibProxy::Builder::setMediumStatus(QKnx::MediumStatus status)
{
d_ptr->m_mediumStatus = quint16(status);
return *this;
}
/*!
Sets the maximum local APDU length of the KNXnet/IP DIB structure to
\a length and returns a reference to the builder.
*/
QKnxNetIpExtendedDeviceDibProxy::Builder &
QKnxNetIpExtendedDeviceDibProxy::Builder::setMaximumLocalApduLength(quint16 length)
{
d_ptr->m_maxApduLength = length;
return *this;
}
/*!
Sets the descriptor type of the KNXnet/IP DIB structure to \a type and
returns a reference to the builder.
*/
QKnxNetIpExtendedDeviceDibProxy::Builder &
QKnxNetIpExtendedDeviceDibProxy::Builder::setDeviceDescriptorType0(quint16 type)
{
d_ptr->m_descriptorType = type;
return *this;
}
/*!
Creates and returns a generic KNXnet/IP extended device information DIB
structure containing the specific device information of a KNXnet/IP device.
\note The returned structure may be invalid depending on the values used
during setup.
\sa isValid()
*/
QKnxNetIpDib QKnxNetIpExtendedDeviceDibProxy::Builder::create() const
{
if (d_ptr->m_mediumStatus < 0 || d_ptr->m_maxApduLength < 0 || d_ptr->m_descriptorType < 0)
return { QKnxNetIp::DescriptionType::ExtendedDeviceInfo };
return { QKnxNetIp::DescriptionType::ExtendedDeviceInfo,
QKnxByteArray { quint8(d_ptr->m_mediumStatus), 0x00 /* reserved field */ }
+ QKnxUtils::QUint16::bytes(quint16(d_ptr->m_maxApduLength))
+ QKnxUtils::QUint16::bytes(quint16(d_ptr->m_descriptorType))
};
}
/*!
Constructs a copy of \a other.
*/
QKnxNetIpExtendedDeviceDibProxy::Builder::Builder(const Builder &other)
: d_ptr(other.d_ptr)
{}
/*!
Assigns the specified \a other to this object.
*/
QKnxNetIpExtendedDeviceDibProxy::Builder &
QKnxNetIpExtendedDeviceDibProxy::Builder::operator=(const Builder &other)
{
d_ptr = other.d_ptr;
return *this;
}
QT_END_NAMESPACE
|
