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

Interface UnsubscribePacket

All Known Subinterfaces:

ModifiableUnsubscribePacket

@Immutable
@DoNotImplement
public interface UnsubscribePacket

Represents an UNSUBSCRIBE packet.

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

Since:

4.3.0, CE 2020.1

Method Summary

Modifier and Type	Method	Description
int	getPacketIdentifier()	The packet identifier of the UNSUBSCRIBE packet.
@Immutable @NotNull List<@NotNull String>	getTopicFilters()	Gets the list of topics to be unsubscribed from.
@Immutable @NotNull UserProperties	getUserProperties()	The user properties from the UNSUBSCRIBE packet.

Method Detail

getPacketIdentifier

int getPacketIdentifier()

The packet identifier of the UNSUBSCRIBE packet.

Returns:

The packet identifier.

Since:

4.3.0, CE 2020.1

getTopicFilters

@Immutable
@NotNull
@Immutable @NotNull List<@NotNull String> getTopicFilters()

Gets the list of topics to be unsubscribed from.

Returns:

The list of topics to be unsubscribed from.

Since:

4.3.0, CE 2020.1

getUserProperties

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

The user properties from the UNSUBSCRIBE packet.

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

Returns:

The UserProperties of the UNSUBSCRIBE packet.

Since:

4.3.0, CE 2020.1