RequestDibs Class

(QKnxNetIpSrpProxy::RequestDibs)

The QKnxNetIpSrpProxy::RequestDibs class provides the means to create the Request DIBs SRP for the extended search request. More...

Header: #include <QKnxNetIpSrpProxy>
qmake: QT += knx
Since: Qt 5.12

Public Functions

RequestDibs()
RequestDibs(const RequestDibs &other)
~RequestDibs()
QKnxNetIpSrp create() const
RequestDibs &setDescriptionTypes(const QVector<QKnxNetIp::DescriptionType> &types)
RequestDibs &setMandatory(bool value)
RequestDibs &operator=(const RequestDibs &other)

Detailed Description

The QKnxNetIpSrpProxy::RequestDibs class provides the means to create the Request DIBs SRP for the extended search request.

The client includes this SRP to indicate that it is interested in the listed device information blocks (DIBs). This SRP does not influence the decision of the KNXnet/IP server whether or not to respond to the search request.

This SRP has variable length. If the client is interested in an odd number of DIBs, it adds an additional description type QKnxNetIp::DescriptionType::Unknown to make the structure length even.

Note: By default the mandatory flag is set to true.

The common way to create this SRP is:

auto srpDibs = QKnxNetIpSrpProxy::requestDibsBuilder()
    .setDescriptionTypes({
        QKnxNetIp::DescriptionType::DeviceInfo,
        QKnxNetIp::DescriptionType::SupportedServiceFamilies,
        QKnxNetIp::DescriptionType::ExtendedDeviceInfo,
        QKnxNetIp::DescriptionType::Unknown
    }).create();

See also QKnxNetIpSearchRequestProxy.

Member Function Documentation

RequestDibs::RequestDibs()

Constructs a builder for a Request DIBs SRP.

RequestDibs::RequestDibs(const RequestDibs &other)

Constructs a copy of other.

RequestDibs::~RequestDibs()

Destroys the Request DIBs SRP builder.

QKnxNetIpSrp RequestDibs::create() const

Creates a Request Dibs SRP.

RequestDibs &RequestDibs::setDescriptionTypes(const QVector<QKnxNetIp::DescriptionType> &types)

Sets the requested description types of the KNXnet/IP SRP structure to types and returns a reference to the SRP builder.

RequestDibs &RequestDibs::setMandatory(bool value)

Sets the mandatory flag to value.

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

Assigns other to this Request DIBs builder and returns a reference.

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