QKnxNetIpDeviceConfigurationAcknowledgeProxy Class

The QKnxNetIpDeviceConfigurationAcknowledgeProxy class provides the means to read a device configuration acknowledgment from the generic QKnxNetIpFrame class and to create a KNXnet/IP frame based on the information. More...

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

Public Types

class Builder

Public Functions

QKnxNetIpDeviceConfigurationAcknowledgeProxy(const QKnxNetIpFrame &frame)
quint8 channelId() const
bool isValid() const
quint8 sequenceNumber() const
QKnxNetIp::Error status() const

Static Public Members

QKnxNetIpDeviceConfigurationAcknowledgeProxy::Builder builder()

Detailed Description

The QKnxNetIpDeviceConfigurationAcknowledgeProxy class provides the means to read a device configuration acknowledgment from the generic QKnxNetIpFrame class and to create a KNXnet/IP frame based on the information.

A KNXnet/IP client connects to a configuration and management data endpoint of a KNXnet/IP server to send device configuration request frames and to receive device configuration acknowledgment frames. A device configuration request is used to read and write KNXnet/IP device configuration data. When a server receives a configuration request, it responds with a device configuration acknowledgment to confirm the reception of the request.

A device configuration acknowledgment frame contains the ID and status of the communication channel between a KNXnet/IP client and server, as well as the sequence number of the device configuration request frame.

The KNXnet/IP server discards device configuration request frames with unexpected sequence numbers and does not send a device configuration acknowledgment upon receiving them.

In most programs, this class will not be used directly. Instead, the QKnxNetIpTunnel or QKnxNetIpDeviceManagement class is used to establish a functional connection to a KNXnet/IP server.

Note: When using QKnxNetIpDeviceConfigurationAcknowledgeProxy, 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 device configuration acknowledgment information sent by a KNXnet/IP client:

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

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

quint8 chanId = proxy.channelId();
quint8 seqNum = proxy.sequenceNumber();
QKnx::NetIp::Error error = proxy.status();

See also builder(), QKnxNetIpDeviceConfigurationRequestProxy, Qt KNX Device Management Classes, and Qt KNXnet/IP Connection Classes.

Member Function Documentation

QKnxNetIpDeviceConfigurationAcknowledgeProxy::QKnxNetIpDeviceConfigurationAcknowledgeProxy(const QKnxNetIpFrame &frame)

Constructs a proxy object to read the device configuration acknowledgment information carried by the specified KNXnet/IP frame frame.

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

Returns a builder object to create a KNXnet/IP device configuration acknowledgment frame.

quint8 QKnxNetIpDeviceConfigurationAcknowledgeProxy::channelId() const

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

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

Returns the sequence number of a device configuration request frame.

QKnxNetIp::Error QKnxNetIpDeviceConfigurationAcknowledgeProxy::status() const

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

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