blob: 08df506d08713d930542b797ec146b982b817807 (
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
|
/******************************************************************************
**
** 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 "qknxnetipsessionstatus.h"
#include "qknxutils.h"
QT_BEGIN_NAMESPACE
/*!
\class QKnxNetIpSessionStatusProxy
\since 5.12
\inmodule QtKnx
\ingroup qtknx-netip
\brief The QKnxNetIpSessionStatusProxy class provides the means to
introspect secure session status data inside the generic \l QKnxNetIpFrame
class and to create a KNXnet/IP secure session status frame from provided
data.
This class is part of the Qt KNX module and currently available as a
Technology Preview, and therefore the API and functionality provided
by the class may be subject to change at any time without prior notice.
This frame may be sent by the KNXnet/IP secure server to the KNXnet/IP
secure client or by the KNXnet/IP secure client to the KNXnet/IP secure
server at any stage of the secure session handshake to indicate an error
condition or to convey status information.
\note When using QKnxNetIpSessionStatusProxy, 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 session status
information:
\code
auto netIpFrame = QKnxNetIpFrame::fromBytes(...);
const QKnxNetIpSessionStatusProxy proxy(netIpFrame);
if (!proxy.isValid())
return;
auto currentStatus = proxy.status();
\endcode
\sa builder(), {Qt KNXnet/IP Connection Classes}
*/
/*!
\fn QKnxNetIpSessionStatusProxy::QKnxNetIpSessionStatusProxy()
\internal
*/
/*!
\fn QKnxNetIpSessionStatusProxy::~QKnxNetIpSessionStatusProxy()
\internal
*/
/*!
\fn QKnxNetIpSessionStatusProxy::QKnxNetIpSessionStatusProxy(const QKnxNetIpFrame &&)
\internal
*/
/*!
Constructs a proxy object to read the session status information
carried by the specified KNXnet/IP frame \a frame.
*/
QKnxNetIpSessionStatusProxy::QKnxNetIpSessionStatusProxy(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.
\note KNXnet/IP session status frames currently have a fixed size of \c 8
bytes.
\sa QKnxNetIpFrameHeader::totalSize()
*/
bool QKnxNetIpSessionStatusProxy::isValid() const
{
return m_frame.isValid() && m_frame.serviceType() == QKnxNetIp::ServiceType::SessionStatus
&& m_frame.size() == 8 && status() <= QKnxNetIp::SecureSessionStatus::Close;
}
/*!
Returns the session status from the generic KNXnet/IP session status
frame.
*/
QKnxNetIp::SecureSessionStatus QKnxNetIpSessionStatusProxy::status() const
{
return QKnxNetIp::SecureSessionStatus(m_frame.constData().value(0, 0xff));
}
/*!
Returns a builder object to create a KNXnet/IP session status frame.
*/
QKnxNetIpSessionStatusProxy::Builder QKnxNetIpSessionStatusProxy::builder()
{
return QKnxNetIpSessionStatusProxy::Builder();
}
/*!
\class QKnxNetIpSessionStatusProxy::Builder
\inmodule QtKnx
\inheaderfile QKnxNetIpSessionStatusProxy
\brief The QKnxNetIpSessionStatusProxy::Builder class provides the
means to create a KNXnet/IP secure session status frame.
This class is part of the Qt KNX module and currently available as a
Technology Preview, and therefore the API and functionality provided
by the class may be subject to change at any time without prior notice.
This frame may be sent by the KNXnet/IP secure server to the KNXnet/IP
secure client or by the KNXnet/IP secure client to the KNXnet/IP secure
server at any stage of the secure session handshake to indicate an error
condition or to convey status information.
The common way to create a session status frame is:
\code
auto netIpFrame = QKnxNetIpSessionStatusProxy::builder()
.setStatus(QKnxNetIp::SecureSessionStatus::Close)
.create();
\endcode
*/
/*!
Sets the status of the KNXnet/IP session status frame to \a status
and returns a reference to the builder.
*/
QKnxNetIpSessionStatusProxy::Builder &
QKnxNetIpSessionStatusProxy::Builder::setStatus(QKnxNetIp::SecureSessionStatus status)
{
m_status = status;
return *this;
}
/*!
Creates and returns a KNXnet/IP session status frame.
\note The returned frame may be invalid depending on the values used during
setup.
\sa isValid()
*/
QKnxNetIpFrame QKnxNetIpSessionStatusProxy::Builder::create() const
{
if (m_status > QKnxNetIp::SecureSessionStatus::Close)
return { QKnxNetIp::ServiceType::SessionStatus };
return { QKnxNetIp::ServiceType::SessionStatus,
QKnxUtils::QUint16::bytes(quint16(m_status) << 8) };
}
QT_END_NAMESPACE
|
