lib.easyjava.net.rest

Interface RateLimiter

All Known Implementing Classes:

MultiRateLimiter, SingleRateLimiter

public interface RateLimiter

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RateLimiter.Type

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

Method Detail

attemptCall

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

Executes the call only if calls are available

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

long millisUntilNextCall()

Returns:

the time in ms before a call becomes available

numCallsLeft

int numCallsLeft()

Returns:

the number of calls currently available

waitForCall

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

Executes the call, waiting for more calls if necessary

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