Package com.hivemq.extension.sdk.api.packets.subscribe

Enum SubackReasonCode

java.lang.Object

java.lang.Enum<SubackReasonCode>

com.hivemq.extension.sdk.api.packets.subscribe.SubackReasonCode

All Implemented Interfaces:

Serializable, Comparable<SubackReasonCode>

public enum SubackReasonCode
extends Enum<SubackReasonCode>

The SUBACK reason codes for MQTT 5.

MQTT 3.1 and MQTT 3.1.1 supports only:

• GRANTED_QOS_0
• GRANTED_QOS_1
• GRANTED_QOS_2
• UNSPECIFIED_ERROR (in the MQTT 3 specification known as FAILURE)

Since:

4.0.0, CE 2019.1

Enum Constant Summary

Enum Constants

Enum Constant	Description
GRANTED_QOS_0	This is a success code.
GRANTED_QOS_1	This is a success code.
GRANTED_QOS_2	This is a success code.
IMPLEMENTATION_SPECIFIC_ERROR	This is an unsuccessful code.
NOT_AUTHORIZED	This is an unsuccessful code.
PACKET_IDENTIFIER_IN_USE	This is an unsuccessful code.
QUOTA_EXCEEDED	This is an unsuccessful code.
SHARED_SUBSCRIPTION_NOT_SUPPORTED	This is an unsuccessful code.
SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED	This is an unsuccessful code.
TOPIC_FILTER_INVALID	This is an unsuccessful code.
UNSPECIFIED_ERROR	This is an unsuccessful code.
WILDCARD_SUBSCRIPTION_NOT_SUPPORTED	This is an unsuccessful code.

Method Summary

Modifier and Type	Method	Description
static SubackReasonCode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SubackReasonCode[]	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

GRANTED_QOS_0

public static final SubackReasonCode GRANTED_QOS_0

This is a success code.

Since:

4.0.0, CE 2019.1

GRANTED_QOS_1

public static final SubackReasonCode GRANTED_QOS_1

This is a success code.

Since:

4.0.0, CE 2019.1

GRANTED_QOS_2

public static final SubackReasonCode GRANTED_QOS_2

This is a success code.

Since:

4.0.0, CE 2019.1

UNSPECIFIED_ERROR

public static final SubackReasonCode UNSPECIFIED_ERROR

This is an unsuccessful code.

For an MQTT 3 SUBACK this translates to the return code FAILURE.

Since:

4.0.0, CE 2019.1

IMPLEMENTATION_SPECIFIC_ERROR

public static final SubackReasonCode IMPLEMENTATION_SPECIFIC_ERROR

This is an unsuccessful code.

For an MQTT 3 SUBACK this translates to the return code FAILURE.

Since:

4.0.0, CE 2019.1

NOT_AUTHORIZED

public static final SubackReasonCode NOT_AUTHORIZED

This is an unsuccessful code.

For an MQTT 3 SUBACK this translates to the return code FAILURE.

Since:

4.0.0, CE 2019.1

TOPIC_FILTER_INVALID

public static final SubackReasonCode TOPIC_FILTER_INVALID

This is an unsuccessful code.

For an MQTT 3 SUBACK this translates to the return code FAILURE.

Since:

4.0.0, CE 2019.1

PACKET_IDENTIFIER_IN_USE

public static final SubackReasonCode PACKET_IDENTIFIER_IN_USE

This is an unsuccessful code.

For an MQTT 3 SUBACK this translates to the return code FAILURE.

Since:

4.0.0, CE 2019.1

QUOTA_EXCEEDED

public static final SubackReasonCode QUOTA_EXCEEDED

This is an unsuccessful code.

For an MQTT 3 SUBACK this translates to the return code FAILURE.

Since:

4.0.0, CE 2019.1

SHARED_SUBSCRIPTION_NOT_SUPPORTED

public static final SubackReasonCode SHARED_SUBSCRIPTION_NOT_SUPPORTED

This is an unsuccessful code.

For an MQTT 3 SUBACK this translates to the return code FAILURE.

Since:

4.0.0, CE 2019.1

SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED

public static final SubackReasonCode SUBSCRIPTION_IDENTIFIERS_NOT_SUPPORTED

This is an unsuccessful code.

For an MQTT 3 SUBACK this translates to the return code FAILURE.

Since:

4.0.0, CE 2019.1

WILDCARD_SUBSCRIPTION_NOT_SUPPORTED

public static final SubackReasonCode WILDCARD_SUBSCRIPTION_NOT_SUPPORTED

This is an unsuccessful code.

For an MQTT 3 SUBACK this translates to the return code FAILURE.

Since:

4.0.0, CE 2019.1

Method Detail

values

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

Returns:

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

valueOf

public static SubackReasonCode 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