com.hivemq.client.mqtt.mqtt5.message.subscribe.suback

Interface Mqtt5SubAck

All Superinterfaces:

Mqtt5Message

All Known Implementing Classes:

MqttSubAck

@DoNotImplement
public interface Mqtt5SubAck
extends Mqtt5Message

MQTT 5 SubAck message. This message is translated from and to a MQTT 5 SUBACK packet.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
@Immutable @NotNull java.util.List<Mqtt5SubAckReasonCode>	getReasonCodes()
@NotNull java.util.Optional<MqttUtf8String>	getReasonString()
default @NotNull Mqtt5MessageType	getType()
@NotNull Mqtt5UserProperties	getUserProperties()

Method Detail

getReasonCodes

@NotNull
@Immutable @NotNull java.util.List<Mqtt5SubAckReasonCode> getReasonCodes()

Returns:

the Reason Codes of this SubAck message, each belonging to a Subscription in the corresponding Subscribe message in the same order.

getReasonString

@NotNull
@NotNull java.util.Optional<MqttUtf8String> getReasonString()

Returns:

the optional reason string of this SubAck message.

getUserProperties

@NotNull
@NotNull Mqtt5UserProperties getUserProperties()

Returns:

the optional user properties of this SubAck message.

getType

@NotNull
default @NotNull Mqtt5MessageType getType()

Specified by:

getType in interface Mqtt5Message

Returns:

the type of this MQTT message.