com.ebay.bascomtask.core

Enum TimeoutStrategy

java.lang.Object

java.lang.Enum<TimeoutStrategy>

com.ebay.bascomtask.core.TimeoutStrategy

All Implemented Interfaces:

Serializable, Comparable<TimeoutStrategy>

public enum TimeoutStrategy
extends Enum<TimeoutStrategy>

Strategies for dealing with execution timeouts that impact threads spawned during the execution of a request such as CompletableFuture.get(long, TimeUnit). The minimum isPREVENT_NEW, which always applies and is the default. The other strategies indicate whether or not to interrupt any other threads spawned by that request. As is standard with Java, if and how any user task POJO responds to an interrupt is completely with the control of that task POJO.

Author:

Brendan McCarthy

Enum Constant Summary

Enum Constants

Enum Constant and Description
INTERRUPT_AT_NEXT_OPPORTUNITY Once a timeout occurs, in addition to PREVENT_NEW, the next time any task is attempted then interrupt all others.
INTERRUPT_IMMEDIATELY Once a timeout occurs, in addition to PREVENT_NEW, immediately interrupt all tasks.
PREVENT_NEW Once a timeout occurs, don't start new tasks but don't interrupt existing tasks.

Method Summary

Modifier and Type	Method and Description
static TimeoutStrategy	valueOf(String name) Returns the enum constant of this type with the specified name.
static TimeoutStrategy[]	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

PREVENT_NEW

public static final TimeoutStrategy PREVENT_NEW

Once a timeout occurs, don't start new tasks but don't interrupt existing tasks. Default strategy.

INTERRUPT_AT_NEXT_OPPORTUNITY

public static final TimeoutStrategy INTERRUPT_AT_NEXT_OPPORTUNITY

Once a timeout occurs, in addition to PREVENT_NEW, the next time any task is attempted then interrupt all others.

INTERRUPT_IMMEDIATELY

public static final TimeoutStrategy INTERRUPT_IMMEDIATELY

Once a timeout occurs, in addition to PREVENT_NEW, immediately interrupt all tasks. This is the strongest reaction, and incurs the expense spawning a dedicated thread to watch for the timeout.

Method Detail

values

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

Returns:

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

valueOf

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