java.lang.Object
- java.lang.Enum<DisconnectReasonCode>
- - com.hivemq.extension.sdk.api.packets.disconnect.DisconnectReasonCode

All Implemented Interfaces:

Serializable, Comparable<DisconnectReasonCode>
```
public enum DisconnectReasonCode
extends Enum<DisconnectReasonCode>
```
MQTT 5 disconnect reason codes are listed here.
MQTT 3 does not support sending a DISCONNECT packet from server to client.

Since:

4.0.0, CE 2019.1

Enum Constant Summary

Enum Constants
Enum Constant	Description
`ADMINISTRATIVE_ACTION`	This is an unsuccessful code.
`BAD_AUTHENTICATION_METHOD`	This is an unsuccessful code.
`CLIENT_IDENTIFIER_NOT_VALID`	Deprecated. Must not be used for disconnect packets.
`CONNECTION_RATE_EXCEEDED`	Can only be used for the `ModifiableOutboundDisconnectPacket`.
`DISCONNECT_WITH_WILL_MESSAGE`	Can only be used for the `ModifiableInboundDisconnectPacket`.
`IMPLEMENTATION_SPECIFIC_ERROR`	This is an unsuccessful code.
`KEEP_ALIVE_TIMEOUT`	Can only be used for the `ModifiableOutboundDisconnectPacket`.
`MALFORMED_PACKET`	This is an unsuccessful code.
`MAXIMUM_CONNECT_TIME`	Can only be used for the `ModifiableOutboundDisconnectPacket`.
`MESSAGE_RATE_TOO_HIGH`	This is an unsuccessful code.
`NORMAL_DISCONNECTION`	This is a success code.
`NOT_AUTHORIZED`	Can only be used for the `ModifiableOutboundDisconnectPacket`.
`PACKET_TOO_LARGE`	This is an unsuccessful code.
`PAYLOAD_FORMAT_INVALID`	This is an unsuccessful code.
`PROTOCOL_ERROR`	This is an unsuccessful code.
`QOS_NOT_SUPPORTED`	Can only be used for the `ModifiableOutboundDisconnectPacket`.
`QUOTA_EXCEEDED`	This is an unsuccessful code.
`RECEIVE_MAXIMUM_EXCEEDED`	This is an unsuccessful code.
`RETAIN_NOT_SUPPORTED`	Can only be used for the `ModifiableOutboundDisconnectPacket`.
`SERVER_BUSY`	Can only be used for the `ModifiableOutboundDisconnectPacket`.
`SERVER_MOVED`	Can only be used for the `ModifiableOutboundDisconnectPacket`.
`SERVER_SHUTTING_DOWN`	Can only be used for the `ModifiableOutboundDisconnectPacket`.
`SESSION_TAKEN_OVER`	Can only be used for the `ModifiableOutboundDisconnectPacket`.
`SHARED_SUBSCRIPTION_NOT_SUPPORTED`	Can only be used for the `ModifiableOutboundDisconnectPacket`.
`SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED`	Can only be used for the `ModifiableOutboundDisconnectPacket`.
`TOPIC_ALIAS_INVALID`	This is an unsuccessful code.
`TOPIC_FILTER_INVALID`	Can only be used for the `ModifiableOutboundDisconnectPacket`.
`TOPIC_NAME_INVALID`	This is an unsuccessful code.
`UNSPECIFIED_ERROR`	This is an unsuccessful code.
`USE_ANOTHER_SERVER`	Can only be used for the `ModifiableOutboundDisconnectPacket`.
`WILDCARD_SUBSCRIPTION_NOT_SUPPORTED`	Can only be used for the `ModifiableOutboundDisconnectPacket`.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static DisconnectReasonCode`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static DisconnectReasonCode[]`	`values()`	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - NORMAL_DISCONNECTION
```
public static final DisconnectReasonCode NORMAL_DISCONNECTION
```
    This is a success code.
    
    Since:
    
    4.0.0, CE 2019.1
  - DISCONNECT_WITH_WILL_MESSAGE
```
public static final DisconnectReasonCode DISCONNECT_WITH_WILL_MESSAGE
```
    Can only be used for the ModifiableInboundDisconnectPacket.
    This is a success code.
    
    Since:
    
    4.0.0, CE 2019.1
  - UNSPECIFIED_ERROR
```
public static final DisconnectReasonCode UNSPECIFIED_ERROR
```
    This is an unsuccessful code.
    
    Since:
    
    4.0.0, CE 2019.1
  - MALFORMED_PACKET
