Builder Class

class QKnxNetIpRoutingBusyProxy::Builder

The QKnxNetIpRoutingBusyProxy::Builder class provides the means to create a router busy message frame. More...

Public Functions

QKnxNetIpFrame create() const
Builder &setDeviceState(QKnxNetIp::DeviceState state)
Builder &setRoutingBusyControl(quint16 busyControl)
Builder &setRoutingBusyWaitTime(quint16 waitTime)

Detailed Description

A router busy message is sent by a KNXnet/IP router or device to notify all other devices that its incoming queue is filling up and it may loose datagrams if they do not stop sending. The message contains the state of the router or device (QKnx::NetIp::DeviceState), the timeout used to empty the incoming queue of the router or device, and the routing busy control field. The control field is set to 0000h, which requires all routers and devices to act upon receiving the router busy message.

The common way to create a routing-busy message is:

auto frame = QKnxNetIpRoutingBusyProxy::builder()
    .setDeviceState(QKnx::NetIp::DeviceState::IpFault)
    .setRoutingBusyWaitTime(99)
    .setRoutingBusyControl(0xffff)
    .create();

If a KNXnet/IP router or device receives a router busy message from another router or device, it immediately stops sending routing indication frames and waits until the time specified in the router busy message has elapsed to resume sending frames.

Member Function Documentation

QKnxNetIpFrame Builder::create() const

Creates and returns a KNXnet/IP router busy message frame.

Note: The returned frame may be invalid depending on the values used during setup.

See also isValid().

Builder &Builder::setDeviceState(QKnxNetIp::DeviceState state)

Sets the state of a KNXnet/IP router or device to state and returns a reference to the builder.

Builder &Builder::setRoutingBusyControl(quint16 busyControl)

Sets the router busy control field to busyControl and returns a reference to the builder.

By default, the control field is set to 0000h, which requires all routers and devices to act upon receiving the router busy message.

Builder &Builder::setRoutingBusyWaitTime(quint16 waitTime)

Sets the timeout after which a KNXnet/IP router or device empties its incoming datagram queue to waitTime and returns a reference to the builder.

The timeout can be from 20 to 100 milliseconds.

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