RateLimiter (resilience4j-ratelimiter 0.13.1 API)

All Known Implementing Classes:

AtomicRateLimiter, SemaphoreBasedRateLimiter
```
public interface RateLimiter
```
A RateLimiter instance is thread-safe can be used to decorate multiple requests.
A RateLimiter distributes permits at a configurable rate. getPermission(java.time.Duration) blocks if necessary until a permit is available, and then takes it. Once acquired, permits need not be released.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`RateLimiter.EventPublisher` An EventPublisher which can be used to register event consumers.
`static interface`	`RateLimiter.Metrics`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`changeLimitForPeriod(int limitForPeriod)` Dynamic rate limiter configuration change.
`void`	`changeTimeoutDuration(java.time.Duration timeoutDuration)` Dynamic rate limiter configuration change.
`static <T> java.util.concurrent.Callable<T>`	`decorateCallable(RateLimiter rateLimiter, java.util.concurrent.Callable<T> callable)`
`static <T,R> io.vavr.CheckedFunction1<T,R>`	`decorateCheckedFunction(RateLimiter rateLimiter, io.vavr.CheckedFunction1<T,R> function)` Creates a function which is restricted by a RateLimiter.
`static io.vavr.CheckedRunnable`	`decorateCheckedRunnable(RateLimiter rateLimiter, io.vavr.CheckedRunnable runnable)` Creates a runnable which is restricted by a RateLimiter.
`static <T> io.vavr.CheckedFunction0<T>`	`decorateCheckedSupplier(RateLimiter rateLimiter, io.vavr.CheckedFunction0<T> supplier)` Creates a supplier which is restricted by a RateLimiter.
`static <T> java.util.function.Supplier<java.util.concurrent.CompletionStage<T>>`	`decorateCompletionStage(RateLimiter rateLimiter, java.util.function.Supplier<java.util.concurrent.CompletionStage<T>> supplier)` Returns a supplier which is decorated by a rateLimiter.
`static <T> java.util.function.Consumer<T>`	`decorateConsumer(RateLimiter rateLimiter, java.util.function.Consumer<T> consumer)` Creates a consumer which is restricted by a RateLimiter.
`static <T,R> java.util.function.Function<T,R>`	`decorateFunction(RateLimiter rateLimiter, java.util.function.Function<T,R> function)` Creates a function which is restricted by a RateLimiter.
`static java.lang.Runnable`	`decorateRunnable(RateLimiter rateLimiter, java.lang.Runnable runnable)` Creates a runnable which is restricted by a RateLimiter.
`static <T> java.util.function.Supplier<T>`	`decorateSupplier(RateLimiter rateLimiter, java.util.function.Supplier<T> supplier)` Creates a supplier which is restricted by a RateLimiter.
`default <T> T`	`executeCallable(java.util.concurrent.Callable<T> callable)` Decorates and executes the decorated Callable.
`default void`	`executeRunnable(java.lang.Runnable runnable)` Decorates and executes the decorated Runnable.
`default <T> T`	`executeSupplier(java.util.function.Supplier<T> supplier)` Decorates and executes the decorated Supplier.
`RateLimiter.EventPublisher`	`getEventPublisher()` Returns an EventPublisher which can be used to register event consumers.
`RateLimiter.Metrics`	`getMetrics()` Get the Metrics of this RateLimiter.
`java.lang.String`	`getName()` Get the name of this RateLimiter
`boolean`	`getPermission(java.time.Duration timeoutDuration)` Acquires a permission from this rate limiter, blocking until one is available.
`RateLimiterConfig`	`getRateLimiterConfig()` Get the RateLimiterConfig of this RateLimiter.
`static RateLimiter`	`of(java.lang.String name, RateLimiterConfig rateLimiterConfig)` Creates a RateLimiter with a custom RateLimiter configuration.
`static RateLimiter`	`of(java.lang.String name, java.util.function.Supplier<RateLimiterConfig> rateLimiterConfigSupplier)` Creates a RateLimiter with a custom RateLimiterConfig configuration.
`static RateLimiter`	`ofDefaults(java.lang.String name)` Creates a RateLimiter with a default RateLimiterConfig configuration.
`long`	`reservePermission(java.time.Duration timeoutDuration)` Reserves a permission from this rate limiter and returns nanoseconds you should wait for it.
`static void`	`waitForPermission(RateLimiter rateLimiter)` Will wait for permission within default timeout duration.

- Method Detail
  - of
```
static RateLimiter of(java.lang.String name,
                      RateLimiterConfig rateLimiterConfig)
```
    Creates a RateLimiter with a custom RateLimiter configuration.
    
    Parameters:
    
    name - the name of the RateLimiter
    
    rateLimiterConfig - a custom RateLimiter configuration
    
    Returns:
    
    The RateLimiter
  - of
