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
|
/******************************************************************************
**
** 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 "qknxnetipconnectresponse.h"
QT_BEGIN_NAMESPACE
/*!
\class QKnxNetIpConnectResponseProxy
\inmodule QtKnx
\ingroup qtknx-netip
\brief The QKnxNetIpConnectResponseProxy class provides the means to read
a connection response from the generic \l QKnxNetIpFrame class and to
create a KNXnet/IP frame based on the information.
A connection response frame is sent by a KNXnet/IP server in response to a
connection request received from a KNXnet/IP client. The connection response
provides the status of the request. If the server accepted the request, the
frame also contains the identifier and host address protocol information
(HPAI) of the data endpoint that the server prepared for the communication
channel.
In most programs, this class will not be used directly. Instead, the
\l QKnxNetIpTunnel or \l QKnxNetIpDeviceManagement
class is used to establish a functional connection to a KNXnet/IP server.
\note When using QKnxNetIpConnectResponseProxy, care must be taken to
ensure that the referenced KNXnet/IP frame outlives the proxy on all code
paths, lest the proxy ends up referencing deleted data.
The following code sample illustrates how to read the connection response
information sent by a KNXnet/IP server:
\code
auto netIpFrame = QKnxNetIpFrame::fromBytes(...);
const QKnxNetIpConnectResponseProxy proxy(netIpFrame);
if (!proxy.isValid())
return;
auto chanId = proxy.channelId();
auto data = proxy.responseData();
auto endPoint = proxy.dataEndpoint();
auto netIpError = proxy.status();
\endcode
\sa builder(), {Qt KNXnet/IP Connection Classes}
*/
/*!
\fn QKnxNetIpConnectResponseProxy::QKnxNetIpConnectResponseProxy()
\internal
*/
/*!
\fn QKnxNetIpConnectResponseProxy::~QKnxNetIpConnectResponseProxy()
\internal
*/
/*!
\fn QKnxNetIpConnectResponseProxy::QKnxNetIpConnectResponseProxy(const QKnxNetIpFrame &&)
\internal
*/
/*!
Constructs a proxy object to read the connection response information
carried by the specified KNXnet/IP frame \a frame.
*/
QKnxNetIpConnectResponseProxy::QKnxNetIpConnectResponseProxy(const QKnxNetIpFrame &frame)
: m_frame(frame)
{}
/*!
Returns \c true if the frame contains initialized values and is in itself
valid, otherwise returns \c false. A valid KNXnet/IP frame consists of
at least a valid header and a size in bytes corresponding to the total size
of the KNXnet/IP frame header.
\sa QKnxNetIpFrameHeader::totalSize()
*/
bool QKnxNetIpConnectResponseProxy::isValid() const
{
return m_frame.isValid() && m_frame.serviceType() == QKnxNetIp::ServiceType::ConnectResponse
&& (status() == QKnxNetIp::Error::None ? m_frame.size() >= 18 : true);
}
/*!
Returns the ID of the communication channel prepared by the KNXnet/IP
server.
*/
quint8 QKnxNetIpConnectResponseProxy::channelId() const
{
return m_frame.constData().value(0);
}
/*!
Returns the status of the connection request received from a KNXnet/IP
client.
\sa QKnxNetIpConnectRequestProxy
*/
QKnxNetIp::Error QKnxNetIpConnectResponseProxy::status() const
{
return QKnxNetIp::Error(m_frame.constData().value(1));
}
/*!
Returns the data endpoint of the KNXnet/IP server.
*/
QKnxNetIpHpai QKnxNetIpConnectResponseProxy::dataEndpoint() const
{
if (status() != QKnxNetIp::Error::None)
return {};
return QKnxNetIpHpai::fromBytes(m_frame.constData(), 2);
}
/*!
Returns a connection response data (CRD) structure from the KNXnet/IP
connection request frame.
*/
QKnxNetIpCrd QKnxNetIpConnectResponseProxy::responseData() const
{
if (status() != QKnxNetIp::Error::None)
return {};
return QKnxNetIpCrd::fromBytes(m_frame.constData(), 10);
}
/*!
Returns a builder object to create a KNXnet/IP connection response frame.
*/
QKnxNetIpConnectResponseProxy::Builder QKnxNetIpConnectResponseProxy::builder()
{
return QKnxNetIpConnectResponseProxy::Builder();
}
/*!
\class QKnxNetIpConnectResponseProxy::Builder
\inmodule QtKnx
\inheaderfile QKnxNetIpConnectResponseProxy
\brief The QKnxNetIpConnectResponseProxy::Builder class provides the means
to create a KNXnet/IP connection response frame.
A KNXnet/IP connection response contains the status of the corresponding
connection request. If the server accepted the request, the frame also
contains an identifier and the host address protocol information (HPAI) of
the data endpoint that the server prepared for the communication channel.
In most programs, this class will not be used directly. Instead, the
\l QKnxNetIpTunnel or \l QKnxNetIpDeviceManagement
class is used to establish a functional connection to a KNXnet/IP server.
The common way to create a connection response is:
\code
QKnxNetIpHpai hpai;
QKnxNetIpCrdProxy data;
auto netIpFrame = QKnxNetIpConnectResponseProxy::builder()
.setChannelId(200)
.setStatus(QKnx::NetIp::Error::None)
.setDataEndpoint(hpai)
.setResponseData(data)
.create();
\endcode
*/
/*!
Sets the ID of the communication channel prepared by the KNXnet/IP
server to \a channelId and returns a reference to the builder.
*/
QKnxNetIpConnectResponseProxy::Builder &
QKnxNetIpConnectResponseProxy::Builder::setChannelId(quint8 channelId)
{
m_channelId = channelId;
return *this;
}
/*!
Sets the status of the connection request received from a KNXnet/IP
client to \a status and returns a reference to the builder.
*/
QKnxNetIpConnectResponseProxy::Builder &
QKnxNetIpConnectResponseProxy::Builder::setStatus(QKnxNetIp::Error status)
{
m_status = status;
return *this;
}
/*!
Sets the data endpoint of the KNXnet/IP server to \a hpai and returns a
reference to the builder.
*/
QKnxNetIpConnectResponseProxy::Builder &
QKnxNetIpConnectResponseProxy::Builder::setDataEndpoint(const QKnxNetIpHpai &hpai)
{
m_hpai = hpai;
return *this;
}
/*!
Sets the connection response data (CRD) to \a crd and returns a reference to
the builder.
*/
QKnxNetIpConnectResponseProxy::Builder &
QKnxNetIpConnectResponseProxy::Builder::setResponseData(const QKnxNetIpCrd &crd)
{
m_crd = crd;
return *this;
}
/*!
Creates and returns a KNXnet/IP connection response frame.
\note The returned frame may be invalid depending on the values used during
setup.
\sa isValid()
*/
QKnxNetIpFrame QKnxNetIpConnectResponseProxy::Builder::create() const
{
QKnxByteArray data { m_channelId, quint8(m_status) };
if (m_status == QKnxNetIp::Error::None)
data += m_hpai.bytes() + m_crd.bytes();
return { QKnxNetIp::ServiceType::ConnectResponse, data };
}
QT_END_NAMESPACE
|
