Package com.hivemq.extension.sdk.api.async

Enum TimeoutFallback

java.lang.Object

java.lang.Enum<TimeoutFallback>

com.hivemq.extension.sdk.api.async.TimeoutFallback

All Implemented Interfaces:

Serializable, Comparable<TimeoutFallback>

public enum TimeoutFallback
extends Enum<TimeoutFallback>

The TimeoutFallback defines the strategy that will be applied after an Async operation timed out.

Since:

4.0.0, CE 2019.1

Enum Constant Summary

Enum Constants

Enum Constant	Description
FAILURE	FAILURE usually means that HiveMQ aborts any further action.
SUCCESS	SUCCESS usually means that HiveMQ either sees the outcome as successful or asks the next extension, that also implemented the specific service.

Method Summary

Modifier and Type	Method	Description
static TimeoutFallback	valueOf(String name)	Returns the enum constant of this type with the specified name.
static TimeoutFallback[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SUCCESS

public static final TimeoutFallback SUCCESS

SUCCESS usually means that HiveMQ either sees the outcome as successful or asks the next extension, that also implemented the specific service.

The actual behaviour is defined in the specific implementation.

Since:

4.0.0, CE 2019.1

FAILURE

public static final TimeoutFallback FAILURE

FAILURE usually means that HiveMQ aborts any further action.

The actual behaviour is defined in the specific implementation.

Since:

4.0.0, CE 2019.1

Method Detail

values

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

Returns:

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

valueOf

public static TimeoutFallback 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