Interface Timeout

All Superinterfaces:

FtHandler, RuntimeType.Api<TimeoutConfig>

public interface Timeout
extends FtHandler, RuntimeType.Api<TimeoutConfig>

Timeout attempts to terminate execution after defined duration of time.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FT_TIMEOUT_CALLS_TOTAL	Counter for all the calls in a timeout.
static final String	FT_TIMEOUT_EXECUTIONDURATION	Histogram of execution durations.

Method Summary

Static Methods

Modifier and Type	Method	Description
static TimeoutConfig.Builder	builder()	Create a new fluent API builder to customize a timeout.
static Timeout	create(TimeoutConfig config)	Create a timeout based on configuration.
static Timeout	create(Duration timeout)	Create a Timeout with specified timeout.
static Timeout	create(Consumer<TimeoutConfig.Builder> builderConsumer)	Create a timeout with a possibility to customize its configuration.

Methods inherited from interface FtHandler

invoke, name

Modifier and Type	Method	Description
<T> T	invoke(Supplier<? extends T> supplier)	Invoke this fault tolerance handler on a supplier of result.
String	name()	A name assigned to a handler for debugging, error reporting or configuration purposes.

Methods inherited from interface RuntimeType.Api

prototype

Modifier and Type	Method	Description
TimeoutConfig	prototype()	The prototype as it was received when creating this runtime object instance.

Field Details

FT_TIMEOUT_CALLS_TOTAL

static final String FT_TIMEOUT_CALLS_TOTAL

Counter for all the calls in a timeout.

See Also:

• Constant Field Values

FT_TIMEOUT_EXECUTIONDURATION

static final String FT_TIMEOUT_EXECUTIONDURATION

Histogram of execution durations.

See Also:

• Constant Field Values

Method Details

create

static Timeout create(TimeoutConfig config)

Create a timeout based on configuration.

Parameters:

config - timeout configuration

Returns:

timeout handler

create

static Timeout create(Consumer<TimeoutConfig.Builder> builderConsumer)

Create a timeout with a possibility to customize its configuration.

Parameters:

builderConsumer - consumer to customize configuration

Returns:

a new timeout

builder

static TimeoutConfig.Builder builder()

Create a new fluent API builder to customize a timeout.

Returns:

a new timeout builder

create

static Timeout create(Duration timeout)

Create a Timeout with specified timeout.

Parameters:

timeout - duration of the timeout of operations handled by the new Timeout instance

Returns:

a new timeout