Package software.amazon.awssdk.crt.mqtt5.packets

Class DisconnectPacket

java.lang.Object

software.amazon.awssdk.crt.mqtt5.packets.DisconnectPacket

public class DisconnectPacket
extends java.lang.Object

Data model of an MQTT5 DISCONNECT packet.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DisconnectPacket.DisconnectPacketBuilder	A class to that allows for the creation of a DisconnectPacket.
static class	DisconnectPacket.DisconnectReasonCode	Reason code inside DisconnectPackets.

Method Summary

Modifier and Type	Method	Description
DisconnectPacket.DisconnectReasonCode	getReasonCode()	Returns a value indicating the reason that the sender is closing the connection See MQTT5 Disconnect Reason Code
java.lang.String	getReasonString()	Returns additional diagnostic information about the reason that the sender is closing the connection See MQTT5 Reason String
java.lang.String	getServerReference()	Returns a property indicating an alternate server that the client may temporarily or permanently attempt to connect to instead of the configured endpoint.
java.lang.Long	getSessionExpiryIntervalSeconds()	Returns a change to the session expiry interval negotiated at connection time as part of the disconnect.
java.util.List<UserProperty>	getUserProperties()	Returns a list of MQTT5 user properties included with the packet.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getReasonCode

public DisconnectPacket.DisconnectReasonCode getReasonCode()

Returns a value indicating the reason that the sender is closing the connection See MQTT5 Disconnect Reason Code

Returns:

Value indicating the reason that the sender is closing the connection

getSessionExpiryIntervalSeconds

public java.lang.Long getSessionExpiryIntervalSeconds()

Returns a change to the session expiry interval negotiated at connection time as part of the disconnect. Only valid for DisconnectPackets sent from client to server. It is not valid to attempt to change session expiry from zero to a non-zero value. See MQTT5 Session Expiry Interval.

Returns:

A change to the session expiry interval negotiated at connection time as part of the disconnect.

getReasonString

public java.lang.String getReasonString()

Returns additional diagnostic information about the reason that the sender is closing the connection See MQTT5 Reason String

Returns:

Additional diagnostic information about the reason that the sender is closing the connection

getUserProperties

public java.util.List<UserProperty> getUserProperties()

Returns a list of MQTT5 user properties included with the packet. See MQTT5 User Property

Returns:

List of MQTT5 user properties included with the packet.

getServerReference

public java.lang.String getServerReference()

Returns a property indicating an alternate server that the client may temporarily or permanently attempt to connect to instead of the configured endpoint. Will only be set if the reason code indicates another server may be used (ServerMoved, UseAnotherServer). See MQTT5 Server Reference

Returns:

Property indicating an alternate server that the client may temporarily or permanently attempt to connect to instead of the configured endpoint.