org.rnorth.ducttape.ratelimits

Class RateLimiter

java.lang.Object

org.rnorth.ducttape.ratelimits.RateLimiter

public abstract class RateLimiter
extends Object

Base class for rate limiters. Use RateLimiterBuilder to build new instances.

Constructor Summary

Constructors

Constructor and Description
RateLimiter()

Method Summary

Modifier and Type	Method and Description
void	doWhenReady(@NotNull Runnable lambda) Invoke a lambda function, with Thread.sleep() being called to limit the execution rate if needed.
<T> T	getWhenReady(@NotNull Callable<T> lambda) Invoke a lambda function and get the result, with Thread.sleep() being called to limit the execution rate if needed.

Methods inherited from class java.lang.Object

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

Constructor Detail

RateLimiter

public RateLimiter()

Method Detail

doWhenReady

public void doWhenReady(@NotNull
                        @NotNull Runnable lambda)

Invoke a lambda function, with Thread.sleep() being called to limit the execution rate if needed.

Parameters:

lambda - a Runnable lamda function to invoke

getWhenReady

public <T> T getWhenReady(@NotNull
                          @NotNull Callable<T> lambda)
                   throws Exception

Invoke a lambda function and get the result, with Thread.sleep() being called to limit the execution rate if needed.

Type Parameters:

T - return type of the lamda

Parameters:

lambda - a Callable lamda function to invoke

Returns:

result of the lambda call

Throws:

Exception - rethrown from lambda