Package com.hivemq.extension.sdk.api.packets.pubcomp

Interface PubcompPacket

All Known Subinterfaces:

ModifiablePubcompPacket

@Immutable
@DoNotImplement
public interface PubcompPacket

Represents a PUBCOMP packet.

Contains all values of an MQTT 5 PUBCOMP, but will also used to represent MQTT 3 PUBCOMP packets.

Since:

4.3.0, CE 2020.1

Method Summary

Modifier and Type	Method	Description
int	getPacketIdentifier()	The packet identifier of the PUBCOMP.
@NotNull PubcompReasonCode	getReasonCode()	The reason code from the PUBCOMP packet.
@NotNull Optional<String>	getReasonString()	The reason string of the PUBCOMP packet.
@NotNull UserProperties	getUserProperties()	The user properties from the PUBCOMP packet.

Method Details

getPacketIdentifier

int getPacketIdentifier()

The packet identifier of the PUBCOMP.

Returns:

The packet identifier.

Since:

4.3.0, CE 2020.1

getReasonCode

@NotNull @NotNull PubcompReasonCode getReasonCode()

The reason code from the PUBCOMP packet.

Returns:

The pubcomp reason code.

Since:

4.3.0, CE 2020.1

See Also:

How reason codes are translated from MQTT 5 to MQTT 3.

getReasonString

@NotNull @NotNull Optional<String> getReasonString()

The reason string of the PUBCOMP packet.

For an MQTT 3 client this Optional for the MQTT 5 property will always be empty (if not modified by a previous PubcompInboundInterceptor or PubcompOutboundInterceptor).

Returns:

An Optional containing the pubcomp reason string if present.

Since:

4.3.0, CE 2020.1

getUserProperties

@NotNull @NotNull UserProperties getUserProperties()

The user properties from the PUBCOMP packet.

For an MQTT 3 client this MQTT 5 property will always be empty (if not modified by a previous PubcompInboundInterceptor or PubcompOutboundInterceptor).

Returns:

The user properties.

Since:

4.3.0, CE 2020.1