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
|
/******************************************************************************
**
** 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 "qknxnetiproutingindication.h"
#include "qknxlinklayerframebuilder.h"
QT_BEGIN_NAMESPACE
/*!
\class QKnxNetIpRoutingIndicationProxy
\inmodule QtKnx
\ingroup qtknx-netip
\ingroup qtknx-routing
\brief The QKnxNetIpRoutingIndicationProxy class provides the means to read
a routing indication from the generic \l QKnxNetIpFrame class and to
create a KNXnet/IP frame based on the information.
A routing indication is sent by a KNXnet/IP router or device to transmit KNX
link layer frames over IP networks.
\note When using QKnxNetIpRoutingIndicationProxy, 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 indication
information sent by a KNXnet/IP router or device:
\code
auto netIpFrame = QKnxNetIpFrame::fromBytes(...);
const QKnxNetIpRoutingIndicationProxy proxy(netIpFrame);
if (!proxy.isValid())
return;
auto linkFrame = proxy.cemi();
\endcode
\sa builder(), QKnxNetIpRoutingLostMessageProxy, QKnxNetIpRoutingBusyProxy,
{Qt KNXnet/IP Connection Classes}
*/
/*!
\fn QKnxNetIpRoutingIndicationProxy::QKnxNetIpRoutingIndicationProxy()
\internal
*/
/*!
\fn QKnxNetIpRoutingIndicationProxy::~QKnxNetIpRoutingIndicationProxy()
\internal
*/
/*!
\fn QKnxNetIpRoutingIndicationProxy::QKnxNetIpRoutingIndicationProxy(const QKnxNetIpFrame &&)
\internal
*/
/*!
Constructs a proxy object to read the routing indication information carried
by the specified KNXnet/IP frame \a frame.
*/
QKnxNetIpRoutingIndicationProxy::QKnxNetIpRoutingIndicationProxy(const QKnxNetIpFrame &frame)
: m_frame(frame)
{}
/*!
\since 5.12
Returns the cEMI frame within the routing indication frame.
*/
QKnxLinkLayerFrame QKnxNetIpRoutingIndicationProxy::cemi() const
{
return QKnxLinkLayerFrame::builder()
.setMedium(QKnx::MediumType::NetIP)
.setData(m_frame.constData())
.createFrame();
}
#if QT_DEPRECATED_SINCE(5, 12)
/*!
\deprecated
*/
QKnxLinkLayerFrame QKnxNetIpRoutingIndicationProxy::linkLayerFrame() const
{
return cemi();
}
#endif
/*!
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 QKnxNetIpRoutingIndicationProxy::isValid() const
{
const auto code = QKnxLinkLayerFrame::MessageCode(m_frame.constData().value(0));
// TODO: fix size check once the minimum CEMI frame size is known
return m_frame.isValid() && m_frame.size() >= 8
&& m_frame.serviceType() == QKnxNetIp::ServiceType::RoutingIndication
&& code == QKnxLinkLayerFrame::MessageCode::DataIndication;
}
/*!
Returns a builder object to create a KNXnet/IP routing indication frame.
*/
QKnxNetIpRoutingIndicationProxy::Builder QKnxNetIpRoutingIndicationProxy::builder()
{
return QKnxNetIpRoutingIndicationProxy::Builder();
}
/*!
\class QKnxNetIpRoutingIndicationProxy::Builder
\inmodule QtKnx
\inheaderfile QKnxNetIpRoutingIndicationProxy
\brief The QKnxNetIpRoutingIndicationProxy::Builder class provides the means
to create a routing indication frame.
A routing indication is sent by a KNXnet/IP router or device to transmit KNX
link layer frames over IP networks.
The common way to create a routing indication is:
\code
QKnxLinkLayerFrame linkFrame = // create a link frame ....;
auto netIpframe = QKnxNetIpRoutingIndicationProxy::builder()
.setLinkLayerFrame(linkFrame)
.create();
\endcode
If a KNXnet/IP router or device receives a router busy message from another
router or device, it immediately stops sending routing indication frames and
waits until the time specified in the router busy message has elapsed to
resume sending frames.
*/
/*!
\since 5.12
Sets the cEMI frame within the routing indication frame to \a cemi and
returns a reference to the builder.
*/
QKnxNetIpRoutingIndicationProxy::Builder &
QKnxNetIpRoutingIndicationProxy::Builder::setCemi(const QKnxLinkLayerFrame &cemi)
{
m_llf = cemi;
return *this;
}
#if QT_DEPRECATED_SINCE(5, 12)
/*!
\deprecated
*/
QKnxNetIpRoutingIndicationProxy::Builder &
QKnxNetIpRoutingIndicationProxy::Builder::setLinkLayerFrame(const QKnxLinkLayerFrame &llf)
{
return setCemi(llf);
}
#endif
/*!
Creates and returns a KNXnet/IP routing indication frame.
\note The returned frame may be invalid depending on the values used during
setup.
\sa isValid()
*/
QKnxNetIpFrame QKnxNetIpRoutingIndicationProxy::Builder::create() const
{
return { QKnxNetIp::ServiceType::RoutingIndication, m_llf.bytes() };
}
QT_END_NAMESPACE
|
