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 ConstantsEnum ConstantDescriptionDefault client operation queue behavior.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).Re-queues QoS 1+ publishes on disconnect; un-acked publishes go to the front while unprocessed publishes stay in place.QoS 0 publishes that are not complete at the time of disconnection are failed. -
Method Summary
Modifier and TypeMethodDescriptiongetEnumValueFromInteger
(int value) Creates a Java ClientOfflineQueueBehavior enum value from a native integer value.int
getValue()
Returns the enum constant of this type with the specified name.values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
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_DISCONNECTRe-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
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
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 Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
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 nameNullPointerException
- if the argument is null
-
getValue
public int getValue()- Returns:
- The native enum integer value associated with this Java enum value
-
getEnumValueFromInteger
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
-