QKnxNetIpTunnelingFeatureInfoProxy Class

The QKnxNetIpTunnelingFeatureInfoProxy class provides the means to access the information carried by a generic tunneling feature-info service QKnxNetIpFrame frame and to create a KNXnet/IP frame based on the information. More...

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

Public Types

class Builder

Public Functions

QKnxNetIpTunnelingFeatureInfoProxy(const QKnxNetIpFrame &frame)
quint8 channelId() const
QKnx::InterfaceFeature featureIdentifier() const
QKnxByteArray featureValue() const
bool isValid() const
quint8 sequenceNumber() const

Static Public Members

QKnxNetIpTunnelingFeatureInfoProxy::Builder builder()

Detailed Description

The QKnxNetIpTunnelingFeatureInfoProxy class provides the means to access the information carried by a generic tunneling feature-info service QKnxNetIpFrame frame and to create a KNXnet/IP frame based on the information.

A tunneling feature-info service frame contains the ID of the communication channel between a KNXnet/IP client and server, the sequence number of the frame, the interface feature that changed, and the feature value as a byte array.

The tunneling server only sends the tunneling feature-info service frame if the interface feature interface feature info service enable has the value enable set. If enabled, the tunneling server initiates the tunneling feature-info service to report on any relevant change of an interface feature to the tunneling client.

The tunneling server by default reports for all its supported interface features. There is no standard way for the tunneling client to disable the reporting of an individual interface feature. This may be possible through the normal configuration of the tunneling server device by a management client (MaC), e.g. over KNXnet/IP device management.

The tunneling server addresses the tunneling feature-info service frame to the data endpoint of the established tunneling connection.

Note: When using QKnxNetIpTunnelingFeatureInfoProxy, 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 tunneling feature-info service information sent by a KNXnet/IP server:

auto netIpFrame = QKnxNetIpFrame::fromBytes(...);

const QKnxNetIpTunnelingFeatureInfoProxy proxy(netIpFrame);
if (!proxy.isValid())
    return;

auto id = proxy.featureIdentifier();
auto value = proxy.featureValue();

See also builder(), QKnxNetIpTunnelingFeatureGetProxy, QKnxNetIpTunnelingFeatureSetProxy, Qt KNX Tunneling Classes, and Qt KNXnet/IP Connection Classes.

Member Function Documentation

QKnxNetIpTunnelingFeatureInfoProxy::QKnxNetIpTunnelingFeatureInfoProxy(const QKnxNetIpFrame &frame)

Constructs a proxy object to read the tunneling feature-info service information carried by the specified KNXnet/IP frame frame.

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

Returns a builder object to create a KNXnet/IP tunneling feature-info service frame.

quint8 QKnxNetIpTunnelingFeatureInfoProxy::channelId() const

Returns the ID of the communication channel between a KNXnet/IP client and server.

QKnx::InterfaceFeature QKnxNetIpTunnelingFeatureInfoProxy::featureIdentifier() const

Returns the tunneling interface feature identifier of a tunneling feature-info frame.

QKnxByteArray QKnxNetIpTunnelingFeatureInfoProxy::featureValue() const

Returns the tunneling interface feature value of a tunneling feature-info service frame.

bool QKnxNetIpTunnelingFeatureInfoProxy::isValid() const

Returns true if the frame contains initialized values and is in itself valid, otherwise returns 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.

See also QKnxNetIpFrameHeader::totalSize().

quint8 QKnxNetIpTunnelingFeatureInfoProxy::sequenceNumber() const

Returns the sequence number of a tunneling feature-info service frame.

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