com.linecorp.armeria.server.throttling

Class ThrottlingRpcService

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<RpcRequest,RpcResponse>

com.linecorp.armeria.server.throttling.ThrottlingRpcService

All Implemented Interfaces:

Unwrappable, RpcService, Service<RpcRequest,RpcResponse>

public final class ThrottlingRpcService
extends AbstractThrottlingService<RpcRequest,RpcResponse>
implements RpcService

Decorates an RPC Service to throttle incoming requests.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ThrottlingRpcService(RpcService delegate, ThrottlingStrategy<RpcRequest> strategy) Creates a new instance that decorates the specified Service.

Method Summary

Modifier and Type	Method and Description
static Function<? super RpcService,ThrottlingRpcService>	newDecorator(ThrottlingStrategy<RpcRequest> strategy) Creates a new decorator using the specified ThrottlingStrategy instance.
protected RpcResponse	onFailure(ServiceRequestContext ctx, RpcRequest 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.RpcService

decorate, decorate, serve

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

as, decorate, serviceAdded, shouldCachePath

Constructor Detail

ThrottlingRpcService

protected ThrottlingRpcService(RpcService delegate,
                               ThrottlingStrategy<RpcRequest> strategy)

Creates a new instance that decorates the specified Service.

Method Detail

newDecorator

public static Function<? super RpcService,ThrottlingRpcService> newDecorator(ThrottlingStrategy<RpcRequest> strategy)

Creates a new decorator using the specified ThrottlingStrategy instance.

Parameters:

strategy - The ThrottlingStrategy instance to be used

onFailure

protected RpcResponse onFailure(ServiceRequestContext ctx,
                                RpcRequest req,
                                Throwable cause)
                         throws Exception

Invoked when req is throttled. By default, this method responds with a HttpStatusException with 503 Service Unavailable.

Specified by:

onFailure in class AbstractThrottlingService<RpcRequest,RpcResponse>

Throws:

Exception