Interface Limit

All Superinterfaces:

LimitAlgorithm, NamedService

All Known Implementing Classes:

AimdLimit, FixedLimit, ThroughputLimit

@Contract
public interface Limit
extends LimitAlgorithm, NamedService

Contract for a concurrency limiter.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Limit.InitializationContext	Runtime context used when initializing a Limit.

Nested classes/interfaces inherited from interface LimitAlgorithm

LimitAlgorithm.Outcome, LimitAlgorithm.Result<T>, LimitAlgorithm.Token

Modifier and Type	Interface	Description
static interface	LimitAlgorithm.Outcome	Represents the outcome of a limit algorithm decision.
static interface	LimitAlgorithm.Result<T>	Carrier for both the result of a Callable subjected to concurrency limits and the corresponding LimitAlgorithm.Outcome.
static interface	LimitAlgorithm.Token	When a token is retrieved from LimitAlgorithm.tryAcquireOutcome(), one of its methods must be called when the task is over, to release the token back to the pool (such as a permit returned to a Semaphore).

Method Summary

Modifier and Type	Method	Description
Limit	copy()	Create a copy of this limit with the same configuration.
default void	init(Limit.InitializationContext context)	Initialization method for this limit.
default void	init(String originName)	Deprecated. use init(InitializationContext) to provide initialization details explicitly.

Methods inherited from interface LimitAlgorithm

call, run, tryAcquireOutcome, tryAcquireOutcome

Modifier and Type	Method	Description
default <T> LimitAlgorithm.Result<T>	call(Callable<T> callable)	Invoke a callable within the limits of this limiter.
default LimitAlgorithm.Outcome	run(Runnable runnable)	Invoke a runnable within the limits of this limiter.
default LimitAlgorithm.Outcome	tryAcquireOutcome()	Try to acquire a token, waiting for available permits for the configured amount of time, if queuing is enabled.
LimitAlgorithm.Outcome	tryAcquireOutcome(boolean wait)	Tries to acquire a token, waiting for available permits for the configured amount of time if wait is enabled and the implementation supports queueing, returning immediately otherwise.

Methods inherited from interface NamedService

name, type

Modifier and Type	Method	Description
String	name()	Name of this implementation, as provided in ConfiguredProvider.create(Config, String).
String	type()	Type of this implementation, to distinguish instances of same type, with different NamedService.name().

Method Details

copy

Limit copy()

Create a copy of this limit with the same configuration.

Returns:

a copy of this limit

init

default void init(Limit.InitializationContext context)

Initialization method for this limit. This method can be used for any task, including metrics initialization.

Parameters:

context - the context for limit initialization

init

@Deprecated
default void init(String originName)

Deprecated.

use init(InitializationContext) to provide initialization details explicitly.

Initialization method for this limit. This method can be used for any task, including metrics initialization.

Parameters:

originName - origin name for this limit, such as "@default"