com.linecorp.armeria.server.throttling

Class ThrottlingStrategy<T extends Request>

java.lang.Object

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

Direct Known Subclasses:

RateLimitingThrottlingStrategy

public abstract class ThrottlingStrategy<T extends Request>
extends Object

Determines whether a request should be throttled.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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.
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<ServiceRequestContext,T,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<ServiceRequestContext,T,CompletionStage<Boolean>> function, String strategyName) Creates a new ThrottlingStrategy that determines whether a request should be accepted or not using a given BiFunction instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

ThrottlingStrategy

protected ThrottlingStrategy()

Creates a new ThrottlingStrategy with a default name.

ThrottlingStrategy

protected ThrottlingStrategy(String name)

Creates a new ThrottlingStrategy with specified name.

Method Detail

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<ServiceRequestContext,T,CompletionStage<Boolean>> function,
                                                           String strategyName)

Creates 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<ServiceRequestContext,T,CompletionStage<Boolean>> function)

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

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 String name()

Returns the name of this ThrottlingStrategy.