Package software.amazon.awssdk.crt.mqtt5

Enum Mqtt5ClientOptions.ClientOfflineQueueBehavior

java.lang.Object

java.lang.Enum<Mqtt5ClientOptions.ClientOfflineQueueBehavior>

software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.ClientOfflineQueueBehavior

All Implemented Interfaces:

Serializable, Comparable<Mqtt5ClientOptions.ClientOfflineQueueBehavior>

Enclosing class:

Mqtt5ClientOptions

public static enum Mqtt5ClientOptions.ClientOfflineQueueBehavior
extends Enum<Mqtt5ClientOptions.ClientOfflineQueueBehavior>

Controls how disconnects affect the queued and in-progress operations tracked by the client. Also controls how operations are handled while the client is not connected. In particular, if the client is not connected, then any operation that would be failed on disconnect (according to these rules) will be rejected.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DEFAULT	Default client operation queue behavior.
FAIL_ALL_ON_DISCONNECT	All operations that are not complete at the time of disconnection are failed, except operations that the MQTT5 spec requires to be retransmitted (un-acked QoS1+ publishes).
FAIL_NON_QOS1_PUBLISH_ON_DISCONNECT	Re-queues QoS 1+ publishes on disconnect; un-acked publishes go to the front while unprocessed publishes stay in place.
FAIL_QOS0_PUBLISH_ON_DISCONNECT	QoS 0 publishes that are not complete at the time of disconnection are failed.

Method Summary

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

DEFAULT

public static final Mqtt5ClientOptions.ClientOfflineQueueBehavior DEFAULT

Default client operation queue behavior. Maps to FAIL_QOS0_PUBLISH_ON_DISCONNECT.

FAIL_NON_QOS1_PUBLISH_ON_DISCONNECT

public static final Mqtt5ClientOptions.ClientOfflineQueueBehavior FAIL_NON_QOS1_PUBLISH_ON_DISCONNECT

Re-queues QoS 1+ publishes on disconnect; un-acked publishes go to the front while unprocessed publishes stay in place. All other operations (QoS 0 publishes, subscribe, unsubscribe) are failed.

FAIL_QOS0_PUBLISH_ON_DISCONNECT

public static final Mqtt5ClientOptions.ClientOfflineQueueBehavior FAIL_QOS0_PUBLISH_ON_DISCONNECT

QoS 0 publishes that are not complete at the time of disconnection are failed. Un-acked QoS 1+ publishes are re-queued at the head of the line for immediate retransmission on a session resumption. All other operations are requeued in original order behind any retransmissions.

FAIL_ALL_ON_DISCONNECT

public static final Mqtt5ClientOptions.ClientOfflineQueueBehavior FAIL_ALL_ON_DISCONNECT

All operations that are not complete at the time of disconnection are failed, except operations that the MQTT5 spec requires to be retransmitted (un-acked QoS1+ publishes).

Method Detail

values

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

Returns:

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

valueOf

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

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

Parameters:

value - native integer value for the client operation queue behavior type

Returns:

a new ClientOfflineQueueBehavior value