Package com.helixframework.time

Class Timeout

java.lang.Object

com.helixframework.time.Timeout

public class Timeout
extends Object

Wrapper function that adds a timeout to the enclosed logic.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Timeout.FallbackFunction<T>	Function to execute in the event of a timeout.
static interface	Timeout.TimeoutFunction<T>	Function that adds a timeout to the call.

Method Summary

Modifier and Type	Method	Description
static <T> T	execute(Timeout.TimeoutFunction<T> fn, Timeout.FallbackFunction<T> fallbackFn, Duration timeout)	Executes the wrapped function with a timeout and fallback.
static <T> T	execute(Timeout.TimeoutFunction<T> fn, Duration timeout)	Executes the wrapped function with a timeout.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

execute

public static <T> T execute(Timeout.TimeoutFunction<T> fn,
 Duration timeout)
                     throws ExecutionException,
InterruptedException,
TimeoutException

Executes the wrapped function with a timeout.

Type Parameters:

T - return type of the wrapped function

Parameters:

fn - wrapped function to execute

timeout - function timeout

Returns:

result of the wrapped function

Throws:

ExecutionException - if an exception occurs in the wrapped function

InterruptedException - if the wrapped function is interrupted

TimeoutException - if the timeout is exceeded

IllegalArgumentException - if a negative timeout is set

execute

public static <T> T execute(Timeout.TimeoutFunction<T> fn,
 Timeout.FallbackFunction<T> fallbackFn,
 Duration timeout)
                     throws ExecutionException,
InterruptedException

Executes the wrapped function with a timeout and fallback. In the event of a timeout, the fallback function is executed.

Type Parameters:

T - return type of the wrapped function

Parameters:

fn - wrapped function to execute

fallbackFn - function to execute in the event of a timeout

timeout - function timeout

Returns:

result of the wrapped function

Throws:

ExecutionException - if an exception occurs in the wrapped function

InterruptedException - if the wrapped function is interrupted

IllegalArgumentException - if a negative timeout is set