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
|
/******************************************************************************
**
** Copyright (C) 2017 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 "qknxnetiproutinglostmessage.h"
#include "qknxutils.h"
QT_BEGIN_NAMESPACE
/*!
\class QKnxNetIpRoutingLostMessageProxy
\inmodule QtKnx
\ingroup qtknx-netip
\ingroup qtknx-routing
\brief The QKnxNetIpRoutingLostMessageProxy class provides the means to read
a routing-lost message from the generic \l QKnxNetIpFrame class and to
create a KNXnet/IP frame based on the information.
Depending on the configuration, a KNXnet/IP router or device can receive
more datagrams than it can forward to the KNX subnetwork. This can lead
to an overflow of the datagram queue and subsequent loss of one or more
KNXnet/IP telegrams, because they could not be transferred from the
network buffer to the queue to the underlying KNX subnetwork.
A routing-lost message is multicast by a KNXnet/IP router to notify that
KNXnet/IP routing indication frames were lost. The message contains the
state of the router or device (\l QKnx::NetIp::DeviceState) and the number
of lost frames.
\note When using QKnxNetIpRoutingLostMessageProxy, 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 routing-lost message
information sent by a KNXnet/IP router:
\code
auto netIpFrame = QKnxNetIpFrame::fromBytes(...);
QKnxNetIpRoutingLostMessageProxy proxy(netIpFrame);
if (!proxy.isValid())
return;
if (proxy.deviceState() == QKnx::NetIp::DeviceState::KnxFault) {
....
}
\endcode
\sa builder(), QKnxNetIpRoutingIndicationProxy, QKnxNetIpRoutingBusyProxy,
{Qt KNXnet/IP Connection Classes}
*/
/*!
\fn QKnxNetIpRoutingLostMessageProxy::QKnxNetIpRoutingLostMessageProxy()
\internal
*/
/*!
\fn QKnxNetIpRoutingLostMessageProxy::~QKnxNetIpRoutingLostMessageProxy()
\internal
*/
/*!
\fn QKnxNetIpRoutingLostMessageProxy::QKnxNetIpRoutingLostMessageProxy(const QKnxNetIpFrame &&)
\internal
*/
/*!
Constructs a proxy object to read the routing-lost message information
carried by the specified KNXnet/IP frame \a frame.
*/
QKnxNetIpRoutingLostMessageProxy::QKnxNetIpRoutingLostMessageProxy(const QKnxNetIpFrame &frame)
: m_frame(frame)
{}
/*!
Returns the state of a KNXnet/IP router or device.
*/
QKnxNetIp::DeviceState QKnxNetIpRoutingLostMessageProxy::deviceState() const
{
return QKnxNetIp::DeviceState(m_frame.constData().value(1));
}
/*!
Returns the number of frames that were lost.
*/
quint16 QKnxNetIpRoutingLostMessageProxy::lostMessageCount() const
{
return QKnxUtils::QUint16::fromBytes(m_frame.constData(), 2);
}
/*!
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 QKnxNetIpRoutingLostMessageProxy::isValid() const
{
return m_frame.isValid() && m_frame.size() == 10
&& m_frame.serviceType() == QKnxNetIp::ServiceType::RoutingLostMessage;
}
/*!
Returns a builder object to create a KNXnet/IP routing-lost message frame.
*/
QKnxNetIpRoutingLostMessageProxy::Builder QKnxNetIpRoutingLostMessageProxy::builder()
{
return QKnxNetIpRoutingLostMessageProxy::Builder();
}
/*!
\class QKnxNetIpRoutingLostMessageProxy::Builder
\inmodule QtKnx
\inheaderfile QKnxNetIpRoutingLostMessageProxy
\brief The QKnxNetIpRoutingLostMessageProxy::Builder class provides the
means to create a routing-lost message frame.
A routing-lost message is sent by a KNXnet/IP router to notify that
KNXnet/IP routing indication frames were lost. The message contains
the state of the router or device (\l QKnx::NetIp::DeviceState) and
the number of lost frames.
The following code sample illustrates how to create a routing-lost message
about three frames being lost because an error occurred in the IP network:
\code
auto frame = QKnxNetIpRoutingLostMessageProxy::builder()
.setDeviceState(QKnx::NetIp::DeviceState::IpFault)
.setLostMessageCount(3)
.create();
\endcode
*/
/*!
Sets the state of a KNXnet/IP router or device to \a state and returns a
reference to the builder.
*/
QKnxNetIpRoutingLostMessageProxy::Builder &
QKnxNetIpRoutingLostMessageProxy::Builder::setDeviceState(QKnxNetIp::DeviceState state)
{
m_state = state;
return *this;
}
/*!
Sets the the number of frames that were lost to \a messageCount and returns
a reference to the builder.
*/
QKnxNetIpRoutingLostMessageProxy::Builder &
QKnxNetIpRoutingLostMessageProxy::Builder::setLostMessageCount(quint16 messageCount)
{
m_lostMessageCount = messageCount;
return *this;
}
/*!
Creates and returns a KNXnet/IP routing-lost message frame.
\note The returned frame may be invalid depending on the values used during
setup.
\sa isValid()
*/
QKnxNetIpFrame QKnxNetIpRoutingLostMessageProxy::Builder::create() const
{
return { QKnxNetIp::ServiceType::RoutingLostMessage, QKnxByteArray { 0x04, quint8(m_state) }
+ QKnxUtils::QUint16::bytes(m_lostMessageCount) };
}
QT_END_NAMESPACE
|
