QKnxNetIpSecuredServiceFamiliesDibProxy Class

The QKnxNetIpSecuredServiceFamiliesDibProxy class provides the means to introspect the supported service families and required security version inside the generic QKnxNetIpDib class and to create a KNXnet/IP device information block (DIB) structure based on the information. More...

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

Public Types

class Builder

Public Functions

QKnxNetIpSecuredServiceFamiliesDibProxy(const QKnxNetIpDib &dib)
QKnxNetIp::DescriptionType descriptionType() const
bool isValid() const
QVector<QKnxSecuredServiceInfo> serviceInfos() const

Static Public Members

QKnxNetIpSecuredServiceFamiliesDibProxy::Builder builder()

Detailed Description

The QKnxNetIpSecuredServiceFamiliesDibProxy class provides the means to introspect the supported service families and required security version inside the generic QKnxNetIpDib class and to create a KNXnet/IP device information block (DIB) structure based on the information.

A KNXnet/IP secured service families DIB structure contains a set of supported services and their corresponding required security version. The service family is the high octet of the service type ID and the required security version is an integer representing the security version.

KNXnet/IP service families without security requirements will not be included in the secured service families DIB.

Note: When using QKnxNetIpSecuredServiceFamiliesDibProxy, care must be taken to ensure that the referenced KNXnet/IP DIB structure outlives the proxy on all code paths, lest the proxy ends up referencing deleted data.

Reading the secured service families can be achieved like this:

auto dib = QKnxNetIpDib::fromBytes(...);

QKnxNetIpSecuredServiceFamiliesDibProxy proxy(dib);
if (!proxy.isValid())
    return;

auto infos = proxy.serviceInfos();

See also builder() and Qt KNXnet/IP Connection Classes.

Member Function Documentation

QKnxNetIpSecuredServiceFamiliesDibProxy::QKnxNetIpSecuredServiceFamiliesDibProxy(const QKnxNetIpDib &dib)

Constructs a proxy object with the specified KNXnet/IP DIB structure dib to read the supported service families and security versions.

[static] QKnxNetIpSecuredServiceFamiliesDibProxy::Builder QKnxNetIpSecuredServiceFamiliesDibProxy::builder()

Returns a builder object to create a KNXnet/IP secured service families DIB structure.

QKnxNetIp::DescriptionType QKnxNetIpSecuredServiceFamiliesDibProxy::descriptionType() const

Returns the description type of this KNXnet/IP structure if the object that was passed during construction was valid; otherwise returns QKnx::NetIp::Unknown.

bool QKnxNetIpSecuredServiceFamiliesDibProxy::isValid() const

Returns true if the KNXnet/IP structure to create the object is a valid KNXnet/IP DIB structure; otherwise returns false.

QVector<QKnxSecuredServiceInfo> QKnxNetIpSecuredServiceFamiliesDibProxy::serviceInfos() const

Returns a vector of the QKnxSecuredServiceInfo carried by this KNXnet/IP DIB structure if the object that was passed during construction was valid; otherwise returns an empty vector.

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