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
|
/******************************************************************************
**
** 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 "qknxnetiptunnelingfeatureget.h"
#include "qknxbuilderdata_p.h"
QT_BEGIN_NAMESPACE
/*!
\class QKnxNetIpTunnelingFeatureGetProxy
\since 5.12
\inmodule QtKnx
\ingroup qtknx-netip
\ingroup qtknx-tunneling
\brief The QKnxNetIpTunnelingFeatureGetProxy class provides the means to
access the information carried by a generic tunneling feature-get service
\l QKnxNetIpFrame frame and to create a KNXnet/IP frame based on the
information.
A tunneling feature-get service frame contains the ID of the communication
channel between a KNXnet/IP client and server, the sequence number of the
frame, and the \l {QKnx::InterfaceFeature} {interface feature} to read.
The tunneling client initiates the tunneling feature-get service to read
the value of an interface feature from the tunneling server. Within 3
seconds after confirming the tunneling feature-get service the tunneling
server sends a tunneling feature-response frame containing the value of the
requested interface feature.
If the tunneling server does not respond to the tunneling feature-get
service frame the tunneling client may or may not repeat the request.
\note When using QKnxNetIpTunnelingFeatureGetProxy, 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
feature-get information sent by a KNXnet/IP client:
\code
auto netIpFrame = QKnxNetIpFrame::fromBytes(...);
const QKnxNetIpTunnelingFeatureGetProxy proxy(netIpFrame);
if (!proxy.isValid())
return;
auto id = proxy.featureIdentifier();
\endcode
\sa builder(), QKnxNetIpTunnelingFeatureInfoProxy,
QKnxNetIpTunnelingFeatureResponseProxy,
{Qt KNX Tunneling Classes}, {Qt KNXnet/IP Connection Classes}
*/
/*!
\fn QKnxNetIpTunnelingFeatureGetProxy::QKnxNetIpTunnelingFeatureGetProxy()
\internal
*/
/*!
\fn QKnxNetIpTunnelingFeatureGetProxy::~QKnxNetIpTunnelingFeatureGetProxy()
\internal
*/
/*!
\fn QKnxNetIpTunnelingFeatureGetProxy::QKnxNetIpTunnelingFeatureGetProxy(const QKnxNetIpFrame &&)
\internal
*/
/*!
Constructs a proxy object to read the tunneling feature-get service
information carried by the specified KNXnet/IP frame \a frame.
*/
QKnxNetIpTunnelingFeatureGetProxy::QKnxNetIpTunnelingFeatureGetProxy(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 QKnxNetIpTunnelingFeatureGetProxy::isValid() const
{
return m_frame.isValid() && m_frame.size() == 12 && QKnx::isInterfaceFeature(featureIdentifier())
&& m_frame.serviceType() == QKnxNetIp::ServiceType::TunnelingFeatureGet;
}
/*!
Returns the ID of the communication channel between a KNXnet/IP client and
server.
*/
quint8 QKnxNetIpTunnelingFeatureGetProxy::channelId() const
{
return m_frame.channelId();
}
/*!
Returns the sequence number of a tunneling feature-get service frame.
*/
quint8 QKnxNetIpTunnelingFeatureGetProxy::sequenceNumber() const
{
return m_frame.sequenceNumber();
}
/*!
Returns the tunneling interface feature identifier of a tunneling
feature-get service frame.
*/
QKnx::InterfaceFeature QKnxNetIpTunnelingFeatureGetProxy::featureIdentifier() const
{
return QKnx::InterfaceFeature(m_frame.constData().value(0));
}
/*!
Returns a builder object to create a KNXnet/IP tunneling feature-get
service frame.
*/
QKnxNetIpTunnelingFeatureGetProxy::Builder QKnxNetIpTunnelingFeatureGetProxy::builder()
{
return QKnxNetIpTunnelingFeatureGetProxy::Builder();
}
/*!
\class QKnxNetIpTunnelingFeatureGetProxy::Builder
\inmodule QtKnx
\inheaderfile QKnxNetIpTunnelingFeatureGetProxy
\brief The QKnxNetIpTunnelingFeatureGetProxy::Builder class provides
the means to create a KNXnet/IP tunneling feature get service frame.
A tunneling feature-get service frame contains the ID of the communication
channel between a KNXnet/IP client and server, the sequence number of the
frame, and the \l {QKnx::InterfaceFeature} {interface feature} to read.
The tunneling client initiates the tunneling feature-get service to read
the value of an interface feature from the tunneling server. Within 3
seconds after confirming the tunneling feature-get service the tunneling
server sends a tunneling feature-response frame containing the value of the
requested interface feature.
If the tunneling server does not respond to the tunneling feature-get
service frame the tunneling client may or may not repeat the request.
The common way to create a tunneling feature-get service frame is:
\code
auto frame = QKnxNetIpTunnelingFeatureGetProxy::builder()
.setChannelId(15)
.setSequenceNumber(10)
.setFeatureIdentifier(QKnx::InterfaceFeature::IndividualAddress)
.create();
\endcode
*/
/*!
Creates a new empty tunneling feature-get service frame builder object.
*/
QKnxNetIpTunnelingFeatureGetProxy::Builder::Builder()
: d_ptr(new QKnxFeatureBuilderPrivate)
{}
/*!
Destroys the object and frees any allocated resources.
*/
QKnxNetIpTunnelingFeatureGetProxy::Builder::~Builder() = default;
/*!
Sets the ID of the communication channel between a KNXnet/IP client and
server to \a channelId and returns a reference to the builder.
*/
QKnxNetIpTunnelingFeatureGetProxy::Builder &
QKnxNetIpTunnelingFeatureGetProxy::Builder::setChannelId(quint8 channelId)
{
d_ptr->m_channelId = channelId;
return *this;
}
/*!
Sets the sequence number of a tunneling feature-get service frame to
\a sequenceNumber and returns a reference to the builder.
*/
QKnxNetIpTunnelingFeatureGetProxy::Builder &
QKnxNetIpTunnelingFeatureGetProxy::Builder::setSequenceNumber(quint8 sequenceNumber)
{
d_ptr->m_sequenceNumber = sequenceNumber;
return *this;
}
/*!
Sets the interface feature identifier of a tunneling feature-get service
frame to \a id and returns a reference to the builder.
Does nothing if \a id is not a \l QKnx::InterfaceFeature.
*/
QKnxNetIpTunnelingFeatureGetProxy::Builder &
QKnxNetIpTunnelingFeatureGetProxy::Builder::setFeatureIdentifier(QKnx::InterfaceFeature id)
{
if (QKnx::isInterfaceFeature(id))
d_ptr->m_if = id;
return *this;
}
/*!
Creates and returns a KNXnet/IP tunneling feature-get service frame.
\note The returned frame may be invalid depending on the values used during
setup.
\sa isValid()
*/
QKnxNetIpFrame QKnxNetIpTunnelingFeatureGetProxy::Builder::create() const
{
return { QKnxNetIp::ServiceType::TunnelingFeatureGet,
{ d_ptr->m_channelId, d_ptr->m_sequenceNumber }, /* connection header */
{ quint8(d_ptr->m_if) , 0x00 } /* interface feature identifier */
};
}
/*!
Constructs a copy of \a other.
*/
QKnxNetIpTunnelingFeatureGetProxy::Builder::Builder(const Builder &other)
: d_ptr(other.d_ptr)
{}
/*!
Assigns the specified \a other to this object.
*/
QKnxNetIpTunnelingFeatureGetProxy::Builder &
QKnxNetIpTunnelingFeatureGetProxy::Builder::operator=(const Builder &other)
{
d_ptr = other.d_ptr;
return *this;
}
QT_END_NAMESPACE
|
