Interface TimeoutConfig

All Superinterfaces:

Prototype.Api, Prototype.Factory<Timeout>

All Known Implementing Classes:

TimeoutConfig.BuilderBase.TimeoutConfigImpl

public interface TimeoutConfig
extends Prototype.Api

Timeout configuration bean.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	TimeoutConfig.Builder	Fluent API builder for Timeout.
static class	TimeoutConfig.BuilderBase<BUILDER extends TimeoutConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends TimeoutConfig>	Fluent API builder base for TimeoutConfig.

Method Summary

Modifier and Type	Method	Description
static TimeoutConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static TimeoutConfig.Builder	builder(TimeoutConfig instance)	Create a new fluent API builder from an existing instance.
static TimeoutConfig	create()	Create a new instance with default values.
static TimeoutConfig	create(Config config)	Create a new instance from configuration.
boolean	currentThread()	Flag to indicate that code must be executed in current thread instead of in an executor's thread.
boolean	enableMetrics()	Flag to enable metrics for this instance.
Optional<ExecutorService>	executor()	Executor service to schedule the timeout.
Optional<String>	name()	Name for debugging, error reporting, monitoring.
Duration	timeout()	Duration to wait before timing out.

Methods inherited from interface Prototype.Factory

build

Modifier and Type	Method	Description
Timeout	build()	Create a new instance of the runtime type from this config object.

Method Details

builder

static TimeoutConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static TimeoutConfig.Builder builder(TimeoutConfig instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static TimeoutConfig create(Config config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

static TimeoutConfig create()

Create a new instance with default values.

Returns:

a new instance

name

Optional<String> name()

Name for debugging, error reporting, monitoring.

Returns:

name of this timeout

timeout

Duration timeout()

Duration to wait before timing out. Defaults to 10 seconds.

Returns:

timeout

currentThread

boolean currentThread()

Flag to indicate that code must be executed in current thread instead of in an executor's thread. This flag is false by default.

Returns:

whether to execute on current thread (true), or in an executor service (false})

executor

Optional<ExecutorService> executor()

Executor service to schedule the timeout.

Returns:

executor service to use

enableMetrics

boolean enableMetrics()

Flag to enable metrics for this instance. The value of this flag is combined with the global config entry FaultTolerance.FT_METRICS_DEFAULT_ENABLED. If either of these flags is true, then metrics will be enabled for the instance.

Returns:

metrics enabled flag