lib.easyjava.net.rest

Class SingleRateLimiter

java.lang.Object

lib.easyjava.net.rest.SingleRateLimiter

All Implemented Interfaces:

RateLimiter

public class SingleRateLimiter
extends java.lang.Object
implements RateLimiter

Used to limit the rate of calls to some function or API.

Author:

Rob Rua

Nested Class Summary

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

RateLimiter.Type

Constructor Summary

Constructors

Constructor and Description
SingleRateLimiter(RateLimiter.Type type, int callsPerEpoch, long millisPerEpoch)

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

SingleRateLimiter

public SingleRateLimiter(RateLimiter.Type type,
                         int callsPerEpoch,
                         long millisPerEpoch)

Parameters:

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

callsPerEpoch - the number of calls that can go through each epoch

millisPerEpoch - the length of an epoch

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