QKnxNetIpConnectResponseProxy Class

The QKnxNetIpConnectResponseProxy class provides the means to read a connection response from the generic QKnxNetIpFrame class and to create a KNXnet/IP frame based on the information. More...

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

Public Types

class Builder

Public Functions

QKnxNetIpConnectResponseProxy(const QKnxNetIpFrame &frame)
quint8 channelId() const
QKnxNetIpHpai dataEndpoint() const
bool isValid() const
QKnxNetIpCrd responseData() const
QKnxNetIp::Error status() const

Static Public Members

QKnxNetIpConnectResponseProxy::Builder builder()

Detailed Description

The QKnxNetIpConnectResponseProxy class provides the means to read a connection response from the generic QKnxNetIpFrame class and to create a KNXnet/IP frame based on the information.

A connection response frame is sent by a KNXnet/IP server in response to a connection request received from a KNXnet/IP client. The connection response provides the status of the request. If the server accepted the request, the frame also contains the identifier and host address protocol information (HPAI) of the data endpoint that the server prepared for the communication channel.

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 QKnxNetIpConnectResponseProxy, 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 connection response information sent by a KNXnet/IP server:

auto netIpFrame = QKnxNetIpFrame::fromBytes(...);
const QKnxNetIpConnectResponseProxy proxy(netIpFrame);
if (!proxy.isValid())
    return;

auto chanId = proxy.channelId();
auto data = proxy.responseData();
auto endPoint = proxy.dataEndpoint();
auto netIpError = proxy.status();

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

Member Function Documentation

QKnxNetIpConnectResponseProxy::QKnxNetIpConnectResponseProxy(const QKnxNetIpFrame &frame)

Constructs a proxy object to read the connection response information carried by the specified KNXnet/IP frame frame.

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

Returns a builder object to create a KNXnet/IP connection response frame.

quint8 QKnxNetIpConnectResponseProxy::channelId() const

Returns the ID of the communication channel prepared by the KNXnet/IP server.

QKnxNetIpHpai QKnxNetIpConnectResponseProxy::dataEndpoint() const

Returns the data endpoint of the KNXnet/IP server.

bool QKnxNetIpConnectResponseProxy::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().

QKnxNetIpCrd QKnxNetIpConnectResponseProxy::responseData() const

Returns a connection response data (CRD) structure from the KNXnet/IP connection request frame.

QKnxNetIp::Error QKnxNetIpConnectResponseProxy::status() const

Returns the status of the connection request received from a KNXnet/IP client.

See also QKnxNetIpConnectRequestProxy.

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