```
public static final DisconnectReasonCode MALFORMED_PACKET
```
    This is an unsuccessful code.
    
    Since:
    
    4.0.0, CE 2019.1
  - PROTOCOL_ERROR
```
public static final DisconnectReasonCode PROTOCOL_ERROR
```
    This is an unsuccessful code.
    
    Since:
    
    4.0.0, CE 2019.1
  - IMPLEMENTATION_SPECIFIC_ERROR
```
public static final DisconnectReasonCode IMPLEMENTATION_SPECIFIC_ERROR
```
    This is an unsuccessful code.
    
    Since:
    
    4.0.0, CE 2019.1
  - NOT_AUTHORIZED
```
public static final DisconnectReasonCode NOT_AUTHORIZED
```
    Can only be used for the ModifiableOutboundDisconnectPacket.
    This is an unsuccessful code.
    
    Since:
    
    4.0.0, CE 2019.1
  - SERVER_BUSY
```
public static final DisconnectReasonCode SERVER_BUSY
```
    Can only be used for the ModifiableOutboundDisconnectPacket.
    This is an unsuccessful code.
    
    Since:
    
    4.0.0, CE 2019.1
  - SERVER_SHUTTING_DOWN
```
public static final DisconnectReasonCode SERVER_SHUTTING_DOWN
```
    Can only be used for the ModifiableOutboundDisconnectPacket.
    This is an unsuccessful code.
    
    Since:
    
    4.0.0, CE 2019.1
  - BAD_AUTHENTICATION_METHOD
```
public static final DisconnectReasonCode BAD_AUTHENTICATION_METHOD
```
    This is an unsuccessful code.
    
    Since:
    
    4.0.0, CE 2019.1
  - KEEP_ALIVE_TIMEOUT
```
public static final DisconnectReasonCode KEEP_ALIVE_TIMEOUT
```
    Can only be used for the ModifiableOutboundDisconnectPacket.
    This is an unsuccessful code.
    
    Since:
    
    4.0.0, CE 2019.1
  - SESSION_TAKEN_OVER
```
public static final DisconnectReasonCode SESSION_TAKEN_OVER
```
    Can only be used for the ModifiableOutboundDisconnectPacket.
    This is an unsuccessful code.
    
    Since:
    
    4.0.0, CE 2019.1
  - CLIENT_IDENTIFIER_NOT_VALID
```
@Deprecated
public static final DisconnectReasonCode CLIENT_IDENTIFIER_NOT_VALID
```
    Deprecated.
    Must not be used for disconnect packets.
    
    This is an unsuccessful code.
    
    Since:
    
    4.0.0, CE 2019.1
  - TOPIC_FILTER_INVALID
```
public static final DisconnectReasonCode TOPIC_FILTER_INVALID
```
    Can only be used for the ModifiableOutboundDisconnectPacket.
    This is an unsuccessful code.
    
    Since:
    
    4.0.0, CE 2019.1
  - TOPIC_NAME_INVALID
```
public static final DisconnectReasonCode TOPIC_NAME_INVALID
```
    This is an unsuccessful code.
    
    Since:
    
    4.0.0, CE 2019.1
  - RECEIVE_MAXIMUM_EXCEEDED
```
public static final DisconnectReasonCode RECEIVE_MAXIMUM_EXCEEDED
```
    This is an unsuccessful code.
    
    Since:
    
    4.0.0, CE 2019.1
  - TOPIC_ALIAS_INVALID
```
public static final DisconnectReasonCode TOPIC_ALIAS_INVALID
```
    This is an unsuccessful code.
    
    Since:
    
    4.0.0, CE 2019.1
  - PACKET_TOO_LARGE
```
public static final DisconnectReasonCode PACKET_TOO_LARGE
```
    This is an unsuccessful code.
    
    Since:
    
    4.0.0, CE 2019.1
  - MESSAGE_RATE_TOO_HIGH
```
public static final DisconnectReasonCode MESSAGE_RATE_TOO_HIGH
```
    This is an unsuccessful code.
    
    Since:
    
    4.0.0, CE 2019.1
  - QUOTA_EXCEEDED
```
public static final DisconnectReasonCode QUOTA_EXCEEDED
```
    This is an unsuccessful code.
    
    Since:
    
    4.0.0, CE 2019.1
  - ADMINISTRATIVE_ACTION
```
public static final DisconnectReasonCode ADMINISTRATIVE_ACTION
```
    This is an unsuccessful code.
    
    Since:
    
    4.0.0, CE 2019.1
  - PAYLOAD_FORMAT_INVALID
