Module io.helidon.common.concurrency.limits

Package io.helidon.common.concurrency.limits

Class AimdLimitConfig.BuilderBase.AimdLimitConfigImpl

java.lang.Object

io.helidon.common.concurrency.limits.AimdLimitConfig.BuilderBase.AimdLimitConfigImpl

All Implemented Interfaces:

Prototype.Api, Prototype.Factory<AimdLimit>, AimdLimitConfig, Supplier<AimdLimit>

Enclosing class:

AimdLimitConfig.BuilderBase<BUILDER extends AimdLimitConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends AimdLimitConfig>

protected static class AimdLimitConfig.BuilderBase.AimdLimitConfigImpl
extends Object
implements AimdLimitConfig, Supplier<AimdLimit>

Generated implementation of the prototype, can be extended by descendant prototype implementations.

Nested Class Summary

Nested classes/interfaces inherited from interface io.helidon.common.concurrency.limits.AimdLimitConfig

AimdLimitConfig.Builder, AimdLimitConfig.BuilderBase<BUILDER extends AimdLimitConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends AimdLimitConfig>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AimdLimitConfigImpl(AimdLimitConfig.BuilderBase<?,?> builder)	Create an instance providing a builder.

Method Summary

Modifier and Type	Method	Description
double	backoffRatio()	Backoff ratio to use for the algorithm.
AimdLimit	build()	Create a new instance of the runtime type from this config object.
Optional<Supplier<Long>>	clock()	A clock that supplies nanosecond time.
boolean	enableMetrics()	Whether to collect metrics for the AIMD implementation.
boolean	equals(Object o)
boolean	fair()	Whether the Semaphore should be Semaphore.isFair().
AimdLimit	get()
int	hashCode()
int	initialLimit()	Initial limit.
int	maxLimit()	Maximal limit.
int	minLimit()	Minimal limit.
String	name()	Name of this instance.
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.
Duration	timeout()	Timeout that when exceeded is the same as if the task failed.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

AimdLimitConfigImpl

protected AimdLimitConfigImpl(AimdLimitConfig.BuilderBase<?,?> builder)

Create an instance providing a builder.

Parameters:

builder - extending builder base of this prototype

Method Details

build

public AimdLimit build()

Description copied from interface: Prototype.Factory

Create a new instance of the runtime type from this config object.

Specified by:

build in interface Prototype.Factory<AimdLimit>

Returns:

new configured runtime instance

get

public AimdLimit get()

Specified by:

get in interface Supplier<AimdLimit>

backoffRatio

public double backoffRatio()

Description copied from interface: AimdLimitConfig

Backoff ratio to use for the algorithm. The value must be within [0.5, 1.0).

Specified by:

backoffRatio in interface AimdLimitConfig

Returns:

backoff ratio

initialLimit

public int initialLimit()

Description copied from interface: AimdLimitConfig

Initial limit. The value must be within [AimdLimitConfig.minLimit(), AimdLimitConfig.maxLimit()].

Specified by:

initialLimit in interface AimdLimitConfig

Returns:

initial limit

maxLimit

public int maxLimit()

Description copied from interface: AimdLimitConfig

Maximal limit. The value must be same or higher than AimdLimitConfig.minLimit().

Specified by:

maxLimit in interface AimdLimitConfig

Returns:

maximal limit

minLimit

public int minLimit()

Description copied from interface: AimdLimitConfig

Minimal limit. The value must be same or lower than AimdLimitConfig.maxLimit().

Specified by:

minLimit in interface AimdLimitConfig

Returns:

minimal limit

timeout

public Duration timeout()

Description copied from interface: AimdLimitConfig

Timeout that when exceeded is the same as if the task failed.

Specified by:

timeout in interface AimdLimitConfig

Returns:

task timeout, defaults to 5 seconds

clock

public Optional<Supplier<Long>> clock()

Description copied from interface: AimdLimitConfig

A clock that supplies nanosecond time.

Specified by:

clock in interface AimdLimitConfig

Returns:

supplier of current nanoseconds, defaults to System.nanoTime()

name

public String name()

Description copied from interface: AimdLimitConfig

Name of this instance.

Specified by:

name in interface AimdLimitConfig

Returns:

name of the instance

queueLength

public int queueLength()

Description copied from interface: AimdLimitConfig

How many requests can be enqueued waiting for a permit after the max limit is reached. Note that this may not be an exact behavior due to concurrent invocations. We use Semaphore.getQueueLength() in the AimdLimit implementation. Default value is 0. If set to {code 0}, there is no queueing.

Specified by:

queueLength in interface AimdLimitConfig

Returns:

number of requests to enqueue

queueTimeout

public Duration queueTimeout()

Description copied from interface: AimdLimitConfig

How long to wait for a permit when enqueued. Defaults to "PT1S"

Specified by:

queueTimeout in interface AimdLimitConfig

Returns:

duration of the timeout

fair

public boolean fair()

Description copied from interface: AimdLimitConfig

Whether the Semaphore should be Semaphore.isFair(). Defaults to false.

Specified by:

fair in interface AimdLimitConfig

Returns:

whether this should be a fair semaphore

enableMetrics

public boolean enableMetrics()

Description copied from interface: AimdLimitConfig

Whether to collect metrics for the AIMD implementation.

Specified by:

enableMetrics in interface AimdLimitConfig

Returns:

metrics flag

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object