Builder Class

(QKnxNetIpDescriptionRequestProxy::Builder)

The QKnxNetIpDescriptionRequestProxy::Builder class provides the means to create a KNXnet/IP description request frame. More...

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

Public Functions

QKnxNetIpFrame create() const
Builder &setControlEndpoint(const QKnxNetIpHpai &hpai)

Detailed Description

The QKnxNetIpDescriptionRequestProxy::Builder class provides the means to create a KNXnet/IP description request frame.

After discovering a KNXnet/IP server, the KNXnet/IP client sends a description request through a unicast or point-to-point connection to all control endpoints of the server.

In most programs, this class will not be used directly. Instead, the QKnxNetIpServerDescriptionAgent and QKnxNetIpServerInfo are provided to check that the server supports the requested connection type and options.

The common way to create a a search response is:

auto netIpFrame = QKnxNetIpDescriptionRequestProxy::builder()
    .setControlEndpoint(QKnxNetIpHpaiProxy::builder()
        .setHostAddress(QHostAddress::LocalHost)
        .setPort(3671).create())
    .create();

Member Function Documentation

QKnxNetIpFrame Builder::create() const

Creates and returns a KNXnet/IP description request frame.

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

See also isValid().

Builder &Builder::setControlEndpoint(const QKnxNetIpHpai &hpai)

Sets the control endpoint of the KNXnet/IP client to hpai and returns a reference to the builder.

© 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.