Package com.hivemq.client.mqtt.mqtt5.message.auth

Interface Mqtt5Auth

All Superinterfaces:

Mqtt5EnhancedAuth, Mqtt5Message

@DoNotImplement
public interface Mqtt5Auth
extends Mqtt5Message, Mqtt5EnhancedAuth

MQTT 5 Auth message. This message is translated from and to an MQTT 5 AUTH packet.

Since:

1.0

Method Summary

Modifier and Type	Method	Description
@NotNull Mqtt5AuthReasonCode	getReasonCode()
@NotNull Optional<MqttUtf8String>	getReasonString()
default @NotNull Mqtt5MessageType	getType()
@NotNull Mqtt5UserProperties	getUserProperties()

Methods inherited from interface com.hivemq.client.mqtt.mqtt5.message.auth.Mqtt5EnhancedAuth

getData, getMethod

Method Details

getReasonCode

@NotNull
@NotNull Mqtt5AuthReasonCode getReasonCode()

Returns:

the Reason Code of this Auth message.

getReasonString

@NotNull
@NotNull Optional<MqttUtf8String> getReasonString()

Returns:

the optional reason string of this Auth message.

getUserProperties

@NotNull
@NotNull Mqtt5UserProperties getUserProperties()

Returns:

the optional user properties of this Auth message.

getType

@NotNull
default @NotNull Mqtt5MessageType getType()

Specified by:

getType in interface Mqtt5Message

Returns:

the type of this MQTT message.