Package com.linecorp.armeria.server.throttling

Class ThrottlingRpcService

java.lang.Object

com.linecorp.armeria.common.util.AbstractUnwrappable<Service<RpcRequest,RpcResponse>>

com.linecorp.armeria.server.DecoratingService<RpcRequest,RpcResponse,RpcRequest,RpcResponse>

com.linecorp.armeria.server.SimpleDecoratingService<RpcRequest,RpcResponse>

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.

Method Summary

Modifier and Type	Method	Description
static ThrottlingRpcServiceBuilder	builder(ThrottlingStrategy<RpcRequest> strategy)	Returns a new ThrottlingRpcServiceBuilder.
static Function<? super RpcService,ThrottlingRpcService>	newDecorator(ThrottlingStrategy<RpcRequest> strategy)	Creates a new decorator using the specified ThrottlingStrategy.
static Function<? super RpcService,ThrottlingRpcService>	newDecorator(ThrottlingStrategy<RpcRequest> strategy, ThrottlingRejectHandler<RpcRequest,RpcResponse> rejectHandler)	Creates a new decorator using the specified ThrottlingStrategy and ThrottlingRejectHandler.

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

serve

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

serviceAdded, shouldCachePath

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

as, toString, unwrap, unwrapAll

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, serviceAdded, shouldCachePath, unwrap

Methods inherited from interface com.linecorp.armeria.common.util.Unwrappable

equalsIgnoreWrapper, unwrapAll

Method Details

newDecorator

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

Creates a new decorator using the specified ThrottlingStrategy and ThrottlingRejectHandler.

Parameters:

strategy - The ThrottlingStrategy instance to define throttling strategy

rejectHandler - The ThrottlingRejectHandler instance to define request rejection behaviour

newDecorator

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

Creates a new decorator using the specified ThrottlingStrategy.

Parameters:

strategy - The ThrottlingStrategy instance to define throttling strategy

builder

public static ThrottlingRpcServiceBuilder builder(ThrottlingStrategy<RpcRequest> strategy)

Returns a new ThrottlingRpcServiceBuilder.