com.hivemq.client.mqtt.mqtt5.message.connect.connack

Enum Mqtt5ConnAckReasonCode

java.lang.Object

java.lang.Enum<Mqtt5ConnAckReasonCode>

com.hivemq.client.mqtt.mqtt5.message.connect.connack.Mqtt5ConnAckReasonCode

All Implemented Interfaces:

Mqtt5ReasonCode, java.io.Serializable, java.lang.Comparable<Mqtt5ConnAckReasonCode>

public enum Mqtt5ConnAckReasonCode
extends java.lang.Enum<Mqtt5ConnAckReasonCode>
implements Mqtt5ReasonCode

Reason Code of a MQTT 5 ConnAck message.

Since:

1.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
BAD_AUTHENTICATION_METHOD
BAD_USER_NAME_OR_PASSWORD
BANNED
CLIENT_IDENTIFIER_NOT_VALID
CONNECTION_RATE_EXCEEDED
IMPLEMENTATION_SPECIFIC_ERROR
MALFORMED_PACKET
NOT_AUTHORIZED
PACKET_TOO_LARGE
PAYLOAD_FORMAT_INVALID
PROTOCOL_ERROR
QOS_NOT_SUPPORTED
QUOTA_EXCEEDED
RETAIN_NOT_SUPPORTED
SERVER_BUSY
SERVER_MOVED
SERVER_UNAVAILABLE
SUCCESS
TOPIC_NAME_INVALID
UNSPECIFIED_ERROR
UNSUPPORTED_PROTOCOL_VERSION
USE_ANOTHER_SERVER

Method Summary

Modifier and Type	Method and Description
static @Nullable Mqtt5ConnAckReasonCode	fromCode(int code) Returns the CONNACK Reason Code belonging to the given byte code.
int	getCode()
static Mqtt5ConnAckReasonCode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Mqtt5ConnAckReasonCode[]	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

Methods inherited from interface com.hivemq.client.mqtt.mqtt5.message.Mqtt5ReasonCode

canBeSentByClient, canBeSentByServer, canBeSetByUser, isError

Enum Constant Detail

SUCCESS

public static final Mqtt5ConnAckReasonCode SUCCESS

UNSPECIFIED_ERROR

public static final Mqtt5ConnAckReasonCode UNSPECIFIED_ERROR

MALFORMED_PACKET

public static final Mqtt5ConnAckReasonCode MALFORMED_PACKET

PROTOCOL_ERROR

public static final Mqtt5ConnAckReasonCode PROTOCOL_ERROR

IMPLEMENTATION_SPECIFIC_ERROR

public static final Mqtt5ConnAckReasonCode IMPLEMENTATION_SPECIFIC_ERROR

UNSUPPORTED_PROTOCOL_VERSION

public static final Mqtt5ConnAckReasonCode UNSUPPORTED_PROTOCOL_VERSION

CLIENT_IDENTIFIER_NOT_VALID

public static final Mqtt5ConnAckReasonCode CLIENT_IDENTIFIER_NOT_VALID

BAD_USER_NAME_OR_PASSWORD

public static final Mqtt5ConnAckReasonCode BAD_USER_NAME_OR_PASSWORD

NOT_AUTHORIZED

public static final Mqtt5ConnAckReasonCode NOT_AUTHORIZED

SERVER_UNAVAILABLE

public static final Mqtt5ConnAckReasonCode SERVER_UNAVAILABLE

SERVER_BUSY

public static final Mqtt5ConnAckReasonCode SERVER_BUSY

BANNED

public static final Mqtt5ConnAckReasonCode BANNED

BAD_AUTHENTICATION_METHOD

public static final Mqtt5ConnAckReasonCode BAD_AUTHENTICATION_METHOD

TOPIC_NAME_INVALID

public static final Mqtt5ConnAckReasonCode TOPIC_NAME_INVALID

PACKET_TOO_LARGE

public static final Mqtt5ConnAckReasonCode PACKET_TOO_LARGE

QUOTA_EXCEEDED

public static final Mqtt5ConnAckReasonCode QUOTA_EXCEEDED

PAYLOAD_FORMAT_INVALID

public static final Mqtt5ConnAckReasonCode PAYLOAD_FORMAT_INVALID

RETAIN_NOT_SUPPORTED

public static final Mqtt5ConnAckReasonCode RETAIN_NOT_SUPPORTED

QOS_NOT_SUPPORTED

public static final Mqtt5ConnAckReasonCode QOS_NOT_SUPPORTED

USE_ANOTHER_SERVER

public static final Mqtt5ConnAckReasonCode USE_ANOTHER_SERVER

SERVER_MOVED

public static final Mqtt5ConnAckReasonCode SERVER_MOVED

CONNECTION_RATE_EXCEEDED

public static final Mqtt5ConnAckReasonCode CONNECTION_RATE_EXCEEDED

Method Detail

values

public static Mqtt5ConnAckReasonCode[] 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 (Mqtt5ConnAckReasonCode c : Mqtt5ConnAckReasonCode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Mqtt5ConnAckReasonCode valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getCode

public int getCode()

Specified by:

getCode in interface Mqtt5ReasonCode

Returns:

the byte code of this Reason Code.

fromCode

@Nullable
public static @Nullable Mqtt5ConnAckReasonCode fromCode(int code)

Returns the CONNACK Reason Code belonging to the given byte code.

Parameters:

code - the byte code.

Returns:

the CONNACK Reason Code belonging to the given byte code or null if the byte code is not a valid CONNACK Reason Code code.