com.alibaba.csp.sentinel.node

Interface OccupySupport

All Known Subinterfaces:

Node

All Known Implementing Classes:

ClusterNode, DefaultNode, EntranceNode, StatisticNode

public interface OccupySupport

Since:

1.5.0

Author:

Eric Zhao

Method Summary

Modifier and Type	Method and Description
void	addOccupiedPass(int acquireCount) Add occupied pass request, which represents pass requests that borrow the latter windows' token.
void	addWaitingRequest(long futureTime, int acquireCount) Add request that occupied.
double	occupiedPassQps() Get current occupied pass QPS.
long	tryOccupyNext(long currentTime, int acquireCount, double threshold) Try to occupy latter time windows' tokens.
long	waiting() Get current waiting amount.

Method Detail

tryOccupyNext

long tryOccupyNext(long currentTime,
                   int acquireCount,
                   double threshold)

Try to occupy latter time windows' tokens. If occupy success, a value less than occupyTimeout in OccupyTimeoutProperty will be return.

Each time we occupy tokens of the future window, current thread should sleep for the corresponding time for smoothing QPS. We can't occupy tokens of the future with unlimited, the sleep time limit is occupyTimeout in OccupyTimeoutProperty.

Parameters:

currentTime - current time millis.

acquireCount - tokens count to acquire.

threshold - qps threshold.

Returns:

time should sleep. Time >= occupyTimeout in OccupyTimeoutProperty means occupy fail, in this case, the request should be rejected immediately.

waiting

long waiting()

Get current waiting amount. Useful for debug.

Returns:

current waiting amount

addWaitingRequest

void addWaitingRequest(long futureTime,
                       int acquireCount)

Add request that occupied.

Parameters:

futureTime - future timestamp that the acquireCount should be added on.

acquireCount - tokens count.

addOccupiedPass

void addOccupiedPass(int acquireCount)

Add occupied pass request, which represents pass requests that borrow the latter windows' token.

Parameters:

acquireCount - tokens count.

occupiedPassQps

double occupiedPassQps()

Get current occupied pass QPS.

Returns:

current occupied pass QPS