Builder Class

(QKnxNetIpSessionStatusProxy::Builder)

The QKnxNetIpSessionStatusProxy::Builder class provides the means to create a KNXnet/IP secure session status frame. More...

Header: #include <QKnxNetIpSessionStatusProxy>
qmake: QT += knx

Public Functions

Builder()
Builder(const Builder &other)
~Builder()
QKnxNetIpFrame create() const
Builder &setStatus(QKnxNetIp::SecureSessionStatus status)
Builder &operator=(const Builder &other)

Detailed Description

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:

auto netIpFrame = QKnxNetIpSessionStatusProxy::builder()
    .setStatus(QKnxNetIp::SecureSessionStatus::Close)
    .create();

Member Function Documentation

Builder::Builder()

Creates a new empty session status frame builder object.

Builder::Builder(const Builder &other)

Constructs a copy of other.

Builder::~Builder()

Destroys the object and frees any allocated resources.

QKnxNetIpFrame Builder::create() const

Creates and returns a KNXnet/IP session status frame.

Note: The returned frame may be invalid depending on the values used during setup.

See also isValid().

Builder &Builder::setStatus(QKnxNetIp::SecureSessionStatus status)

Sets the status of the KNXnet/IP session status frame to status and returns a reference to the builder.

Builder &Builder::operator=(const Builder &other)

Assigns the specified other to this object.

© 2018 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.