```
static RateLimiter of(java.lang.String name,
                      java.util.function.Supplier<RateLimiterConfig> rateLimiterConfigSupplier)
```
    Creates a RateLimiter with a custom RateLimiterConfig configuration.
    
    Parameters:
    
    name - the name of the RateLimiter
    
    rateLimiterConfigSupplier - a supplier of a custom RateLimiterConfig configuration
    
    Returns:
    
    The RateLimiter
  - ofDefaults
```
static RateLimiter ofDefaults(java.lang.String name)
```
    Creates a RateLimiter with a default RateLimiterConfig configuration.
    
    Parameters:
    
    name - the name of the RateLimiter
    
    Returns:
    
    The RateLimiter
  - decorateCompletionStage
```
static <T> java.util.function.Supplier<java.util.concurrent.CompletionStage<T>> decorateCompletionStage(RateLimiter rateLimiter,
                                                                                                        java.util.function.Supplier<java.util.concurrent.CompletionStage<T>> supplier)
```
    Returns a supplier which is decorated by a rateLimiter.
    
    Type Parameters:
    
    T - the type of the returned CompletionStage's result
    
    Parameters:
    
    rateLimiter - the rateLimiter
    
    supplier - the original supplier
    
    Returns:
    
    a supplier which is decorated by a RateLimiter.
  - decorateCheckedSupplier
```
static <T> io.vavr.CheckedFunction0<T> decorateCheckedSupplier(RateLimiter rateLimiter,
                                                               io.vavr.CheckedFunction0<T> supplier)
```
    Creates a supplier which is restricted by a RateLimiter.
    
    Type Parameters:
    
    T - the type of results supplied supplier
    
    Parameters:
    
    rateLimiter - the RateLimiter
    
    supplier - the original supplier
    
    Returns:
    
    a supplier which is restricted by a RateLimiter.
  - decorateCheckedRunnable
```
static io.vavr.CheckedRunnable decorateCheckedRunnable(RateLimiter rateLimiter,
                                                       io.vavr.CheckedRunnable runnable)
```
    Creates a runnable which is restricted by a RateLimiter.
    
    Parameters:
    
    rateLimiter - the RateLimiter
    
    runnable - the original runnable
    
    Returns:
    
    a runnable which is restricted by a RateLimiter.
  - decorateCheckedFunction
```
static <T,R> io.vavr.CheckedFunction1<T,R> decorateCheckedFunction(RateLimiter rateLimiter,
                                                                   io.vavr.CheckedFunction1<T,R> function)
```
    Creates a function which is restricted by a RateLimiter.
    
    Type Parameters:
    
    T - the type of function argument
    
    R - the type of function results
    
    Parameters:
    
    rateLimiter - the RateLimiter
    
    function - the original function
    
    Returns:
    
    a function which is restricted by a RateLimiter.
  - decorateSupplier
```
static <T> java.util.function.Supplier<T> decorateSupplier(RateLimiter rateLimiter,
                                                           java.util.function.Supplier<T> supplier)
```
    Creates a supplier which is restricted by a RateLimiter.
    
    Type Parameters:
    
    T - the type of results supplied supplier
    
    Parameters:
    
    rateLimiter - the RateLimiter
    
    supplier - the original supplier
    
    Returns:
    
    a supplier which is restricted by a RateLimiter.
  - decorateCallable
```
static <T> java.util.concurrent.Callable<T> decorateCallable(RateLimiter rateLimiter,
                                                             java.util.concurrent.Callable<T> callable)
```
  - decorateConsumer
```
static <T> java.util.function.Consumer<T> decorateConsumer(RateLimiter rateLimiter,
                                                           java.util.function.Consumer<T> consumer)
```
    Creates a consumer which is restricted by a RateLimiter.
    
    Type Parameters:
    
    T - the type of the input to the consumer
    
    Parameters:
    
    rateLimiter - the RateLimiter
    
    consumer - the original consumer
    
    Returns:
    
    a consumer which is restricted by a RateLimiter.
  - decorateRunnable
```
static java.lang.Runnable decorateRunnable(RateLimiter rateLimiter,
                                           java.lang.Runnable runnable)
```
    Creates a runnable which is restricted by a RateLimiter.
    
    Parameters:
    
    rateLimiter - the RateLimiter
    
    runnable - the original runnable
    
    Returns:
    
    a runnable which is restricted by a RateLimiter.
  - decorateFunction
