QKnxNetIpRouter Class

QKnxNetIpRouter router1;
QKnxNetIpRouter router2;
router1.setInterfaceAffinity(QNetworkInterface::interfaceFromName("eth0"));
router1.setMulticastAddress(QHostAddress("224.0.23.32"));
router1.start();

auto busyWaitTime = ...
auto busyControlField = ...

// Sending a routing indication to another router on the same IP network
auto routingBusyFrame = QKnxNetIpRoutingBusyProxy::builder()
    .setDeviceState(QKnxNetIp::DeviceState::IpFault)
    .setRoutingBusyWaitTime(busyWaitTime)
    .setRoutingBusyControl(busyControlField)
    .create();
router1.sendRoutingBusy(routingBusyFrame);

// Processing routing indications received
QObject::connect(&router1,
                 &QKnxNetIpRouter::routingIndicationReceived,
             [](QKnxNetIpFrame frame,
                QKnxNetIpRouter::FilterAction routingAction) {
        QKnxNetIpRoutingIndicationProxy indication(frame);
        qInfo().noquote() << "Received routing indication:"
                          << indication.isValid();

        switch (routingAction) {
        case QKnxNetIpRouter::FilterAction::RouteDecremented:
            auto cemi = indication.cemi();
            auto extCtrl = cemi.extendedControlField();
            count = extCtrl.hopCount();
            // decrement and send to other subnet
            extCtrl.setHopCount(--count);
            auto newIndication =  QKnxNetIpRoutingIndicationProxy::builder()
                                    .setCemi(cemi)
                                    .create();
            router2.sendRoutingIndication(newIndication)
            // ....
        case QKnxNetIpRouter::FilterAction::RouteLast:
        case QKnxNetIpRouter::FilterAction::ForwardLocally:
        case QKnxNetIpRouter::FilterAction::IgnoreTotally:
        case QKnxNetIpRouter::FilterAction::IgnoreAcked:
        //....
        default:
            break;
        }
        //....
});

Member Function Documentation

QKnxNetIpRouter::QKnxNetIpRouter(QObject *parent = nullptr)

Constructs a KNXnet/IP router with the parent parent.

[signal] void QKnxNetIpRouter::errorOccurred(QKnxNetIpRouter::Error error, QString errorString)

This signal is emitted when the KNXnet/IP router encounters the error error that is described by errorString.

[signal] void QKnxNetIpRouter::routingBusyReceived(QKnxNetIpFrame frame)

This signal is emitted when the KNXnet/IP router receives a routing busy frame.

[signal] void QKnxNetIpRouter::routingBusySent(QKnxNetIpFrame frame)

This signal is emitted when the KNXnet/IP router has finished sending the routing busy frame.

[signal] void QKnxNetIpRouter::routingIndicationReceived(QKnxNetIpFrame frame, QKnxNetIpRouter::FilterAction routingAction)

This signal is emitted when the KNXnet/IP router receives a routing indication frame and specifies the action routingAction to be applied by the router.

[signal] void QKnxNetIpRouter::routingIndicationSent(QKnxNetIpFrame frame)

This signal is emitted when the KNXnet/IP router has finished sending the routing indication frame.

[signal] void QKnxNetIpRouter::routingLostCountReceived(QKnxNetIpFrame frame)

This signal is emitted when the KNXnet/IP router receives a routing lost count message held in frame.

[signal] void QKnxNetIpRouter::routingLostCountSent(QKnxNetIpFrame frame)

This signal is emitted when the KNXnet/IP router has finished sending the routing lost count frame.

[signal] void QKnxNetIpRouter::routingSystemBroadcastReceived(QKnxNetIpFrame frame)

This signal is emitted when the KNXnet/IP router receives the routing system broadcast frame.

[signal] void QKnxNetIpRouter::routingSystemBroadcastSent(QKnxNetIpFrame frame)

This signal is emitted when the KNXnet/IP router has finished sending the routing system broadcast frame.

[slot] void QKnxNetIpRouter::sendRoutingBusy(const QKnxNetIpFrame &frame)

Multicasts the routing busy message containing frame through the network interface associated with the QKnxNetIpRouter.

[slot] void QKnxNetIpRouter::sendRoutingIndication(const QKnxNetIpFrame &frame)

Multicasts the routing indication frame through the network interface associated with the QKnxNetIpRouter.

[slot] void QKnxNetIpRouter::sendRoutingLostMessage(const QKnxNetIpFrame &frame)

Multicasts the routing lost message frame through the network interface associated with the QKnxNetIpRouter.

[slot] void QKnxNetIpRouter::sendRoutingSystemBroadcast(const QKnxNetIpFrame &frame)

Multicasts the routing system broadcast frame through the network interface associated with the QKnxNetIpRouter.

[slot] void QKnxNetIpRouter::start()

Signals the QKnxNetIpRouter to start listening for messages received and accept sending messages.

[signal] void QKnxNetIpRouter::stateChanged(QKnxNetIpRouter::State state)

This signal is emitted when the KNXnet/IP router transitions to a different state.

[slot] void QKnxNetIpRouter::stop()

Stops the QKnxNetIpRouter. No messages can be received from or sent to the network.

QKnxNetIpRouter::Error QKnxNetIpRouter::error() const

Returns a routing error code that describes the last error to occur in the KNX router.

QString QKnxNetIpRouter::errorString() const

Returns a QString describing the latest known error that occurred in the KNX router.

QKnxNetIpRouter::KnxAddressWhitelist QKnxNetIpRouter::filterTable() const

Returns the filter table used by the routing algorithm.

See also setFilterTable().

QKnxAddress QKnxNetIpRouter::individualAddress() const

Returns the routing interface's individual address.

See also setIndividualAddress().

QNetworkInterface QKnxNetIpRouter::interfaceAffinity() const

Returns the current network interface used by this KNX routing instance.

See also setInterfaceAffinity().

QHostAddress QKnxNetIpRouter::multicastAddress() const

Returns the multicast address used by the QKnxNetIpRouter.

See also setMulticastAddress().

QKnxNetIpRouter::RoutingMode QKnxNetIpRouter::routingMode() const

Returns the routing mode.

See also setRoutingMode().

void QKnxNetIpRouter::setFilterTable(const QKnxNetIpRouter::KnxAddressWhitelist &table)

Sets the filter table used by the routing algorithm to table.

See also filterTable().

void QKnxNetIpRouter::setIndividualAddress(const QKnxAddress &address)

Sets the routing interface's individual address to address.

See also individualAddress().

void QKnxNetIpRouter::setInterfaceAffinity(const QHostAddress &address)

Searches for the network interface that is bound to address that the QKnxNetIpRouter instance shall use.

See also interfaceAffinity().

void QKnxNetIpRouter::setInterfaceAffinity(const QNetworkInterface &iface)

Sets the network interface iface that the QNetworkInterface instance shall use.

void QKnxNetIpRouter::setMulticastAddress(const QHostAddress &address)

Sets the multicast address to address.

See also multicastAddress().

void QKnxNetIpRouter::setRoutingMode(QKnxNetIpRouter::RoutingMode mode)

Sets the routing mode to mode.

See also routingMode().

QKnxNetIpRouter::State QKnxNetIpRouter::state() const

Returns the current state of the KNX router.