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
|
/******************************************************************************
**
** 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 "qknxnetipdisconnectresponse.h"
QT_BEGIN_NAMESPACE
/*!
\class QKnxNetIpDisconnectResponseProxy
\inmodule QtKnx
\ingroup qtknx-netip
\brief The QKnxNetIpDisconnectResponseProxy class provides the means to read
a KNXnet/IP disconnection response from the generic \l QKnxNetIpFrame
class and to create a disconnection response frame based on the information.
A KNXnet/IP device terminates a data channel connection by sending a
disconnection request to its communication partner's control endpoint.
The KNXnet/IP device receiving the disconnection request acknowledges the
operation with a KNXnet/IP disconnection response frame, which signals the
final termination of a 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 QKnxNetIpDisconnectResponseProxy, 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 disconnection response
information sent by a KNXnet/IP client:
\code
auto netIpFrame = QKnxNetIpFrame::fromBytes(...);
const QKnxNetIpDisconnectResponseProxy proxy(netIpFrame);
if (!proxy.isValid())
return;
quint8 chanId = proxy.channelId();
QKnx::NetIp::Error state = proxy.status();
\endcode
\sa builder(), QKnxNetIpDisconnectRequestProxy,
{Qt KNXnet/IP Connection Classes}
*/
/*!
\fn QKnxNetIpDisconnectResponseProxy::QKnxNetIpDisconnectResponseProxy()
\internal
*/
/*!
\fn QKnxNetIpDisconnectResponseProxy::~QKnxNetIpDisconnectResponseProxy()
\internal
*/
/*!
\fn QKnxNetIpDisconnectResponseProxy::QKnxNetIpDisconnectResponseProxy(const QKnxNetIpFrame &&)
\internal
*/
/*!
Constructs a proxy object to read the disconnection response information
carried by the specified KNXnet/IP frame \a frame.
*/
QKnxNetIpDisconnectResponseProxy::QKnxNetIpDisconnectResponseProxy(const QKnxNetIpFrame &frame)
: m_frame(frame)
{}
/*!
Returns the ID of the communication channel between a KNXnet/IP client and
server.
*/
quint8 QKnxNetIpDisconnectResponseProxy::channelId() const
{
return m_frame.constData().value(0);
}
/*!
Returns the status of the communication channel between a KNXnet/IP client
and server.
*/
QKnxNetIp::Error QKnxNetIpDisconnectResponseProxy::status() const
{
return QKnxNetIp::Error(m_frame.constData().value(1));
}
/*!
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 QKnxNetIpDisconnectResponseProxy::isValid() const
{
return m_frame.isValid() && m_frame.size() == 8
&& m_frame.serviceType() == QKnxNetIp::ServiceType::DisconnectResponse;
}
/*!
Returns a builder object to create a KNXnet/IP disconnection response frame.
*/
QKnxNetIpDisconnectResponseProxy::Builder QKnxNetIpDisconnectResponseProxy::builder()
{
return QKnxNetIpDisconnectResponseProxy::Builder();
}
/*!
\class QKnxNetIpDisconnectResponseProxy::Builder
\inmodule QtKnx
\inheaderfile QKnxNetIpDisconnectResponseProxy
\brief The QKnxNetIpDisconnectResponseProxy::Builder class provides
the means to read a KNXnet/IP disconnection response from the generic
\l QKnxNetIpFrame class and to create a disconnection response frame
based on the information.
A KNXnet/IP device terminates a data channel connection by sending a
disconnection request to its communication partner's control endpoint.
The KNXnet/IP device receiving the disconnection request acknowledges the
operation with a KNXnet/IP disconnection response frame, which signals the
final termination of a 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 disconnection response is:
\code
auto frame = QKnxNetIpDisconnectResponseProxy::builder()
.setChannelId(200)
.setStatus(QKnx::NetIp::Error::None)
.create();
\endcode
*/
/*!
Sets the ID of the communication channel between the KNXnet/IP client and
server to \a channelId and returns a reference to the builder.
*/
QKnxNetIpDisconnectResponseProxy::Builder &
QKnxNetIpDisconnectResponseProxy::Builder::setChannelId(quint8 channelId)
{
m_channelId = channelId;
return *this;
}
/*!
Sets the status of the communication channel between the KNXnet/IP client
and server to \a status and returns a reference to the builder.
*/
QKnxNetIpDisconnectResponseProxy::Builder &
QKnxNetIpDisconnectResponseProxy::Builder::setStatus(QKnxNetIp::Error status)
{
m_status = status;
return *this;
}
/*!
Creates and returns a KNXnet/IP disconnection response frame.
\note The returned frame may be invalid depending on the values used during
setup.
\sa isValid()
*/
QKnxNetIpFrame QKnxNetIpDisconnectResponseProxy::Builder::create() const
{
return { QKnxNetIp::ServiceType::DisconnectResponse, QKnxByteArray { m_channelId,
quint8(m_status) } };
}
QT_END_NAMESPACE
|