```
public static final DisconnectReasonCode PAYLOAD_FORMAT_INVALID
```
    This is an unsuccessful code.
    
    Since:
    
    4.0.0, CE 2019.1
  - RETAIN_NOT_SUPPORTED
```
public static final DisconnectReasonCode RETAIN_NOT_SUPPORTED
```
    Can only be used for the ModifiableOutboundDisconnectPacket.
    This is an unsuccessful code.
    
    Since:
    
    4.0.0, CE 2019.1
  - QOS_NOT_SUPPORTED
```
public static final DisconnectReasonCode QOS_NOT_SUPPORTED
```
    Can only be used for the ModifiableOutboundDisconnectPacket.
    This is an unsuccessful code.
    
    Since:
    
    4.0.0, CE 2019.1
  - USE_ANOTHER_SERVER
```
public static final DisconnectReasonCode USE_ANOTHER_SERVER
```
    Can only be used for the ModifiableOutboundDisconnectPacket.
    This is an unsuccessful code.
    
    Since:
    
    4.0.0, CE 2019.1
  - SERVER_MOVED
```
public static final DisconnectReasonCode SERVER_MOVED
```
    Can only be used for the ModifiableOutboundDisconnectPacket.
    This is an unsuccessful code.
    
    Since:
    
    4.0.0, CE 2019.1
  - SHARED_SUBSCRIPTION_NOT_SUPPORTED
```
public static final DisconnectReasonCode SHARED_SUBSCRIPTION_NOT_SUPPORTED
```
    Can only be used for the ModifiableOutboundDisconnectPacket.
    This is an unsuccessful code.
    
    Since:
    
    4.0.0, CE 2019.1
  - CONNECTION_RATE_EXCEEDED
```
public static final DisconnectReasonCode CONNECTION_RATE_EXCEEDED
```
    Can only be used for the ModifiableOutboundDisconnectPacket.
    This is an unsuccessful code.
    
    Since:
    
    4.0.0, CE 2019.1
  - MAXIMUM_CONNECT_TIME
```
public static final DisconnectReasonCode MAXIMUM_CONNECT_TIME
```
    Can only be used for the ModifiableOutboundDisconnectPacket.
    This is an unsuccessful code.
    
    Since:
    
    4.0.0, CE 2019.1
  - SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED
```
public static final DisconnectReasonCode SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED
```
    Can only be used for the ModifiableOutboundDisconnectPacket.
    This is an unsuccessful code.
    
    Since:
    
    4.0.0, CE 2019.1
  - WILDCARD_SUBSCRIPTION_NOT_SUPPORTED
```
public static final DisconnectReasonCode WILDCARD_SUBSCRIPTION_NOT_SUPPORTED
```
    Can only be used for the ModifiableOutboundDisconnectPacket.
    This is an unsuccessful code.
    
    Since:
    
    4.0.0, CE 2019.1
- Method Detail
  - values
```
public static DisconnectReasonCode[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
    for (DisconnectReasonCode c : DisconnectReasonCode.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static DisconnectReasonCode valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null

Enum DisconnectReasonCode

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

NORMAL_DISCONNECTION

DISCONNECT_WITH_WILL_MESSAGE

UNSPECIFIED_ERROR

MALFORMED_PACKET

PROTOCOL_ERROR

IMPLEMENTATION_SPECIFIC_ERROR

NOT_AUTHORIZED

SERVER_BUSY

SERVER_SHUTTING_DOWN

BAD_AUTHENTICATION_METHOD

KEEP_ALIVE_TIMEOUT

SESSION_TAKEN_OVER

CLIENT_IDENTIFIER_NOT_VALID

TOPIC_FILTER_INVALID

TOPIC_NAME_INVALID

RECEIVE_MAXIMUM_EXCEEDED

TOPIC_ALIAS_INVALID

PACKET_TOO_LARGE

MESSAGE_RATE_TOO_HIGH

QUOTA_EXCEEDED

ADMINISTRATIVE_ACTION

PAYLOAD_FORMAT_INVALID

RETAIN_NOT_SUPPORTED

QOS_NOT_SUPPORTED

USE_ANOTHER_SERVER

SERVER_MOVED

SHARED_SUBSCRIPTION_NOT_SUPPORTED

CONNECTION_RATE_EXCEEDED

MAXIMUM_CONNECT_TIME

SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED

WILDCARD_SUBSCRIPTION_NOT_SUPPORTED

Method Detail

values

valueOf