lib.easyjava.net.rest

Class MultiRateLimiter

java.lang.Object

lib.easyjava.net.rest.MultiRateLimiter

All Implemented Interfaces:

RateLimiter

public class MultiRateLimiter
extends java.lang.Object
implements RateLimiter

Nested Class Summary

Nested classes/interfaces inherited from interface lib.easyjava.net.rest.RateLimiter

RateLimiter.Type

Constructor Summary

Constructors

Constructor and Description
MultiRateLimiter(RateLimiter.Type type, java.util.List<Pair<java.lang.Integer,java.lang.Long>> limits)

Method Summary

Modifier and Type	Method and Description
<T> T	attemptCall(java.util.function.Supplier<T> call) Executes the call only if calls are available
long	millisUntilNextCall()
int	numCallsLeft()
<T> T	waitForCall(java.util.function.Supplier<T> call) Executes the call, waiting for more calls if necessary

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MultiRateLimiter

public MultiRateLimiter(RateLimiter.Type type,
                        java.util.List<Pair<java.lang.Integer,java.lang.Long>> limits)

Parameters:

type - ROLLING or WINDOW. ROLLING allows one call every (millisPerEpoch/callsPerEpoch)ms. WINDOW allows (callsPerEpoch) calls in each (millisPerEpoch)ms stretch.

limits - pairs of the number of calls per epoch and the millisecond length of an epoch. Each pair is an addition restriction.

Method Detail

attemptCall

public <T> T attemptCall(java.util.function.Supplier<T> call)

Description copied from interface: RateLimiter

Executes the call only if calls are available

Specified by:

attemptCall in interface RateLimiter

Type Parameters:

T - the resulting value of the call

Parameters:

call - the call to execute

Returns:

the result of the call or null if no calls were left

millisUntilNextCall

public long millisUntilNextCall()

Specified by:

millisUntilNextCall in interface RateLimiter

Returns:

the time in ms before a call becomes available

numCallsLeft

public int numCallsLeft()

Specified by:

numCallsLeft in interface RateLimiter

Returns:

the number of calls currently available

waitForCall

public <T> T waitForCall(java.util.function.Supplier<T> call)
                  throws java.lang.InterruptedException

Description copied from interface: RateLimiter

Executes the call, waiting for more calls if necessary

Specified by:

waitForCall in interface RateLimiter

Type Parameters:

T - the resulting value of the call

Parameters:

call - the call to execute

Returns:

the result of the call

Throws:

java.lang.InterruptedException - if the waiting is interrupted