```
static <T,R> java.util.function.Function<T,R> decorateFunction(RateLimiter rateLimiter,
                                                               java.util.function.Function<T,R> function)
```
    Creates a function which is restricted by a RateLimiter.
    
    Type Parameters:
    
    T - the type of the input to the function
    
    R - the type of the result of the function
    
    Parameters:
    
    rateLimiter - the RateLimiter
    
    function - the original function
    
    Returns:
    
    a function which is restricted by a RateLimiter.
  - waitForPermission
```
static void waitForPermission(RateLimiter rateLimiter)
                       throws java.lang.IllegalStateException,
                              RequestNotPermitted
```
    Will wait for permission within default timeout duration.
    
    Parameters:
    
    rateLimiter - the RateLimiter to get permission from
    
    Throws:
    
    RequestNotPermitted - if waiting time elapsed before a permit was acquired.
    
    java.lang.IllegalStateException - if thread was interrupted during permission wait
  - changeTimeoutDuration
```
void changeTimeoutDuration(java.time.Duration timeoutDuration)
```
    Dynamic rate limiter configuration change. This method allows to change timeout duration of current limiter. NOTE! New timeout duration won't affect threads that are currently waiting for permission.
    
    Parameters:
    
    timeoutDuration - new timeout duration
  - changeLimitForPeriod
```
void changeLimitForPeriod(int limitForPeriod)
```
    Dynamic rate limiter configuration change. This method allows to change count of permissions available during refresh period. NOTE! New limit won't affect current period permissions and will apply only from next one.
    
    Parameters:
    
    limitForPeriod - new permissions limit
  - getPermission
```
boolean getPermission(java.time.Duration timeoutDuration)
```
    Acquires a permission from this rate limiter, blocking until one is available.
    If the current thread is interrupted while waiting for a permit then it won't throw InterruptedException, but its interrupt status will be set.
    
    Parameters:
    
    timeoutDuration - the maximum time to wait
    
    Returns:
    
    true if a permit was acquired and false if waiting timeoutDuration elapsed before a permit was acquired
  - reservePermission
```
long reservePermission(java.time.Duration timeoutDuration)
```
    Reserves a permission from this rate limiter and returns nanoseconds you should wait for it. If returned long is negative, it means that you failed to reserve permission, possibly your timeoutDuration is less then time to wait for permission.
    
    Parameters:
    
    timeoutDuration - the maximum time you want to wait.
    
    Returns:
    
    long amount of nanoseconds you should wait for reserved permission. if negative, it means you failed to reserve.
  - getName
```
java.lang.String getName()
```
    Get the name of this RateLimiter
    
    Returns:
    
    the name of this RateLimiter
  - getRateLimiterConfig
```
RateLimiterConfig getRateLimiterConfig()
```
    Get the RateLimiterConfig of this RateLimiter.
    
    Returns:
    
    the RateLimiterConfig of this RateLimiter
  - getMetrics
```
RateLimiter.Metrics getMetrics()
```
    Get the Metrics of this RateLimiter.
    
    Returns:
    
    the Metrics of this RateLimiter
  - getEventPublisher
```
RateLimiter.EventPublisher getEventPublisher()
```
    Returns an EventPublisher which can be used to register event consumers.
    
    Returns:
    
    an EventPublisher
  - executeSupplier
```
default <T> T executeSupplier(java.util.function.Supplier<T> supplier)
```
    Decorates and executes the decorated Supplier.
    
    Type Parameters:
    
    T - the type of results supplied by this supplier
    
    Parameters:
    
    supplier - the original Supplier
    
    Returns:
    
    the result of the decorated Supplier.
  - executeCallable
```
default <T> T executeCallable(java.util.concurrent.Callable<T> callable)
                       throws java.lang.Exception
```
    Decorates and executes the decorated Callable.
    
    Type Parameters:
    
    T - the result type of callable
    
    Parameters:
    
    callable - the original Callable
    
    Returns:
    
    the result of the decorated Callable.
    
    Throws:
    
    java.lang.Exception - if unable to compute a result
  - executeRunnable
```
default void executeRunnable(java.lang.Runnable runnable)
```
    Decorates and executes the decorated Runnable.
    
    Parameters:
    
    runnable - the original Runnable

Interface RateLimiter

Nested Class Summary

Method Summary

Method Detail

of

of

ofDefaults

decorateCompletionStage

decorateCheckedSupplier

decorateCheckedRunnable

decorateCheckedFunction

decorateSupplier

decorateCallable

decorateConsumer

decorateRunnable

decorateFunction

waitForPermission

changeTimeoutDuration

changeLimitForPeriod

getPermission

reservePermission

getName

getRateLimiterConfig

getMetrics

getEventPublisher

executeSupplier

executeCallable

executeRunnable