Builder Class

auto auth = ... // create the full 128 bit CCM-MAC
auto frame = ... // create encrypted frame

auto netIpFrame = QKnxNetIpSecureWrapperProxy::builder()
    .setSequenceNumber(15021976)
    .setSerialNumber(QKnxByteArray::fromHex("0123456789AB"))
    .setEncapsulatedFrame(frame)
    .setMessageAuthenticationCode(auth)
    .create();

Member Function Documentation

Builder::Builder(const Builder &other)

Constructs a copy of other.

Builder::Builder()

Creates a new empty secure wrapper 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 secure wrapper frame.

See also isValid().

Builder &Builder::setEncapsulatedFrame(const QKnxByteArray &frame)

Sets the encapsulated and already encrypted KNXnet/IP frame to frame and returns a reference to the builder.

Builder &Builder::setMessageAuthenticationCode(const QKnxByteArray &data)

Sets the AES128 CCM message authentication code (MAC) of the generic KNXnet/IP secure wrapper frame to data and returns a reference to builder. The MAC has a fixed size of 16 bytes.

Builder &Builder::setMessageTag(quint16 tag)

Sets the message tag of the generic KNXnet/IP secure wrapper frame to tag and returns a reference to the builder. By default value is set to 0x0000.

This field contains an arbitrary value to differentiate two KNXnet/IP secure wrapper multicast frames sent by one KNXnet/IP device within the same millisecond (thus the same timer value).

Builder &Builder::setSecureSessionId(quint16 sessionId)

Sets the secure session ID to sessionId and returns a reference to the builder. By default value is set to 0x0000.

For multicast connections the fixed identifier 0x0000 must be used. For unicast connections the ID was established during a previous successful secure session setup procedure.

Builder &Builder::setSequenceNumber(quint48 seqNumber)

Sets the sequence number to seqNumber and returns a reference to the builder.

For unicast connections it is a monotonically increasing sequence number assigned by the sender; incremented by the sender after each frame sent. For multicast connections this is the device's current multicast timer value in millisecond resolution.

Builder &Builder::setSerialNumber(const QKnxByteArray &serialNumber)

Sets the serial number to serialNumber and returns a reference to the builder.