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

Interface SubackPacket

All Known Subinterfaces:

ModifiableSubackPacket

@Immutable
@DoNotImplement
public interface SubackPacket

Represents a SUBACK packet.

Contains all values of an MQTT 5 SUBACK, but will also be used to represent MQTT 3 SUBACK messages.

Since:

4.3.0, CE 2020.1

Method Summary

Modifier and Type	Method	Description
int	getPacketIdentifier()	The packet identifier of this SUBACK packet.
@Immutable @NotNull List<@NotNull SubackReasonCode>	getReasonCodes()	The reason codes for each subscription in the corresponding SUBSCRIBE message.
@NotNull Optional<String>	getReasonString()	The reason string of the SUBACK packet.
@Immutable @NotNull UserProperties	getUserProperties()	The UserProperties of this SUBACK packet.

Method Details

getPacketIdentifier

int getPacketIdentifier()

The packet identifier of this SUBACK packet.

Returns:

The packet identifier.

Since:

4.3.0, CE 2020.1

getReasonCodes

@Immutable @NotNull @Immutable @NotNull List<@NotNull SubackReasonCode> getReasonCodes()

The reason codes for each subscription in the corresponding SUBSCRIBE message.

Returns:

The reason codes for the subscriptions.

Since:

4.3.0, CE 2020.1

getReasonString

@NotNull @NotNull Optional<String> getReasonString()

The reason string of the SUBACK packet.

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

Returns:

An Optional containing the suback reason string if present.

Since:

4.3.0, CE 2020.1

getUserProperties

@Immutable @NotNull @Immutable @NotNull UserProperties getUserProperties()

The UserProperties of this SUBACK packet.

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

Returns:

The user properties.

Since:

4.3.0, CE 2020.1