Enum OverloadProtectionThrottlingLevel
- java.lang.Object
-
- java.lang.Enum<OverloadProtectionThrottlingLevel>
-
- com.hivemq.extension.sdk.api.auth.parameter.OverloadProtectionThrottlingLevel
-
- All Implemented Interfaces:
Serializable
,Comparable<OverloadProtectionThrottlingLevel>
public enum OverloadProtectionThrottlingLevel extends Enum<OverloadProtectionThrottlingLevel>
The enum is used to define how a client is affected by the overload protection.- Since:
- 4.2.0, CE 2020.1
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static OverloadProtectionThrottlingLevel
valueOf(String name)
Returns the enum constant of this type with the specified name.static OverloadProtectionThrottlingLevel[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
DEFAULT
public static final OverloadProtectionThrottlingLevel DEFAULT
The amount of PUBLISH messages that each client can send is limited based on the resources of the HiveMQ cluster.- Since:
- 4.2.0, CE 2020.1
-
NONE
public static final OverloadProtectionThrottlingLevel NONE
The amount of PUBLISH messages that each client can send is NOT limited by the overload protection.ATTENTION: Use this setting with extreme caution. Disabling the Overload Protection Mechanism potentially decreases the resiliency of HiveMQ against client misbehaviour. Disabling the overload protection may lead to
OutOfMemoryError
.- Since:
- 4.2.0, CE 2020.1
-
-
Method Detail
-
values
public static OverloadProtectionThrottlingLevel[] 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 (OverloadProtectionThrottlingLevel c : OverloadProtectionThrottlingLevel.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static OverloadProtectionThrottlingLevel 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 nameNullPointerException
- if the argument is null
-
-