QKnxNetIpTunnelingFeatureGetProxy Class

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

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

Public Types

class Builder

Public Functions

QKnxNetIpTunnelingFeatureGetProxy(const QKnxNetIpFrame &frame)
quint8 channelId() const
QKnx::InterfaceFeature featureIdentifier() const
bool isValid() const
quint8 sequenceNumber() const

Static Public Members

QKnxNetIpTunnelingFeatureGetProxy::Builder builder()

Detailed Description

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

A tunneling feature-get service frame contains the ID of the communication channel between a KNXnet/IP client and server, the sequence number of the frame, and the interface feature to read.

The tunneling client initiates the tunneling feature-get service to read the value of an interface feature from the tunneling server. Within 3 seconds after confirming the tunneling feature-get service the tunneling server sends a tunneling feature-response frame containing the value of the requested interface feature.

If the tunneling server does not respond to the tunneling feature-get service frame the tunneling client may or may not repeat the request.

Note: When using QKnxNetIpTunnelingFeatureGetProxy, 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-get information sent by a KNXnet/IP client:

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

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

auto id = proxy.featureIdentifier();

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

Member Function Documentation

QKnxNetIpTunnelingFeatureGetProxy::QKnxNetIpTunnelingFeatureGetProxy(const QKnxNetIpFrame &frame)

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

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

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

quint8 QKnxNetIpTunnelingFeatureGetProxy::channelId() const

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

QKnx::InterfaceFeature QKnxNetIpTunnelingFeatureGetProxy::featureIdentifier() const

Returns the tunneling interface feature identifier of a tunneling feature-get service frame.

bool QKnxNetIpTunnelingFeatureGetProxy::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 QKnxNetIpTunnelingFeatureGetProxy::sequenceNumber() const

Returns the sequence number of a tunneling feature-get 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.