blob: 6b3f7fe81e7976955cb6e5e7fd903aff0f8a2f07 (
plain)
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
|
/******************************************************************************
**
** 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 "qknxnetiproutingsystembroadcast.h"
#include "qknxaddress.h"
#include "qknxcontrolfield.h"
#include "qknxextendedcontrolfield.h"
#include "qknxlinklayerframebuilder.h"
QT_BEGIN_NAMESPACE
/*!
\class QKnxNetIpRoutingSystemBroadcastProxy
\inmodule QtKnx
\ingroup qtknx-netip
\ingroup qtknx-routing
\since 5.12
\brief The QKnxNetIpRoutingSystemBroadcastProxy class provides the means
to introspect a generic routing system broadcast \l QKnxNetIpFrame and to
create a KNXnet/IP frame based on the information.
Routing system broadcast messages are useful in the situation when
KNXnet/IP devices configured on different multicast addresses and secure
KNXnet/IP devices configured on different backbone keys are not able to
communicate between each other.
The following code sample illustrates how to introspect a routing system
broadcast frame:
\code
auto netIpFrame = QKnxNetIpFrame::fromBytes(...);
const QKnxNetIpRoutingSystemBroadcastProxy sbc(netIpFrame);
if (!sbc.isValid())
return;
auto linkFrame = sbc.linkLayerFrame();
\endcode
\sa builder(), QKnxNetIpRoutingSystemBroadcastProxy,
{Qt KNXnet/IP Connection Classes}
*/
/*!
\fn QKnxNetIpRoutingSystemBroadcastProxy::QKnxNetIpRoutingSystemBroadcastProxy()
\internal
*/
/*!
\fn QKnxNetIpRoutingSystemBroadcastProxy::~QKnxNetIpRoutingSystemBroadcastProxy()
\internal
*/
/*!
\fn QKnxNetIpRoutingSystemBroadcastProxy::QKnxNetIpRoutingSystemBroadcastProxy(const QKnxNetIpFrame &&)
\internal
*/
class QKnxNetIpRoutingSystemBroadcastBuilderPrivate : public QSharedData
{
public:
QKnxNetIpRoutingSystemBroadcastBuilderPrivate() = default;
~QKnxNetIpRoutingSystemBroadcastBuilderPrivate() = default;
QKnxLinkLayerFrame m_llf;
};
namespace QKnxPrivate
{
static bool isCemiValid(const QKnxLinkLayerFrame &linkFrame)
{
// TODO: Check if the cEMI message is an S-A_Data-PDU, S-A_Sync_Request-PDU or
// S-A_Sync_-Response-PDU, the SBC bit in the Security Control Field (SCF) as
// specified in (AN 158: Data security) shall be set to 1.
return linkFrame.extendedControlField().destinationAddressType() == QKnxAddress::Type::Group
&& linkFrame.controlField().broadcast() == QKnxControlField::Broadcast::System
&& linkFrame.messageCode() == QKnxLinkLayerFrame::MessageCode::DataIndication
&& linkFrame.destinationAddress().type() == QKnxAddress::Type::Group;
}
}
/*!
Constructs a proxy object to read the routing system broadcast carried
by the specified KNXnet/IP frame \a frame.
*/
QKnxNetIpRoutingSystemBroadcastProxy::QKnxNetIpRoutingSystemBroadcastProxy(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.
*/
bool QKnxNetIpRoutingSystemBroadcastProxy::isValid() const
{
return m_frame.isValid() && m_frame.size() >= 8
&& m_frame.serviceType() == QKnxNetIp::ServiceType::RoutingSystemBroadcast
&& QKnxPrivate::isCemiValid(cemi());
}
/*!
Returns a cEMI frame that contains the routing system broadcast message.
*/
QKnxLinkLayerFrame QKnxNetIpRoutingSystemBroadcastProxy::cemi() const
{
return QKnxLinkLayerFrame::builder()
.setMedium(QKnx::MediumType::NetIP)
.setData(m_frame.constData())
.createFrame();
}
/*!
Returns a builder object to create a KNXnet/IP routing system broadcast
frame.
*/
QKnxNetIpRoutingSystemBroadcastProxy::Builder QKnxNetIpRoutingSystemBroadcastProxy::builder()
{
return QKnxNetIpRoutingSystemBroadcastProxy::Builder();
}
/*!
\class QKnxNetIpRoutingSystemBroadcastProxy::Builder
\inmodule QtKnx
\inheaderfile QKnxNetIpRoutingSystemBroadcastProxy
\brief The QKnxNetIpRoutingSystemBroadcastProxy::Builder class provides
the means to create a KNXnet/IP routing system broadcast frame.
The common way to create a routing system broadcast frame is:
\code
QKnxLinkLayerFrame cemi = // build cEMI frame
auto netIpFrame = QKnxNetIpRoutingSystemBroadcastProxy::builder()
.setCemi(cemi)
.create();
\endcode
*/
/*!
Creates a new empty system broadcast frame builder object.
*/
QKnxNetIpRoutingSystemBroadcastProxy::Builder::Builder()
: d_ptr(new QKnxNetIpRoutingSystemBroadcastBuilderPrivate)
{}
/*!
Destroys the object and frees any allocated resources.
*/
QKnxNetIpRoutingSystemBroadcastProxy::Builder::~Builder() = default;
/*!
Sets the cEMI frame containing the routing system broadcast message to
\a cemi.
*/
QKnxNetIpRoutingSystemBroadcastProxy::Builder &
QKnxNetIpRoutingSystemBroadcastProxy::Builder::setCemi(const QKnxLinkLayerFrame &cemi)
{
if (QKnxPrivate::isCemiValid(cemi))
d_ptr->m_llf = cemi;
return *this;
}
/*!
Creates a KNXnet/IP frame that contains the routing system broadcast message.
*/
QKnxNetIpFrame QKnxNetIpRoutingSystemBroadcastProxy::Builder::create() const
{
if (!d_ptr->m_llf.isValid())
return {};
return { QKnxNetIp::ServiceType::RoutingSystemBroadcast, d_ptr->m_llf.bytes() };
}
/*!
Constructs a copy of \a other.
*/
QKnxNetIpRoutingSystemBroadcastProxy::Builder::Builder(const Builder &other)
: d_ptr(other.d_ptr)
{}
/*!
Assigns the specified \a other to this object.
*/
QKnxNetIpRoutingSystemBroadcastProxy::Builder &
QKnxNetIpRoutingSystemBroadcastProxy::Builder::operator=(const Builder &other)
{
d_ptr = other.d_ptr;
return *this;
}
QT_END_NAMESPACE
|
