Interface PubackPacket
-
- All Known Subinterfaces:
ModifiablePubackPacket
@Immutable @DoNotImplement public interface PubackPacket
Represents a PUBACK packet.Contains all values of an MQTT 5 PUBACK, but will also used to represent MQTT 3 PUBACK 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 PUBACK.@NotNull AckReasonCode
getReasonCode()
The reason code from the PUBACK packet.@NotNull Optional<String>
getReasonString()
The reason string of the PUBACK packet.@NotNull UserProperties
getUserProperties()
The user properties from the PUBACK packet.
-
-
-
Method Detail
-
getPacketIdentifier
int getPacketIdentifier()
The packet identifier of the PUBACK.- Returns:
- The packet identifier.
- Since:
- 4.3.0, CE 2020.1
-
getReasonCode
@NotNull AckReasonCode getReasonCode()
The reason code from the PUBACK packet.- Returns:
- The PUBACK 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 PUBACK packet.For an MQTT 3 client this
Optional
for the MQTT 5 property will always be empty (if not modified by a previousPubackOutboundInterceptor
orPubackInboundInterceptor
).- Returns:
- An
Optional
containing the PUBACK reason string if present. - Since:
- 4.3.0, CE 2020.1
-
getUserProperties
@NotNull UserProperties getUserProperties()
The user properties from the PUBACK packet.For an MQTT 3 client this MQTT 5 property will always be empty (if not modified by a previous
PubackOutboundInterceptor
orPubackInboundInterceptor
).- Returns:
- The user properties.
- Since:
- 4.3.0, CE 2020.1
-
-