Class AimdLimitConfig.Builder

java.lang.Object

io.helidon.common.concurrency.limits.AimdLimitConfig.BuilderBase<AimdLimitConfig.Builder, AimdLimitConfig>

io.helidon.common.concurrency.limits.AimdLimitConfig.Builder

All Implemented Interfaces:

Prototype.Builder<AimdLimitConfig.Builder, AimdLimitConfig>, Builder<AimdLimitConfig.Builder, AimdLimit>, ConfigBuilderSupport.ConfiguredBuilder<AimdLimitConfig.Builder, AimdLimitConfig>, Supplier<AimdLimit>

Enclosing interface:

AimdLimitConfig

public static class AimdLimitConfig.Builder
extends AimdLimitConfig.BuilderBase<AimdLimitConfig.Builder, AimdLimitConfig>
implements Builder<AimdLimitConfig.Builder, AimdLimit>

Fluent API builder for AimdLimit.

Nested Class Summary

Nested classes/interfaces inherited from class AimdLimitConfig.BuilderBase

AimdLimitConfig.BuilderBase.AimdLimitConfigImpl

Modifier and Type	Class	Description
protected static class	AimdLimitConfig.BuilderBase.AimdLimitConfigImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.

Method Summary

Modifier and Type	Method	Description
AimdLimit	build()	Create an instance from this builder.
AimdLimitConfig	buildPrototype()	Create an instance of the prototype.

Methods inherited from class AimdLimitConfig.BuilderBase

backoffRatio, backoffRatio, clearClock, clock, clock, config, config, enableMetrics, enableMetrics, fair, fair, from, from, initialLimit, initialLimit, maxLimit, maxLimit, minLimit, minLimit, name, name, preBuildPrototype, queueLength, queueLength, queueTimeout, queueTimeout, timeout, timeout, toString, validatePrototype

Modifier and Type	Method	Description
double	backoffRatio()	Backoff ratio to use for the algorithm.
AimdLimitConfig.Builder	backoffRatio(double backoffRatio)	Backoff ratio to use for the algorithm.
AimdLimitConfig.Builder	clearClock()	Clear existing value of clock.
Optional<Supplier<Long>>	clock()	A clock that supplies nanosecond time.
AimdLimitConfig.Builder	clock(Supplier<Long> clock)	A clock that supplies nanosecond time.
protected Optional<Config>	config()	Configuration used to configure this instance.
AimdLimitConfig.Builder	config(Config config)	Update builder from configuration (node of this type).
boolean	enableMetrics()	Whether to collect metrics for the AIMD implementation.
AimdLimitConfig.Builder	enableMetrics(boolean enableMetrics)	Whether to collect metrics for the AIMD implementation.
boolean	fair()	Whether the Semaphore should be Semaphore.isFair().
AimdLimitConfig.Builder	fair(boolean fair)	Whether the Semaphore should be Semaphore.isFair().
AimdLimitConfig.Builder	from(AimdLimitConfig prototype)	Update this builder from an existing prototype instance.
AimdLimitConfig.Builder	from(AimdLimitConfig.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
int	initialLimit()	Initial limit.
AimdLimitConfig.Builder	initialLimit(int initialLimit)	Initial limit.
int	maxLimit()	Maximal limit.
AimdLimitConfig.Builder	maxLimit(int maxLimit)	Maximal limit.
int	minLimit()	Minimal limit.
AimdLimitConfig.Builder	minLimit(int minLimit)	Minimal limit.
String	name()	Name of this instance.
AimdLimitConfig.Builder	name(String name)	Name of this instance.
protected void	preBuildPrototype()	Handles providers and decorators.
int	queueLength()	How many requests can be enqueued waiting for a permit after the max limit is reached.
AimdLimitConfig.Builder	queueLength(int queueLength)	How many requests can be enqueued waiting for a permit after the max limit is reached.
Duration	queueTimeout()	How long to wait for a permit when enqueued.
AimdLimitConfig.Builder	queueTimeout(Duration queueTimeout)	How long to wait for a permit when enqueued.
Duration	timeout()	Timeout that when exceeded is the same as if the task failed.
AimdLimitConfig.Builder	timeout(Duration timeout)	Timeout that when exceeded is the same as if the task failed.
String	toString()
protected void	validatePrototype()	Validates required properties.

Methods inherited from class Object

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

Methods inherited from interface Builder

get, identity, update

Modifier and Type	Method	Description
default AimdLimit	get()
default AimdLimitConfig.Builder	identity()	Instance of this builder as the correct type.
default AimdLimitConfig.Builder	update(Consumer<AimdLimitConfig.Builder> consumer)	Update the builder in a fluent API way.

Methods inherited from interface Prototype.Builder

self

Modifier and Type	Method	Description
default AimdLimitConfig.Builder	self()	Instance of this builder as the correct type.

Method Details

buildPrototype

public AimdLimitConfig buildPrototype()

Create an instance of the prototype. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

buildPrototype in interface Prototype.Builder<AimdLimitConfig.Builder, AimdLimitConfig>

Returns:

an instance of the setup object created from this builder

build

public AimdLimit build()

Create an instance from this builder. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

build in interface Builder<AimdLimitConfig.Builder, AimdLimit>

Returns:

instance of the built type