Package software.amazon.awssdk.crt.mqtt5

Enum Mqtt5ClientOptions.ExtendedValidationAndFlowControlOptions

java.lang.Object

java.lang.Enum<Mqtt5ClientOptions.ExtendedValidationAndFlowControlOptions>

software.amazon.awssdk.crt.mqtt5.Mqtt5ClientOptions.ExtendedValidationAndFlowControlOptions

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Mqtt5ClientOptions.ExtendedValidationAndFlowControlOptions>

Enclosing class:

Mqtt5ClientOptions

public static enum Mqtt5ClientOptions.ExtendedValidationAndFlowControlOptions
extends java.lang.Enum<Mqtt5ClientOptions.ExtendedValidationAndFlowControlOptions>

Additional controls for client behavior with respect to operation validation and flow control; these checks go beyond the MQTT5 spec to respect limits of specific MQTT brokers.

Enum Constant Summary

Enum Constants

Enum Constant	Description
AWS_IOT_CORE_DEFAULTS	Apply additional client-side validation and operational flow control that respects the default AWS IoT Core limits.
NONE	Do not do any additional validation or flow control

Method Summary

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

NONE

public static final Mqtt5ClientOptions.ExtendedValidationAndFlowControlOptions NONE

Do not do any additional validation or flow control

AWS_IOT_CORE_DEFAULTS

public static final Mqtt5ClientOptions.ExtendedValidationAndFlowControlOptions AWS_IOT_CORE_DEFAULTS

Apply additional client-side validation and operational flow control that respects the default AWS IoT Core limits. Currently applies the following additional validation:

1. No more than 8 subscriptions per SUBSCRIBE packet
2. Topics and topic filters have a maximum of 7 slashes (8 segments), not counting any AWS rules prefix
3. Topics must be 256 bytes or less in length
4. Client id must be 128 or less bytes in length

Also applies the following flow control:

1. Outbound throughput throttled to 512KB/s
2. Outbound publish TPS throttled to 100

Method Detail

values

public static Mqtt5ClientOptions.ExtendedValidationAndFlowControlOptions[] 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.ExtendedValidationAndFlowControlOptions c : Mqtt5ClientOptions.ExtendedValidationAndFlowControlOptions.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.ExtendedValidationAndFlowControlOptions 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 Mqtt5ClientOptions.ExtendedValidationAndFlowControlOptions getEnumValueFromInteger(int value)

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

Parameters:

value - native integer value for the extended validation and flow control options

Returns:

a new ExtendedValidationAndFlowControlOptions value