com.alibaba.csp.sentinel.cluster

Interface TokenService

All Known Subinterfaces:

ClusterTokenClient, EmbeddedClusterTokenServer

public interface TokenService

Service interface of flow control.

Since:

1.4.0

Author:

Eric Zhao

Method Summary

Modifier and Type	Method and Description
void	releaseConcurrentToken(Long tokenId) Request release concurrent tokens from remote token server asynchronously.
TokenResult	requestConcurrentToken(String clientAddress, Long ruleId, int acquireCount) Request acquire concurrent tokens from remote token server.
TokenResult	requestParamToken(Long ruleId, int acquireCount, Collection<Object> params) Request tokens for a specific parameter from remote token server.
TokenResult	requestToken(Long ruleId, int acquireCount, boolean prioritized) Request tokens from remote token server.

Method Detail

requestToken

TokenResult requestToken(Long ruleId,
                         int acquireCount,
                         boolean prioritized)

Request tokens from remote token server.

Parameters:

ruleId - the unique rule ID

acquireCount - token count to acquire

prioritized - whether the request is prioritized

Returns:

result of the token request

requestParamToken

TokenResult requestParamToken(Long ruleId,
                              int acquireCount,
                              Collection<Object> params)

Request tokens for a specific parameter from remote token server.

Parameters:

ruleId - the unique rule ID

acquireCount - token count to acquire

params - parameter list

Returns:

result of the token request

requestConcurrentToken

TokenResult requestConcurrentToken(String clientAddress,
                                   Long ruleId,
                                   int acquireCount)

Request acquire concurrent tokens from remote token server.

Parameters:

clientAddress - the address of the request belong.

ruleId - ruleId the unique rule ID

acquireCount - token count to acquire

Returns:

result of the token request

releaseConcurrentToken

void releaseConcurrentToken(Long tokenId)

Request release concurrent tokens from remote token server asynchronously.

Parameters:

tokenId - the unique token ID