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

Enum PubAckPacket.PubAckReasonCode

java.lang.Object

java.lang.Enum<PubAckPacket.PubAckReasonCode>

software.amazon.awssdk.crt.mqtt5.packets.PubAckPacket.PubAckReasonCode

All Implemented Interfaces:

Serializable, Comparable<PubAckPacket.PubAckReasonCode>

Enclosing class:

PubAckPacket

public static enum PubAckPacket.PubAckReasonCode
extends Enum<PubAckPacket.PubAckReasonCode>

Reason code inside PubAckPackets that indicates the result of the associated PUBLISH request. Enum values match MQTT5 spec encoding values.

Enum Constant Summary

Enum Constants

Enum Constant	Description
IMPLEMENTATION_SPECIFIC_ERROR	Returned when the (QoS 1) publish was valid but the receiver was not willing to accept it.
NO_MATCHING_SUBSCRIBERS	Returned when the (QoS 1) publish was accepted but there were no matching subscribers.
NOT_AUTHORIZED	Returned when the (QoS 1) publish was not authorized by the receiver.
PACKET_IDENTIFIER_IN_USE	Returned when the packet identifier used in the associated PUBLISH was already in use.
PAYLOAD_FORMAT_INVALID	Returned when the PUBLISH packet's payload format did not match its payload format indicator property.
QUOTA_EXCEEDED	Returned when the associated PUBLISH failed because an internal quota on the recipient was exceeded.
SUCCESS	Returned when the (QoS 1) publish was accepted by the recipient.
TOPIC_NAME_INVALID	Returned when the topic name was valid but the receiver was not willing to accept it.
UNSPECIFIED_ERROR	Returned when the (QoS 1) publish was not accepted and the receiver does not want to specify a reason or none of the other reason codes apply.

Method Summary

Modifier and Type	Method	Description
static PubAckPacket.PubAckReasonCode	getEnumValueFromInteger(int value)	Creates a Java PubAckReasonCode enum value from a native integer value.
int	getValue()
static PubAckPacket.PubAckReasonCode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static PubAckPacket.PubAckReasonCode[]	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 PubAckPacket.PubAckReasonCode SUCCESS

Returned when the (QoS 1) publish was accepted by the recipient. May be sent by the client or the server.

NO_MATCHING_SUBSCRIBERS

public static final PubAckPacket.PubAckReasonCode NO_MATCHING_SUBSCRIBERS

Returned when the (QoS 1) publish was accepted but there were no matching subscribers. May only be sent by the server.

UNSPECIFIED_ERROR

public static final PubAckPacket.PubAckReasonCode UNSPECIFIED_ERROR

Returned when the (QoS 1) publish was not accepted and the receiver does not want to specify a reason or none of the other reason codes apply. May be sent by the client or the server.

IMPLEMENTATION_SPECIFIC_ERROR

public static final PubAckPacket.PubAckReasonCode IMPLEMENTATION_SPECIFIC_ERROR

Returned when the (QoS 1) publish was valid but the receiver was not willing to accept it. May be sent by the client or the server.

NOT_AUTHORIZED

public static final PubAckPacket.PubAckReasonCode NOT_AUTHORIZED

Returned when the (QoS 1) publish was not authorized by the receiver. May be sent by the client or the server.

TOPIC_NAME_INVALID

public static final PubAckPacket.PubAckReasonCode TOPIC_NAME_INVALID

Returned when the topic name was valid but the receiver was not willing to accept it. May be sent by the client or the server.

PACKET_IDENTIFIER_IN_USE

public static final PubAckPacket.PubAckReasonCode PACKET_IDENTIFIER_IN_USE

Returned when the packet identifier used in the associated PUBLISH was already in use. This can indicate a mismatch in the session state between client and server. May be sent by the client or the server.

QUOTA_EXCEEDED

public static final PubAckPacket.PubAckReasonCode QUOTA_EXCEEDED

Returned when the associated PUBLISH failed because an internal quota on the recipient was exceeded. May be sent by the client or the server.

PAYLOAD_FORMAT_INVALID

public static final PubAckPacket.PubAckReasonCode PAYLOAD_FORMAT_INVALID

Returned when the PUBLISH packet's payload format did not match its payload format indicator property. May be sent by the client or the server.

Method Detail

values

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

Returns:

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

valueOf

public static PubAckPacket.PubAckReasonCode 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 PubAckPacket.PubAckReasonCode getEnumValueFromInteger(int value)

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

Parameters:

value - native integer value for PubAckReasonCode

Returns:

a new PubAckReasonCode value