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

Interface PubrelPacket

All Known Subinterfaces:

ModifiablePubrelPacket

@Immutable
@DoNotImplement
public interface PubrelPacket

Represents a PUBREL packet.

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

Since:

4.3.0, CE 2020.1

Method Summary

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

Method Details

getPacketIdentifier

int getPacketIdentifier()

The packet identifier of the PUBREL.

Returns:

The packet identifier.

Since:

4.3.0, CE 2020.1

getReasonCode

@NotNull @NotNull PubrelReasonCode getReasonCode()

The reason code from the PUBREL packet.

Returns:

The pubrel 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 PUBREL packet.

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

Returns:

An Optional containing the pubrel reason string if present.

Since:

4.3.0, CE 2020.1

getUserProperties

@NotNull @NotNull UserProperties getUserProperties()

The user properties from the PUBREL packet.

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

Returns:

The user properties.

Since:

4.3.0, CE 2020.1