Package br.com.thiaguten.rx.mqtt.api

Enum RxMqttQoS

java.lang.Object

java.lang.Enum<RxMqttQoS>

br.com.thiaguten.rx.mqtt.api.RxMqttQoS

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<RxMqttQoS>

public enum RxMqttQoS
extends java.lang.Enum<RxMqttQoS>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AT_LEAST_ONCE	RxMqttQoS 1 - At least Once Delivery: For this level of service, the MQTT client or the server would attempt to deliver the message at-least once.
AT_MOST_ONCE	RxMqttQoS 0 - At most once delivery: With this setting, messages are delivered according to the best effort of the underlying network.
EXACTLY_ONCE	RxMqttQoS 2 - Exactly once delivery: This is the highest level of Quality of Service.
FAILURE

Method Summary

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

RxMqttQoS 0 - At most once delivery: With this setting, messages are delivered according to the best effort of the underlying network. A response is not expected and no retry semantics are defined in the protocol. This is the least level of Quality of Service and from a performance perspective, adds value as it’s the fastest way to send a message using MQTT. A RxMqttQoS 0 message can get lost if the client unexpectedly disconnects or if the server fails.

AT_LEAST_ONCE

public static final RxMqttQoS AT_LEAST_ONCE

RxMqttQoS 1 - At least Once Delivery: For this level of service, the MQTT client or the server would attempt to deliver the message at-least once. But there can be a duplicate message.

EXACTLY_ONCE

public static final RxMqttQoS EXACTLY_ONCE

RxMqttQoS 2 - Exactly once delivery: This is the highest level of Quality of Service. Additional protocol flows ensure that duplicate messages are not delivered to the receiving application. The message is delivered once and only once when RxMqttQoS 2 is used.

FAILURE

public static final RxMqttQoS FAILURE

Method Detail

values

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

Returns:

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

valueOf

public static RxMqttQoS valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

value

public int value()

valueOf

public static RxMqttQoS valueOf(int value)

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:

value - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null