com.hivemq.client.mqtt.mqtt5.message.publish.pubcomp

Enum Mqtt5PubCompReasonCode

java.lang.Object

java.lang.Enum<Mqtt5PubCompReasonCode>

com.hivemq.client.mqtt.mqtt5.message.publish.pubcomp.Mqtt5PubCompReasonCode

All Implemented Interfaces:

Mqtt5ReasonCode, Serializable, Comparable<Mqtt5PubCompReasonCode>

public enum Mqtt5PubCompReasonCode
extends Enum<Mqtt5PubCompReasonCode>
implements Mqtt5ReasonCode

Reason Code of an MQTT 5 PubComp message.

Since:

1.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
PACKET_IDENTIFIER_NOT_FOUND The packet identifier is not known.
SUCCESS Packet identifier released.

Method Summary

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

canBeSentByServer, canBeSetByUser, isError

Enum Constant Detail

SUCCESS

public static final Mqtt5PubCompReasonCode SUCCESS

Packet identifier released. Publication of the QoS 2 message is complete.

PACKET_IDENTIFIER_NOT_FOUND

public static final Mqtt5PubCompReasonCode PACKET_IDENTIFIER_NOT_FOUND

The packet identifier is not known. This is not an error during recovery, but at other times indicates a mismatch between the session state on the client and server.

Method Detail

values

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

Returns:

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

valueOf

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

getCode

public int getCode()

Specified by:

getCode in interface Mqtt5ReasonCode

Returns:

the byte code of this Reason Code.

fromCode

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

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

Parameters:

code - the byte code.

Returns:

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

canBeSentByClient

public boolean canBeSentByClient()

Specified by:

canBeSentByClient in interface Mqtt5ReasonCode

Returns:

whether this Reason Code can be sent by the client according to the MQTT 5 specification.