Builder Class

class QKnxNetIpTunnelingFeatureSetProxy::Builder

The QKnxNetIpTunnelingFeatureSetProxy::Builder class provides the means to create a KNXnet/IP tunneling feature-set 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-set 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 to set, and the feature value as a byte array.

The tunneling client initiates the tunneling feature-set service to set the value of an interface feature in a tunneling server. The tunneling server accepts the value and applies it immediately, unless specified differently.

This means that the server applies the value before sending the tunneling feature-response or before routing the next tunneling request on the bus.

Within 3 seconds of confirming the tunneling feature-set service, the tunneling server sends a tunneling feature-response frame. The frame contains the written value and a return code.

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

 auto frame = QKnxNetIpTunnelingFeatureSetProxy::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-set 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-set 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-set 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 the a tunneling feature-set service frame to value and returns a reference to the builder.

Builder &Builder::setSequenceNumber(quint8 sequenceNumber)

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