Package com.hivemq.client.mqtt.mqtt5.message.publish.puback

Enum Class Mqtt5PubAckReasonCode

java.lang.Object
java.lang.Enum<Mqtt5PubAckReasonCode>
com.hivemq.client.mqtt.mqtt5.message.publish.puback.Mqtt5PubAckReasonCode
All Implemented Interfaces:
Mqtt5ReasonCode, Serializable, Comparable<Mqtt5PubAckReasonCode>, Constable
public enum Mqtt5PubAckReasonCode extends Enum<Mqtt5PubAckReasonCode> implements Mqtt5ReasonCode
Reason Code of an MQTT 5 PubAck message.
Since:
1.0

  • Enum Constant Details

    • SUCCESS

      public static final Mqtt5PubAckReasonCode SUCCESS
      The message is accepted. Publication of the QoS 1 message proceeds.

    • NO_MATCHING_SUBSCRIBERS

      public static final Mqtt5PubAckReasonCode NO_MATCHING_SUBSCRIBERS
      The message is accepted but there are no subscribers.

    • UNSPECIFIED_ERROR

      public static final Mqtt5PubAckReasonCode UNSPECIFIED_ERROR
      The receiver either does not want to reveal the reason for the failure or none of the other reason codes apply.

    • IMPLEMENTATION_SPECIFIC_ERROR

      public static final Mqtt5PubAckReasonCode IMPLEMENTATION_SPECIFIC_ERROR
      The PUBLISH packet is valid but is not accepted by the receiver.

    • NOT_AUTHORIZED

      public static final Mqtt5PubAckReasonCode NOT_AUTHORIZED
      The sender is not authorized to make the publication.

    • TOPIC_NAME_INVALID

      public static final Mqtt5PubAckReasonCode TOPIC_NAME_INVALID
      The topic name is formed correctly but is not accepted by the receiver.

    • PACKET_IDENTIFIER_IN_USE

      public static final Mqtt5PubAckReasonCode PACKET_IDENTIFIER_IN_USE
      The packet identifier is already in use. This might indicate a mismatch between the session state on the client and server.

    • QUOTA_EXCEEDED

      public static final Mqtt5PubAckReasonCode QUOTA_EXCEEDED
      An implementation or administrative imposed limit has been exceeded.

    • PAYLOAD_FORMAT_INVALID

      public static final Mqtt5PubAckReasonCode PAYLOAD_FORMAT_INVALID
      The payload does not match the specified payload format indicator.

  • Method Details

    • values

      public static Mqtt5PubAckReasonCode[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static Mqtt5PubAckReasonCode valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class 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 Mqtt5PubAckReasonCode fromCode(int code)
      Returns the PubAck Reason Code belonging to the given byte code.
      Parameters:
      code - the byte code.
      Returns:
      the PubAck Reason Code belonging to the given byte code or null if the byte code is not a valid PubAck 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.

    • canBeSetByUser

      public boolean canBeSetByUser()
      Specified by:
      canBeSetByUser in interface Mqtt5ReasonCode
      Returns:
      whether this Reason Code can be set by the user.