Module io.helidon.common.concurrency.limits

Package io.helidon.common.concurrency.limits

Class ThroughputLimitConfig.BuilderBase.ThroughputLimitConfigImpl

java.lang.Object

io.helidon.common.concurrency.limits.ThroughputLimitConfig.BuilderBase.ThroughputLimitConfigImpl

All Implemented Interfaces:

Prototype.Api, Prototype.Factory<ThroughputLimit>, ThroughputLimitConfig, Supplier<ThroughputLimit>

Enclosing class:

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

protected static class ThroughputLimitConfig.BuilderBase.ThroughputLimitConfigImpl
extends Object
implements ThroughputLimitConfig, Supplier<ThroughputLimit>

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.ThroughputLimitConfig

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
int	amount()	Number of operations to allow during the relevant time window.
ThroughputLimit	build()	Create a new instance of the runtime type from this config object.
Optional<Supplier<Long>>	clock()	A clock that supplies nanosecond time.
Duration	duration()	Duration of the time window over which operations will be counted.
boolean	enableMetrics()	Whether to collect metrics for the throughput limit implementation.
boolean	equals(Object o)
boolean	fair()	Whether the Semaphore should be Semaphore.isFair().
ThroughputLimit	get()
int	hashCode()
String	name()	Name of this instance.
int	queueLength()	How many requests can be enqueued waiting for a permit.
Duration	queueTimeout()	How long to wait for a permit when enqueued.
RateLimitingAlgorithmType	rateLimitingAlgorithm()	The rate limiting algorithm to apply.
Optional<Semaphore>	semaphore()	Explicitly configured semaphore.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ThroughputLimitConfigImpl

protected ThroughputLimitConfigImpl(ThroughputLimitConfig.BuilderBase<?,?> builder)

Create an instance providing a builder.

Parameters:

builder - extending builder base of this prototype

Method Details

build

public ThroughputLimit 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<ThroughputLimit>

Returns:

new configured runtime instance

get

public ThroughputLimit get()

Specified by:

get in interface Supplier<ThroughputLimit>

rateLimitingAlgorithm

public RateLimitingAlgorithmType rateLimitingAlgorithm()

Description copied from interface: ThroughputLimitConfig

The rate limiting algorithm to apply. Rate limiting algorithm is by default RateLimitingAlgorithmType.TOKEN_BUCKET.

Specified by:

rateLimitingAlgorithm in interface ThroughputLimitConfig

Returns:

the rate limiting algorithm to be applied

amount

public int amount()

Description copied from interface: ThroughputLimitConfig

Number of operations to allow during the relevant time window. Defaults to 0. When set to 0, we switch to unlimited.

Specified by:

amount in interface ThroughputLimitConfig

Returns:

number of permits

duration

public Duration duration()

Description copied from interface: ThroughputLimitConfig

Duration of the time window over which operations will be counted. Defaults to "PT1S"

Specified by:

duration in interface ThroughputLimitConfig

Returns:

duration of the time window

fair

public boolean fair()

Description copied from interface: ThroughputLimitConfig

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

Specified by:

fair in interface ThroughputLimitConfig

Returns:

whether this should be a fair semaphore

queueLength

public int queueLength()

Description copied from interface: ThroughputLimitConfig

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

Specified by:

queueLength in interface ThroughputLimitConfig

Returns:

number of requests to enqueue

queueTimeout

public Duration queueTimeout()

Description copied from interface: ThroughputLimitConfig

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

Specified by:

queueTimeout in interface ThroughputLimitConfig

Returns:

duration of the timeout

name

public String name()

Description copied from interface: ThroughputLimitConfig

Name of this instance.

Specified by:

name in interface ThroughputLimitConfig

Returns:

name of the instance

semaphore

public Optional<Semaphore> semaphore()

Description copied from interface: ThroughputLimitConfig

Explicitly configured semaphore. Note that if this is set, all other configuration is ignored.

Specified by:

semaphore in interface ThroughputLimitConfig

Returns:

semaphore instance

clock

public Optional<Supplier<Long>> clock()

Description copied from interface: ThroughputLimitConfig

A clock that supplies nanosecond time.

Specified by:

clock in interface ThroughputLimitConfig

Returns:

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

enableMetrics

public boolean enableMetrics()

Description copied from interface: ThroughputLimitConfig

Whether to collect metrics for the throughput limit implementation.

Specified by:

enableMetrics in interface ThroughputLimitConfig

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