com.linecorp.armeria.server.throttling

Class ThrottlingService

java.lang.Object

com.linecorp.armeria.common.util.AbstractUnwrappable<Service<T_I,T_O>>

com.linecorp.armeria.server.DecoratingService<I,O,I,O>

com.linecorp.armeria.server.SimpleDecoratingService<I,O>

com.linecorp.armeria.server.throttling.AbstractThrottlingService<HttpRequest,HttpResponse>

com.linecorp.armeria.server.throttling.ThrottlingService

All Implemented Interfaces:

Unwrappable, HttpService, Service<HttpRequest,HttpResponse>

public final class ThrottlingService
extends AbstractThrottlingService<HttpRequest,HttpResponse>
implements HttpService

Decorates an HttpService to throttle incoming requests.

Method Summary

Modifier and Type	Method and Description
static Function<? super HttpService,ThrottlingService>	newDecorator(ThrottlingStrategy<HttpRequest> strategy) Creates a new decorator using the specified ThrottlingStrategy instance.
protected HttpResponse	onFailure(ServiceRequestContext ctx, HttpRequest req, Throwable cause) Invoked when req is throttled.

Methods inherited from class com.linecorp.armeria.server.throttling.AbstractThrottlingService

onSuccess, serve

Methods inherited from class com.linecorp.armeria.server.DecoratingService

serviceAdded, shouldCachePath

Methods inherited from class com.linecorp.armeria.common.util.AbstractUnwrappable

as, delegate, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.linecorp.armeria.server.HttpService

decorate, decorate, serve

Methods inherited from interface com.linecorp.armeria.server.Service

as, decorate, serviceAdded, shouldCachePath

Method Detail

newDecorator

public static Function<? super HttpService,ThrottlingService> newDecorator(ThrottlingStrategy<HttpRequest> strategy)

Creates a new decorator using the specified ThrottlingStrategy instance.

Parameters:

strategy - The ThrottlingStrategy instance to be used

onFailure

protected HttpResponse onFailure(ServiceRequestContext ctx,
                                 HttpRequest req,
                                 Throwable cause)
                          throws Exception

Invoked when req is throttled. By default, this method responds with the HttpStatus.SERVICE_UNAVAILABLE status.

Specified by:

onFailure in class AbstractThrottlingService<HttpRequest,HttpResponse>

Throws:

Exception