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
|
/******************************************************************************
**
** 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 "qknxnetiptunnelingrequest.h"
#include "qknxlinklayerframebuilder.h"
QT_BEGIN_NAMESPACE
/*!
\class QKnxNetIpTunnelingRequestProxy
\inmodule QtKnx
\ingroup qtknx-tunneling
\ingroup qtknx-netip
\brief The QKnxNetIpTunnelingRequestProxy class provides the means to read
a tunneling request from the generic \l QKnxNetIpFrame class and to create
a KNXnet/IP frame based on the information.
\e Tunneling means that Engineering Tool Software (ETS) sends a single KNX
frame in an KNXnet/IP frame and waits until the response arrives or a
time-out is reached.
A tunneling request is sent by a KNXnet/IP client to establish a data
connection to the endpoint of a KNXnet/IP server for sending a KNX frame.
A tunneling request frame contains the ID of the communication channel
between a KNXnet/IP client and server, the sequence number of the frame,
and the KNX frame in the common external message interface (cEMI) format.
The KNXnet/IP server discards frames with sequence numbers that are not
the expected sequence numbers or one less the expected sequence numbers
and does not send a tunneling acknowledgment upon receiving them.
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.
Before sending a tunneling request, the KNXnet/IP client should use
\l QKnxNetIpServerDescriptionAgent and \l QKnxNetIpServerInfo to check
that the server supports the requested connection type and options.
\note When using QKnxNetIpTunnelingRequestProxy, 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 tunneling request
information sent by a KNXnet/IP client:
\code
auto netIpFrame = QKnxNetIpFrame::fromBytes(...);
const QKnxNetIpTunnelingRequestProxy proxy(netIpFrame);
if (!proxy.isValid())
return;
auto chanId = proxy.channelId();
auto seqNum = proxy.sequenceNumber();
auto knxLinkFrame = proxy.cemi();
\endcode
\sa builder(), QKnxNetIpTunnelingAcknowledgeProxy,
{Qt KNX Tunneling Classes}, {Qt KNXnet/IP Connection Classes}
*/
/*!
\fn QKnxNetIpTunnelingRequestProxy::QKnxNetIpTunnelingRequestProxy()
\internal
*/
/*!
\fn QKnxNetIpTunnelingRequestProxy::~QKnxNetIpTunnelingRequestProxy()
\internal
*/
/*!
\fn QKnxNetIpTunnelingRequestProxy::QKnxNetIpTunnelingRequestProxy(const QKnxNetIpFrame &&)
\internal
*/
/*!
Constructs a proxy object to read the tunneling request information
carried by the specified KNXnet/IP frame \a frame.
*/
QKnxNetIpTunnelingRequestProxy::QKnxNetIpTunnelingRequestProxy(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 QKnxNetIpTunnelingRequestProxy::isValid() const
{
return m_frame.isValid() && m_frame.size() >= 12 && cemi().isValid()
&& m_frame.serviceType() == QKnxNetIp::ServiceType::TunnelingRequest;
}
/*!
Returns the ID of the communication channel between a KNXnet/IP client and
server.
*/
quint8 QKnxNetIpTunnelingRequestProxy::channelId() const
{
return m_frame.channelId();
}
/*!
Returns the sequence number of a tunneling request frame.
*/
quint8 QKnxNetIpTunnelingRequestProxy::sequenceNumber() const
{
return m_frame.sequenceNumber();
}
/*!
Returns the KNX frame in the cEMI format.
*/
QKnxLinkLayerFrame QKnxNetIpTunnelingRequestProxy::cemi() const
{
return QKnxLinkLayerFrame::builder()
.setMedium(QKnx::MediumType::NetIP)
.setData(m_frame.constData())
.createFrame();
}
/*!
Returns a builder object to create a KNXnet/IP tunneling request frame.
*/
QKnxNetIpTunnelingRequestProxy::Builder QKnxNetIpTunnelingRequestProxy::builder()
{
return QKnxNetIpTunnelingRequestProxy::Builder();
}
/*!
\class QKnxNetIpTunnelingRequestProxy::Builder
\inmodule QtKnx
\inheaderfile QKnxNetIpTunnelingRequestProxy
\brief The QKnxNetIpTunnelingRequestProxy::Builder class provides the means
to create a KNXnet/IP tunneling request frame.
A KNXnet/IP tunneling request contains the ID of the communication channel
between a KNXnet/IP client and server, the sequence number of the frame,
and the KNX frame in the common external message interface (cEMI) format.
The KNXnet/IP server discards frames with sequence numbers that are not
the expected sequence numbers or one less the expected sequence numbers
and does not send a tunneling acknowledgment upon receiving them.
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 tunneling request is:
\code
QKnxLinkLayerFrame linkFrame;
auto tunnelRequest = QKnxNetIpTunnelingRequestProxy::builder()
.setCemi(linkFrame)
.setChannelId(10)
.setSequenceNumber(0)
.create();
\endcode
If the KNXnet/IP client does not receive a tunneling acknowledgment within
the timeout of one second or the status of a received acknowledgment frame
indicates that errors occurred, the client repeats the tunneling request
frame once with the same sequence number and then terminates the connection
by sending a disconnection request, \l QKnxNetIpDisconnectRequestProxy, to
the server's control endpoint.
*/
/*!
Sets the ID of the communication channel between a KNXnet/IP client and
server to \a channelId and returns a reference to the builder.
*/
QKnxNetIpTunnelingRequestProxy::Builder &
QKnxNetIpTunnelingRequestProxy::Builder::setChannelId(quint8 channelId)
{
m_channelId = channelId;
return *this;
}
/*!
Sets the sequence number of a tunneling request frame to \a sequenceNumber
and returns a reference to the builder.
*/
QKnxNetIpTunnelingRequestProxy::Builder &
QKnxNetIpTunnelingRequestProxy::Builder::setSequenceNumber(quint8 sequenceNumber)
{
m_sequenceNumber = sequenceNumber;
return *this;
}
/*!
Sets the KNX frame within the tunneling request frame to \a cemi and returns
a reference to the builder.
*/
QKnxNetIpTunnelingRequestProxy::Builder &
QKnxNetIpTunnelingRequestProxy::Builder::setCemi(const QKnxLinkLayerFrame &cemi)
{
m_cemi = cemi;
return *this;
}
/*!
Creates and returns a KNXnet/IP tunneling request frame.
\note The returned frame may be invalid depending on the values used during
setup.
\sa isValid()
*/
QKnxNetIpFrame QKnxNetIpTunnelingRequestProxy::Builder::create() const
{
return { QKnxNetIp::ServiceType::TunnelingRequest, { m_channelId, m_sequenceNumber },
m_cemi.bytes() };
}
QT_END_NAMESPACE
|
