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

Enum UnsubAckPacket.UnsubAckReasonCode

java.lang.Object

java.lang.Enum<UnsubAckPacket.UnsubAckReasonCode>

software.amazon.awssdk.crt.mqtt5.packets.UnsubAckPacket.UnsubAckReasonCode

All Implemented Interfaces:

Serializable, Comparable<UnsubAckPacket.UnsubAckReasonCode>

Enclosing class:

UnsubAckPacket

public static enum UnsubAckPacket.UnsubAckReasonCode
extends Enum<UnsubAckPacket.UnsubAckReasonCode>

Reason codes inside UnsubAckPacket payloads that specify the results for each topic filter in the associated UnsubscribePacket. Enum values match MQTT5 spec encoding values.

Enum Constant Summary

Enum Constants

Enum Constant	Description
IMPLEMENTATION_SPECIFIC_ERROR	Returned when the topic filter was valid but the server does not accept an unsubscribe for it.
NO_SUBSCRIPTION_EXISTED	Returned when the topic filter did not match one of the client's existing topic filters on the server.
NOT_AUTHORIZED	Returned when the client was not authorized to unsubscribe from that topic filter on the server.
PACKET_IDENTIFIER_IN_USE	Returned when the packet identifier was already in use on the server.
SUCCESS	Returned when the unsubscribe was successful and the client is no longer subscribed to the topic filter on the server.
TOPIC_FILTER_INVALID	Returned when the topic filter was correctly formed but is not allowed for the client on the server.
UNSPECIFIED_ERROR	Returned when the unsubscribe of the topic filter was not accepted and the server does not want to specify a reason or none of the other reason codes apply.

Method Summary

Modifier and Type	Method	Description
static UnsubAckPacket.UnsubAckReasonCode	getEnumValueFromInteger(int value)	Creates a Java UnsubAckReasonCode enum value from a native integer value.
int	getValue()
static UnsubAckPacket.UnsubAckReasonCode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static UnsubAckPacket.UnsubAckReasonCode[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SUCCESS

public static final UnsubAckPacket.UnsubAckReasonCode SUCCESS

Returned when the unsubscribe was successful and the client is no longer subscribed to the topic filter on the server.

NO_SUBSCRIPTION_EXISTED

public static final UnsubAckPacket.UnsubAckReasonCode NO_SUBSCRIPTION_EXISTED

Returned when the topic filter did not match one of the client's existing topic filters on the server.

UNSPECIFIED_ERROR

public static final UnsubAckPacket.UnsubAckReasonCode UNSPECIFIED_ERROR

Returned when the unsubscribe of the topic filter was not accepted and the server does not want to specify a reason or none of the other reason codes apply.

IMPLEMENTATION_SPECIFIC_ERROR

public static final UnsubAckPacket.UnsubAckReasonCode IMPLEMENTATION_SPECIFIC_ERROR

Returned when the topic filter was valid but the server does not accept an unsubscribe for it.

NOT_AUTHORIZED

public static final UnsubAckPacket.UnsubAckReasonCode NOT_AUTHORIZED

Returned when the client was not authorized to unsubscribe from that topic filter on the server.

TOPIC_FILTER_INVALID

public static final UnsubAckPacket.UnsubAckReasonCode TOPIC_FILTER_INVALID

Returned when the topic filter was correctly formed but is not allowed for the client on the server.

PACKET_IDENTIFIER_IN_USE

public static final UnsubAckPacket.UnsubAckReasonCode PACKET_IDENTIFIER_IN_USE

Returned when the packet identifier was already in use on the server.

Method Detail

values

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

Returns:

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

valueOf

public static UnsubAckPacket.UnsubAckReasonCode 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

getValue

public int getValue()

Returns:

The native enum integer value associated with this Java enum value

getEnumValueFromInteger

public static UnsubAckPacket.UnsubAckReasonCode getEnumValueFromInteger(int value)

Creates a Java UnsubAckReasonCode enum value from a native integer value.

Parameters:

value - native integer value for UnsubAckReasonCode

Returns:

a new UnsubAckReasonCode value