Class FixedLimitConfig.BuilderBase.FixedLimitConfigImpl

java.lang.Object

io.helidon.common.concurrency.limits.FixedLimitConfig.BuilderBase.FixedLimitConfigImpl

All Implemented Interfaces:

Prototype.Api, Prototype.Factory<FixedLimit>, FixedLimitConfig, Supplier<FixedLimit>

Enclosing class:

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

protected static class FixedLimitConfig.BuilderBase.FixedLimitConfigImpl
extends Object
implements FixedLimitConfig, Supplier<FixedLimit>

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

Nested Class Summary

Nested classes/interfaces inherited from interface FixedLimitConfig

FixedLimitConfig.Builder, FixedLimitConfig.BuilderBase<BUILDER, PROTOTYPE>

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
FixedLimit	build()	Create a new runtime instance from this prototype.
Optional<Supplier<Long>>	clock()	A clock that supplies nanosecond time.
boolean	enableMetrics()	Whether to collect metrics for the fixed limit implementation.
boolean	equals(Object o)
boolean	fair()	Whether the Semaphore should be Semaphore.isFair().
FixedLimit	get()
int	hashCode()
String	name()	Name of this instance.
int	permits()	Number of permits to allow.
int	queueLength()	How many requests can be enqueued waiting for a permit.
Duration	queueTimeout()	How long to wait for a permit when enqueued.
Optional<Semaphore>	semaphore()	Explicitly configured semaphore.
String	toString()

Methods inherited from class Object

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

Constructor Details

FixedLimitConfigImpl

protected FixedLimitConfigImpl(FixedLimitConfig.BuilderBase<?,?> builder)

Create an instance providing a builder.

Parameters:

builder - extending builder base of this prototype

Method Details

build

public FixedLimit build()

Create a new runtime instance from this prototype.

Specified by:

build in interface Prototype.Factory<FixedLimit>

Returns:

new configured runtime instance

get

public FixedLimit get()

Specified by:

get in interface Supplier<FixedLimit>

permits

public int permits()

Description copied from interface: FixedLimitConfig

Number of permits to allow. Defaults to 0. When set to 0, we switch to unlimited.

Specified by:

permits in interface FixedLimitConfig

Returns:

number of permits

fair

public boolean fair()

Description copied from interface: FixedLimitConfig

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

Specified by:

fair in interface FixedLimitConfig

Returns:

whether this should be a fair semaphore

queueLength

public int queueLength()

Description copied from interface: FixedLimitConfig

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 FixedLimit implementation. Default value is 0. If set to 0, there is no queueing.

Specified by:

queueLength in interface FixedLimitConfig

Returns:

number of requests to enqueue

queueTimeout

public Duration queueTimeout()

Description copied from interface: FixedLimitConfig

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

Specified by:

queueTimeout in interface FixedLimitConfig

Returns:

duration of the timeout

name

public String name()

Description copied from interface: FixedLimitConfig

Name of this instance.

Specified by:

name in interface FixedLimitConfig

Returns:

name of the instance

semaphore

public Optional<Semaphore> semaphore()

Description copied from interface: FixedLimitConfig

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

Specified by:

semaphore in interface FixedLimitConfig

Returns:

semaphore instance

clock

public Optional<Supplier<Long>> clock()

Description copied from interface: FixedLimitConfig

A clock that supplies nanosecond time.

Specified by:

clock in interface FixedLimitConfig

Returns:

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

enableMetrics

public boolean enableMetrics()

Description copied from interface: FixedLimitConfig

Whether to collect metrics for the fixed limit implementation.

Specified by:

enableMetrics in interface FixedLimitConfig

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