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
|
/******************************************************************************
**
** 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 "qknxnetipcrd.h"
QT_BEGIN_NAMESPACE
/*!
\class QKnxNetIpCrdProxy
\inmodule QtKnx
\ingroup qtknx-netip
\brief The QKnxNetIpCrdProxy class provides the means to read the KNXnet/IP
connection response data (CRD) from the generic \l QKnxNetIpCrd class and to
create a KNXnet/IP CRD structure based on the information.
A KNXnet/IP CRD structure contains the data block returned with the connect
response \l QKnxNetIpFrame. The content of such a frame can be viewed
by using the \l QKnxNetIpConnectResponseProxy proxy class.
The structure may contain host protocol dependent and independent data,
but the current KNX specification foresees additional data only in the
case of tunneling.
\note When using QKnxNetIpCrdProxy, care must be taken to ensure that the
referenced KNXnet/IP CRD structure outlives the proxy on all
code paths, lest the proxy ends up referencing deleted data.
Reading the connection type and assigned individual address can be achieved
like this:
\code
auto crd = QKnxNetIpCrd::fromBytes(...);
QKnxNetIpCrdProxy proxy(crd);
if (!proxy.isValid())
return;
if (proxy.connectionType() != QKnxNetIp::ConnectionType::Tunnel)
return;
auto address = proxy.individualAddress(); // read the individual address
\endcode
\sa builder(), {Qt KNXnet/IP Connection Classes}
*/
/*!
\fn QKnxNetIpCrdProxy::QKnxNetIpCrdProxy()
\internal
*/
/*!
\fn QKnxNetIpCrdProxy::~QKnxNetIpCrdProxy()
\internal
*/
/*!
\fn QKnxNetIpCrdProxy::QKnxNetIpCrdProxy(const QKnxNetIpCrd &&)
\internal
*/
/*!
Constructs a proxy object with the specified a KNXnet/IP structure \a crd
to read the connection response data block (CRD).
*/
QKnxNetIpCrdProxy::QKnxNetIpCrdProxy(const QKnxNetIpCrd &crd)
: m_crd(crd)
{}
/*!
Returns \c true if the KNXnet/IP structure to create the object is a valid
KNXnet/IP CRD structure; otherwise returns \c false.
*/
bool QKnxNetIpCrdProxy::isValid() const
{
switch (m_crd.code()) {
case QKnxNetIp::ConnectionType::Tunnel: {
const QKnxAddress address { QKnxAddress::Type::Individual, m_crd.constData() };
return m_crd.isValid() && m_crd.size() == 4 && address.isValid();
} break;
case QKnxNetIp::ConnectionType::DeviceManagement:
case QKnxNetIp::ConnectionType::RemoteLogging:
case QKnxNetIp::ConnectionType::RemoteConfiguration:
case QKnxNetIp::ConnectionType::ObjectServer:
return m_crd.isValid() && m_crd.size() == 2;
case QKnxNetIp::ConnectionType::Unknown:
break;
}
return false;
}
/*!
Returns the connection type of this KNXnet/IP structure if the object that
was passed during construction was valid; otherwise returns
\l QKnx::NetIp::Unknown.
*/
QKnxNetIp::ConnectionType QKnxNetIpCrdProxy::connectionType() const
{
if (isValid())
return m_crd.code();
return QKnxNetIp::ConnectionType::Unknown;
}
/*!
Returns the individual address of this KNXnet/IP structure if the object
that was passed during construction was valid and the connection type
is \l QKnx::NetIp::Tunnel; otherwise returns \l QKnx::NetIp::Unknown.
\sa additionalData()
*/
QKnxAddress QKnxNetIpCrdProxy::individualAddress() const
{
if (isValid())
return { QKnxAddress::Type::Individual, m_crd.constData() };
return {};
}
/*!
Returns the additional data of this KNXnet/IP structure.
The current KNX specification foresees additional data only in the case of
tunneling.
\sa individualAddress()
*/
QKnxByteArray QKnxNetIpCrdProxy::additionalData() const
{
return m_crd.data();
}
/*!
Returns a builder object to create a KNXnet/IP connection response
data block structure.
*/
QKnxNetIpCrdProxy::Builder QKnxNetIpCrdProxy::builder()
{
return QKnxNetIpCrdProxy::Builder();
}
/*!
\class QKnxNetIpCrdProxy::Builder
\inmodule QtKnx
\inheaderfile QKnxNetIpCrdProxy
\brief The QKnxNetIpCrdProxy::Builder class creates a KNXnet/IP connection
response data (CDR) structure.
A KNXnet/IP CRD structure contains the data block returned with the
connect response \l QKnxNetIpFrame.
The common way to create such a CRD structure is:
\code
auto crd = QKnxNetIpCrdProxy::builder()
.setConnectionType(QKnxNetIp::ConnectionType::Tunnel)
.setIndividualAddress(QKnxAddress::createIndividual(1, 1, 1))
.create();
\endcode
*/
/*!
Sets the connection type to \a type and returns a reference to the builder.
Does nothing if \a type is not \l QKnx::NetIp::ConnectionType.
*/
QKnxNetIpCrdProxy::Builder &
QKnxNetIpCrdProxy::Builder::setConnectionType(QKnxNetIp::ConnectionType type)
{
if (QKnxNetIp::isStructType(type))
m_cType = type;
return *this;
}
/*!
Sets the additional data to the individual address \a address and
returns a reference to the builder.
Does nothing if \a address is invalid or not an individual address.
\sa setAdditionalData()
*/
QKnxNetIpCrdProxy::Builder &
QKnxNetIpCrdProxy::Builder::setIndividualAddress(const QKnxAddress &address)
{
if (address.isValid() && (address.type() == QKnxAddress::Type::Individual))
setAdditionalData(address.bytes());
return *this;
}
/*!
Sets the additional data to \a additionalData and returns a reference to
the builder.
The current KNX specification foresees additional data only in the case of
tunneling.
\sa setIndividualAddress()
*/
QKnxNetIpCrdProxy::Builder &
QKnxNetIpCrdProxy::Builder::setAdditionalData(const QKnxByteArray &additionalData)
{
m_additionalData = additionalData;
return *this;
}
/*!
Creates and returns a KNXnet/IP CRD structure.
\note The returned structure may be invalid depending on the values used
during setup.
\sa isValid()
*/
QKnxNetIpCrd QKnxNetIpCrdProxy::Builder::create() const
{
return { m_cType, m_additionalData };
}
QT_END_NAMESPACE
|
