Package com.linecorp.armeria.server.throttling

Class ThrottlingStrategy<T extends Request>

java.lang.Object

com.linecorp.armeria.server.throttling.ThrottlingStrategy<T>

Direct Known Subclasses:

TokenBucketThrottlingStrategy

public abstract class ThrottlingStrategy<T extends Request>
extends Object

Determines whether a request should be throttled.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ThrottlingStrategy()	Creates a new ThrottlingStrategy with a default name.
protected	ThrottlingStrategy(@Nullable String name)	Creates a new ThrottlingStrategy with specified name.

Method Summary

Modifier and Type	Method	Description
abstract CompletionStage<Boolean>	accept(ServiceRequestContext ctx, T request)	Returns whether a given request should be treated as failed before it is handled actually.
static <T extends Request> ThrottlingStrategy<T>	always()	Returns a singleton ThrottlingStrategy that always accepts requests.
final String	name()	Returns the name of this ThrottlingStrategy.
static <T extends Request> ThrottlingStrategy<T>	never()	Returns a singleton ThrottlingStrategy that never accepts requests.
static <T extends Request> ThrottlingStrategy<T>	of(BiFunction<? super ServiceRequestContext,T,? extends CompletionStage<Boolean>> function)	Creates a new ThrottlingStrategy that determines whether a request should be accepted or not using a given BiFunction instance.
static <T extends Request> ThrottlingStrategy<T>	of(BiFunction<? super ServiceRequestContext,T,? extends CompletionStage<Boolean>> function, String strategyName)	Returns a new ThrottlingStrategy that determines whether a request should be accepted or not using a given BiFunction instance.
static <T extends Request> ThrottlingStrategy<T>	rateLimiting(double requestsPerSecond)	Returns a new ThrottlingStrategy that provides a throttling strategy based on requests per second.
static <T extends Request> ThrottlingStrategy<T>	rateLimiting(double requestsPerSecond, String name)	Returns a new ThrottlingStrategy that provides a throttling strategy based on requests per second.

Methods inherited from class java.lang.Object

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

Constructor Details

ThrottlingStrategy

protected ThrottlingStrategy()

Creates a new ThrottlingStrategy with a default name.

ThrottlingStrategy

protected ThrottlingStrategy(@Nullable
 @Nullable String name)

Creates a new ThrottlingStrategy with specified name.

Method Details

never

public static <T extends Request>
ThrottlingStrategy<T> never()

Returns a singleton ThrottlingStrategy that never accepts requests.

always

public static <T extends Request>
ThrottlingStrategy<T> always()

Returns a singleton ThrottlingStrategy that always accepts requests.

of

public static <T extends Request>
ThrottlingStrategy<T> of(BiFunction<? super ServiceRequestContext,T,? extends CompletionStage<Boolean>> function,
 String strategyName)

Returns a new ThrottlingStrategy that determines whether a request should be accepted or not using a given BiFunction instance.

of

public static <T extends Request>
ThrottlingStrategy<T> of(BiFunction<? super ServiceRequestContext,T,? extends CompletionStage<Boolean>> function)

Creates a new ThrottlingStrategy that determines whether a request should be accepted or not using a given BiFunction instance.

rateLimiting

public static <T extends Request>
ThrottlingStrategy<T> rateLimiting(double requestsPerSecond)

Returns a new ThrottlingStrategy that provides a throttling strategy based on requests per second.

Parameters:

requestsPerSecond - the number of requests per one second this ThrottlingStrategy accepts

rateLimiting

public static <T extends Request>
ThrottlingStrategy<T> rateLimiting(double requestsPerSecond,
 String name)

Returns a new ThrottlingStrategy that provides a throttling strategy based on requests per second.

Parameters:

requestsPerSecond - the number of requests per one second this ThrottlingStrategy accepts

name - the name of the ThrottlingStrategy

accept

public abstract CompletionStage<Boolean> accept(ServiceRequestContext ctx,
 T request)

Returns whether a given request should be treated as failed before it is handled actually.

name

public final String name()

Returns the name of this ThrottlingStrategy.