com.mulesoft.connectors.mqtt3.api

Enum QoS

java.lang.Object

java.lang.Enum<QoS>

com.mulesoft.connectors.mqtt3.api.QoS

All Implemented Interfaces:

Serializable, Comparable<QoS>

public enum QoS
extends Enum<QoS>

Declares the quality of service to be used to publish or receive mqtt messages. There are three quality of service levels:

• AT_MOST_ONCE
• AT_LEAST_ONCE
• EXACTLY_ONCE

Since:

1.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
AT_LEAST_ONCE The message will be delivered at least one time.
AT_MOST_ONCE Fire and forget.
EXACTLY_ONCE Guarantees that the message will be delivered exactly one time.

Method Summary

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

AT_MOST_ONCE

public static final QoS AT_MOST_ONCE

Fire and forget. No guarantees that the message will be delivered correctly.

AT_LEAST_ONCE

public static final QoS AT_LEAST_ONCE

The message will be delivered at least one time. The message could be delivered more than once.

EXACTLY_ONCE

public static final QoS EXACTLY_ONCE

Guarantees that the message will be delivered exactly one time.

Method Detail

values

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

Returns:

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

valueOf

public static QoS 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 quality of service level's numeric value.