QKnxNetIpRoutingLostMessageProxy Class

The QKnxNetIpRoutingLostMessageProxy class provides the means to read a routing-lost message from the generic QKnxNetIpFrame class and to create a KNXnet/IP frame based on the information. More...

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

Public Types

class Builder

Public Functions

QKnxNetIpRoutingLostMessageProxy(const QKnxNetIpFrame &frame)
QKnxNetIp::DeviceState deviceState() const
bool isValid() const
quint16 lostMessageCount() const

Static Public Members

QKnxNetIpRoutingLostMessageProxy::Builder builder()

Detailed Description

The QKnxNetIpRoutingLostMessageProxy class provides the means to read a routing-lost message from the generic QKnxNetIpFrame class and to create a KNXnet/IP frame based on the information.

Depending on the configuration, a KNXnet/IP router or device can receive more datagrams than it can forward to the KNX subnetwork. This can lead to an overflow of the datagram queue and subsequent loss of one or more KNXnet/IP telegrams, because they could not be transferred from the network buffer to the queue to the underlying KNX subnetwork.

A routing-lost message is multicast by a KNXnet/IP router to notify that KNXnet/IP routing indication frames were lost. The message contains the state of the router or device (QKnx::NetIp::DeviceState) and the number of lost frames.

Note: When using QKnxNetIpRoutingLostMessageProxy, 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 routing-lost message information sent by a KNXnet/IP router:

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

QKnxNetIpRoutingLostMessageProxy proxy(netIpFrame);
if (!proxy.isValid())
    return;

if (proxy.deviceState() == QKnx::NetIp::DeviceState::KnxFault) {
    ....
}

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

Member Function Documentation

QKnxNetIpRoutingLostMessageProxy::QKnxNetIpRoutingLostMessageProxy(const QKnxNetIpFrame &frame)

Constructs a proxy object to read the routing-lost message information carried by the specified KNXnet/IP frame frame.

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

Returns a builder object to create a KNXnet/IP routing-lost message frame.

QKnxNetIp::DeviceState QKnxNetIpRoutingLostMessageProxy::deviceState() const

Returns the state of a KNXnet/IP router or device.

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

quint16 QKnxNetIpRoutingLostMessageProxy::lostMessageCount() const

Returns the number of frames that were lost.

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