Package software.amazon.awssdk.crt.mqtt5

Enum TopicAliasingOptions.InboundTopicAliasBehaviorType

java.lang.Object

java.lang.Enum<TopicAliasingOptions.InboundTopicAliasBehaviorType>

software.amazon.awssdk.crt.mqtt5.TopicAliasingOptions.InboundTopicAliasBehaviorType

All Implemented Interfaces:

Serializable, Comparable<TopicAliasingOptions.InboundTopicAliasBehaviorType>

Enclosing class:

TopicAliasingOptions

public static enum TopicAliasingOptions.InboundTopicAliasBehaviorType
extends Enum<TopicAliasingOptions.InboundTopicAliasBehaviorType>

An enumeration that controls whether or not the client allows the broker to send publishes that use topic aliasing. Topic alias behavior is described in https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901113

Enum Constant Summary

Enum Constants

Enum Constant	Description
Default	Maps to Disabled.
Disabled	Forbid the server from sending PUBLISH packets to the client that use topic aliasing
Enabled	Allow the server to send PUBLISH packets to the client that use topic aliasing

Method Summary

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

Default

public static final TopicAliasingOptions.InboundTopicAliasBehaviorType Default

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

Enabled

public static final TopicAliasingOptions.InboundTopicAliasBehaviorType Enabled

Allow the server to send PUBLISH packets to the client that use topic aliasing

Disabled

public static final TopicAliasingOptions.InboundTopicAliasBehaviorType Disabled

Forbid the server from sending PUBLISH packets to the client that use topic aliasing

Method Details

values

public static TopicAliasingOptions.InboundTopicAliasBehaviorType[] 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

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

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

Parameters:

value - native integer value for the InboundTopicAliasBehaviorType value

Returns:

a new InboundTopicAliasBehaviorType value