Package software.amazon.awssdk.crt.mqtt5

Enum TopicAliasingOptions.OutboundTopicAliasBehaviorType

java.lang.Object

java.lang.Enum<TopicAliasingOptions.OutboundTopicAliasBehaviorType>

software.amazon.awssdk.crt.mqtt5.TopicAliasingOptions.OutboundTopicAliasBehaviorType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TopicAliasingOptions.OutboundTopicAliasBehaviorType>

Enclosing class:

TopicAliasingOptions

public static enum TopicAliasingOptions.OutboundTopicAliasBehaviorType
extends java.lang.Enum<TopicAliasingOptions.OutboundTopicAliasBehaviorType>

An enumeration that controls how the client applies topic aliasing to outbound publish packets. Topic alias behavior is described in MQTT5 Topic Aliasing

Enum Constant Summary

Enum Constants

Enum Constant	Description
Default	Maps to Disabled.
Disabled	Completely disable outbound topic aliasing.
LRU	(Recommended) The client will ignore any user-specified topic aliasing and instead use an LRU cache to drive alias usage.
Manual	Outbound aliasing is the user's responsibility.

Method Summary

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

Maps to Disabled. This keeps the client from being broken (by default) if the broker topic aliasing implementation has a problem.

Manual

public static final TopicAliasingOptions.OutboundTopicAliasBehaviorType Manual

Outbound aliasing is the user's responsibility. Client will cache and use previously-established aliases if they fall within the negotiated limits of the connection. The user must still always submit a full topic in their publishes because disconnections disrupt topic alias mappings unpredictably. The client will properly use a requested alias when the most-recently-seen binding for a topic alias value matches the alias and topic in the publish packet.

LRU

public static final TopicAliasingOptions.OutboundTopicAliasBehaviorType LRU

(Recommended) The client will ignore any user-specified topic aliasing and instead use an LRU cache to drive alias usage.

Disabled

public static final TopicAliasingOptions.OutboundTopicAliasBehaviorType Disabled

Completely disable outbound topic aliasing.

Method Detail

values

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

Returns:

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

valueOf

public static TopicAliasingOptions.OutboundTopicAliasBehaviorType 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

getValue

public int getValue()

Returns:

The native enum integer value associated with this Java enum value

getEnumValueFromInteger

public static TopicAliasingOptions.OutboundTopicAliasBehaviorType getEnumValueFromInteger(int value)

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

Parameters:

value - native integer value for the OutboundTopicAliasBehaviorType value

Returns:

a new OutboundTopicAliasBehaviorType value