io.github.resilience4j.timelimiter

Interface TimeLimiter

All Known Implementing Classes:

TimeLimiterImpl

public interface TimeLimiter

A TimeLimiter decorator stops execution after a configurable duration.

Method Summary

Modifier and Type	Method and Description
static <T,F extends java.util.concurrent.Future<T>> java.util.concurrent.Callable<T>	decorateFutureSupplier(TimeLimiter timeLimiter, java.util.function.Supplier<F> futureSupplier) Creates a Callback that is restricted by a TimeLimiter.
default <T,F extends java.util.concurrent.Future<T>> T	executeFutureSupplier(java.util.function.Supplier<F> futureSupplier) Decorates and executes the Future Supplier.
TimeLimiterConfig	getTimeLimiterConfig() Get the TimeLimiterConfig of this TimeLimiter decorator.
static TimeLimiter	of(java.time.Duration timeoutDuration) Creates a TimeLimiter decorator with a timeout Duration.
static TimeLimiter	of(TimeLimiterConfig timeLimiterConfig) Creates a TimeLimiter decorator with a TimeLimiterConfig configuration.
static TimeLimiter	ofDefaults() Creates a TimeLimiter decorator with a default TimeLimiterConfig configuration.

Method Detail

ofDefaults

static TimeLimiter ofDefaults()

Creates a TimeLimiter decorator with a default TimeLimiterConfig configuration.

Returns:

The TimeLimiter

of

static TimeLimiter of(TimeLimiterConfig timeLimiterConfig)

Creates a TimeLimiter decorator with a TimeLimiterConfig configuration.

Parameters:

timeLimiterConfig - the TimeLimiterConfig

Returns:

The TimeLimiter

of

static TimeLimiter of(java.time.Duration timeoutDuration)

Creates a TimeLimiter decorator with a timeout Duration.

Parameters:

timeoutDuration - the timeout Duration

Returns:

The TimeLimiter

decorateFutureSupplier

static <T,F extends java.util.concurrent.Future<T>> java.util.concurrent.Callable<T> decorateFutureSupplier(TimeLimiter timeLimiter,
                                                                                                            java.util.function.Supplier<F> futureSupplier)

Creates a Callback that is restricted by a TimeLimiter.

Type Parameters:

T - the type of results supplied by the supplier

F - the future type supplied

Parameters:

timeLimiter - the TimeLimiter

futureSupplier - the original future supplier

Returns:

a future supplier which is restricted by a TimeLimiter.

getTimeLimiterConfig

TimeLimiterConfig getTimeLimiterConfig()

Get the TimeLimiterConfig of this TimeLimiter decorator.

Returns:

the TimeLimiterConfig of this TimeLimiter decorator

executeFutureSupplier

default <T,F extends java.util.concurrent.Future<T>> T executeFutureSupplier(java.util.function.Supplier<F> futureSupplier)
                                                                      throws java.lang.Exception

Decorates and executes the Future Supplier.

Type Parameters:

T - the result type of the future

F - the type of Future

Parameters:

futureSupplier - the original future supplier

Returns:

the result of the Future.

Throws:

java.lang.Exception - if unable to compute a result