Builder Class

class QKnxNetIpTunnelingFeatureResponseProxy::Builder

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

List of all members, including inherited members

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 &	setReturnCode(QKnx::ReturnCode code)
Builder &	setSequenceNumber(quint8 sequenceNumber)

Detailed Description

A tunneling feature-response service frame is sent by a KNXnet/IP server after receiving a tunneling feature-get or feature-set service frame. A tunneling feature-response 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 identifier service used, the return code in case of feature-set service, and the feature value as a byte array.

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

auto frame = QKnxNetIpTunnelingFeatureResponseProxy::builder()
    .setChannelId(15)
    .setSequenceNumber(10)
    .setFeatureIdentifier(QKnx::InterfaceFeature::IndividualAddress)
    .setReturnCode(QKnx::ReturnCode::SuccessWithCrc)
    .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-response 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-response 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-response 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-response service frame to value and returns a reference to the builder.

Builder &Builder::setReturnCode(QKnx::ReturnCode code)

Sets the result code of a tunneling feature-response service frame to code and returns a reference to the builder.

Builder &Builder::setSequenceNumber(quint8 sequenceNumber)

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

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