Builder Class

class QKnxNetIpDisconnectResponseProxy::Builder

The QKnxNetIpDisconnectResponseProxy::Builder class provides the means to read a KNXnet/IP disconnection response from the generic QKnxNetIpFrame class and to create a disconnection response frame based on the information. More...

Public Functions

QKnxNetIpFrame create() const
Builder &setChannelId(quint8 channelId)
Builder &setStatus(QKnxNetIp::Error status)

Detailed Description

A KNXnet/IP device terminates a data channel connection by sending a disconnection request to its communication partner's control endpoint. The KNXnet/IP device receiving the disconnection request acknowledges the operation with a KNXnet/IP disconnection response frame, which signals the final termination of a communication channel.

In most programs, this class will not be used directly. Instead, the QKnxNetIpTunnel or QKnxNetIpDeviceManagement class is used to establish a functional connection to a KNXnet/IP server.

The common way to create a disconnection response is:

 auto frame = QKnxNetIpDisconnectResponseProxy::builder()
     .setChannelId(200)
     .setStatus(QKnx::NetIp::Error::None)
     .create();

Member Function Documentation

QKnxNetIpFrame Builder::create() const

Creates and returns a KNXnet/IP disconnection response 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 the KNXnet/IP client and server to channelId and returns a reference to the builder.

Builder &Builder::setStatus(QKnxNetIp::Error status)

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