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

Interface Mqtt5Disconnect

All Superinterfaces:

Mqtt5Message

@DoNotImplement
public interface Mqtt5Disconnect
extends Mqtt5Message

MQTT 5 Disconnect message. This message is translated from and to an MQTT 5 DISCONNECT packet.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
static final @NotNull Mqtt5DisconnectReasonCode	DEFAULT_REASON_CODE	Default Reason Code of a Disconnect message.

Method Summary

Modifier and Type	Method	Description
static @NotNull Mqtt5DisconnectBuilder	builder()	Creates a builder for a Disconnect message.
@NotNull Mqtt5DisconnectBuilder	extend()	Creates a builder for extending this Disconnect message.
@NotNull Mqtt5DisconnectReasonCode	getReasonCode()
@NotNull Optional<MqttUtf8String>	getReasonString()
@NotNull Optional<MqttUtf8String>	getServerReference()
@NotNull OptionalLong	getSessionExpiryInterval()
default @NotNull Mqtt5MessageType	getType()
@NotNull Mqtt5UserProperties	getUserProperties()

Field Details

DEFAULT_REASON_CODE

@NotNull
static final @NotNull Mqtt5DisconnectReasonCode DEFAULT_REASON_CODE

Default Reason Code of a Disconnect message.

Method Details

builder

@NotNull
static @NotNull Mqtt5DisconnectBuilder builder()

Creates a builder for a Disconnect message.

Returns:

the created builder.

getReasonCode

@NotNull
@NotNull Mqtt5DisconnectReasonCode getReasonCode()

Returns:

the Reason Code of this Disconnect message.

getSessionExpiryInterval

@NotNull
@NotNull OptionalLong getSessionExpiryInterval()

Returns:

the optional session expiry interval in seconds, the client disconnects from with this Disconnect message.

getServerReference

@NotNull
@NotNull Optional<MqttUtf8String> getServerReference()

Returns:

the optional server reference, which can be used if the server sent this Disconnect message.

getReasonString

@NotNull
@NotNull Optional<MqttUtf8String> getReasonString()

Returns:

the optional reason string of this Disconnect message.

getUserProperties

@NotNull
@NotNull Mqtt5UserProperties getUserProperties()

Returns:

the optional user properties of this Disconnect message.

getType

@NotNull
default @NotNull Mqtt5MessageType getType()

Specified by:

getType in interface Mqtt5Message

Returns:

the type of this MQTT message.

extend

@NotNull
@NotNull Mqtt5DisconnectBuilder extend()

Creates a builder for extending this Disconnect message.

Returns:

the created builder.