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
All Methods Instance Methods Abstract Methods 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 Detail
-
getPacketIdentifier
int getPacketIdentifier()
The packet identifier of the PUBREL.- Returns:
- The packet identifier.
- Since:
- 4.3.0, CE 2020.1
-
getReasonCode
@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 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 previousPubrelInboundInterceptor
orPubrelOutboundInterceptor
).- Returns:
- An
Optional
containing the pubrel reason string if present. - Since:
- 4.3.0, CE 2020.1
-
getUserProperties
@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
orPubrelOutboundInterceptor
).- Returns:
- The user properties.
- Since:
- 4.3.0, CE 2020.1
-
-