Builder Class

Class Builder is declared in class QKnxNetIpTunnelingFeatureInfoProxy.

The QKnxNetIpTunnelingFeatureInfoProxy::Builder class provides the means to create a KNXnet/IP tunneling feature-info service frame. More...

Public Functions

Builder(const Builder &other)
Builder()
Builder &operator=(const Builder &other)
~Builder()
QKnxNetIpFrame create() const
Builder &setChannelId(quint8 channelId)
Builder &setFeatureIdentifier(QKnx::InterfaceFeature id)
Builder &setFeatureValue(const QKnxByteArray &value)
Builder &setSequenceNumber(quint8 sequenceNumber)

Detailed Description

A tunneling feature-info service frame contains the ID of the communication channel between a KNXnet/IP client and server, the sequence number of the frame, the interface feature that changed, and the feature value as a byte array.

The tunneling server only sends the tunneling feature-info service frame if the interface feature interface feature info service enable has the value enable set. If enabled, the tunneling server initiates the tunneling feature-info service to report on any relevant change of an interface feature to the tunneling client.

The tunneling server by default reports for all its supported interface features. There is no standard way for the tunneling client to disable the reporting of an individual interface feature. This may be possible through the normal configuration of the tunneling server device by a management client (MaC), e.g. over KNXnet/IP device management.

The tunneling server addresses the tunneling feature-info service frame to the data endpoint of the established tunneling connection.

The common way to create a tunneling feature-info service frame is:

auto frame = QKnxNetIpTunnelingFeatureInfoProxy::builder()
    .setChannelId(15)
    .setSequenceNumber(10)
    .setFeatureIdentifier(QKnx::InterfaceFeature::IndividualAddress)
    .setFeatureValue(QKnxAddress::Individual::Unregistered.bytes())
    .create();

Member Function Documentation

Builder::Builder(const Builder &other)

Constructs a copy of other.

Builder::Builder()

Creates a new empty tunneling feature-info service frame builder object.

Builder &Builder::operator=(const Builder &other)

Assigns the specified other to this object.

Builder::~Builder()

Destroys the object and frees any allocated resources.

QKnxNetIpFrame Builder::create() const

Creates and returns a KNXnet/IP tunneling feature-info service frame.

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

See also isValid().

Builder &Builder::setChannelId(quint8 channelId)

Sets the ID of the communication channel between a KNXnet/IP client and server to channelId and returns a reference to the builder.

Builder &Builder::setFeatureIdentifier(QKnx::InterfaceFeature id)

Sets the interface feature identifier of a tunneling feature-info service frame to id and returns a reference to the builder.

Does nothing if id is not a QKnx::InterfaceFeature.

Builder &Builder::setFeatureValue(const QKnxByteArray &value)

Sets the feature value of a tunneling feature-info service frame to value and returns a reference to the builder.

Builder &Builder::setSequenceNumber(quint8 sequenceNumber)

Sets the sequence number of a tunneling feature-info service frame to sequenceNumber and returns a reference to the builder.

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