Index (resilience4j-ratelimiter 0.13.1 API)

A B C D E F G I L M O R S T V W

A

AbstractRateLimiterEvent - Class in io.github.resilience4j.ratelimiter.event
AbstractRateLimiterEvent(String) - Constructor for class io.github.resilience4j.ratelimiter.event.AbstractRateLimiterEvent
AtomicRateLimiter - Class in io.github.resilience4j.ratelimiter.internal: AtomicRateLimiter splits all nanoseconds from the start of epoch into cycles.
AtomicRateLimiter(String, RateLimiterConfig) - Constructor for class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter
AtomicRateLimiter.AtomicRateLimiterMetrics - Class in io.github.resilience4j.ratelimiter.internal: Enhanced Metrics with some implementation specific details
AVAILABLE_PERMISSIONS - Static variable in class io.github.resilience4j.ratelimiter.utils.MetricNames

B

build() - Method in class io.github.resilience4j.ratelimiter.RateLimiterConfig.Builder: Builds a RateLimiterConfig
Builder() - Constructor for class io.github.resilience4j.ratelimiter.RateLimiterConfig.Builder
Builder(RateLimiterConfig) - Constructor for class io.github.resilience4j.ratelimiter.RateLimiterConfig.Builder

C

changeLimitForPeriod(int) - Method in class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter: Dynamic rate limiter configuration change.
changeLimitForPeriod(int) - Method in class io.github.resilience4j.ratelimiter.internal.SemaphoreBasedRateLimiter: Dynamic rate limiter configuration change.
changeLimitForPeriod(int) - Method in interface io.github.resilience4j.ratelimiter.RateLimiter: Dynamic rate limiter configuration change.
changeTimeoutDuration(Duration) - Method in class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter: Dynamic rate limiter configuration change.
changeTimeoutDuration(Duration) - Method in class io.github.resilience4j.ratelimiter.internal.SemaphoreBasedRateLimiter: Dynamic rate limiter configuration change.
changeTimeoutDuration(Duration) - Method in interface io.github.resilience4j.ratelimiter.RateLimiter: Dynamic rate limiter configuration change.
consumeEvent(RateLimiterEvent) - Method in class io.github.resilience4j.ratelimiter.internal.RateLimiterEventProcessor
custom() - Static method in class io.github.resilience4j.ratelimiter.RateLimiterConfig: Returns a builder to create a custom RateLimiterConfig.

D

decorateCallable(RateLimiter, Callable<T>) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter
decorateCheckedFunction(RateLimiter, CheckedFunction1<T, R>) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter: Creates a function which is restricted by a RateLimiter.
decorateCheckedRunnable(RateLimiter, CheckedRunnable) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter: Creates a runnable which is restricted by a RateLimiter.
decorateCheckedSupplier(RateLimiter, CheckedFunction0<T>) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter: Creates a supplier which is restricted by a RateLimiter.
decorateCompletionStage(RateLimiter, Supplier<CompletionStage<T>>) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter: Returns a supplier which is decorated by a rateLimiter.
decorateConsumer(RateLimiter, Consumer<T>) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter: Creates a consumer which is restricted by a RateLimiter.
decorateFunction(RateLimiter, Function<T, R>) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter: Creates a function which is restricted by a RateLimiter.
decorateRunnable(RateLimiter, Runnable) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter: Creates a runnable which is restricted by a RateLimiter.
decorateSupplier(RateLimiter, Supplier<T>) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter: Creates a supplier which is restricted by a RateLimiter.
DEFAULT_PREFIX - Static variable in class io.github.resilience4j.ratelimiter.utils.MetricNames

E

executeCallable(Callable<T>) - Method in interface io.github.resilience4j.ratelimiter.RateLimiter: Decorates and executes the decorated Callable.
executeRunnable(Runnable) - Method in interface io.github.resilience4j.ratelimiter.RateLimiter: Decorates and executes the decorated Runnable.
executeSupplier(Supplier<T>) - Method in interface io.github.resilience4j.ratelimiter.RateLimiter: Decorates and executes the decorated Supplier.

F

from(RateLimiterConfig) - Static method in class io.github.resilience4j.ratelimiter.RateLimiterConfig: Returns a builder to create a custom RateLimiterConfig using specified config as prototype

G

getAllRateLimiters() - Method in class io.github.resilience4j.ratelimiter.internal.InMemoryRateLimiterRegistry: Returns all managed RateLimiter instances.
getAllRateLimiters() - Method in interface io.github.resilience4j.ratelimiter.RateLimiterRegistry: Returns all managed RateLimiter instances.
getAvailablePermissions() - Method in class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter.AtomicRateLimiterMetrics: Estimates count of available permissions.
getAvailablePermissions() - Method in interface io.github.resilience4j.ratelimiter.RateLimiter.Metrics: Estimates count of available permissions.
getCreationTime() - Method in class io.github.resilience4j.ratelimiter.event.AbstractRateLimiterEvent
getCreationTime() - Method in interface io.github.resilience4j.ratelimiter.event.RateLimiterEvent
getCycle() - Method in class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter.AtomicRateLimiterMetrics
getDetailedMetrics() - Method in class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter: Get the enhanced Metrics with some implementation specific details.
getEventPublisher() - Method in class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter
getEventPublisher() - Method in class io.github.resilience4j.ratelimiter.internal.SemaphoreBasedRateLimiter
getEventPublisher() - Method in interface io.github.resilience4j.ratelimiter.RateLimiter: Returns an EventPublisher which can be used to register event consumers.
getEventType() - Method in class io.github.resilience4j.ratelimiter.event.AbstractRateLimiterEvent
getEventType() - Method in interface io.github.resilience4j.ratelimiter.event.RateLimiterEvent
getEventType() - Method in class io.github.resilience4j.ratelimiter.event.RateLimiterOnFailureEvent
getEventType() - Method in class io.github.resilience4j.ratelimiter.event.RateLimiterOnSuccessEvent
getLimitForPeriod() - Method in class io.github.resilience4j.ratelimiter.RateLimiterConfig
getLimitRefreshPeriod() - Method in class io.github.resilience4j.ratelimiter.RateLimiterConfig
getLimitRefreshPeriodInNanos() - Method in class io.github.resilience4j.ratelimiter.RateLimiterConfig
getMetrics() - Method in class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter: Get the Metrics of this RateLimiter.
getMetrics() - Method in class io.github.resilience4j.ratelimiter.internal.SemaphoreBasedRateLimiter: Get the Metrics of this RateLimiter.
getMetrics() - Method in interface io.github.resilience4j.ratelimiter.RateLimiter: Get the Metrics of this RateLimiter.
getName() - Method in class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter: Get the name of this RateLimiter
getName() - Method in class io.github.resilience4j.ratelimiter.internal.SemaphoreBasedRateLimiter: Get the name of this RateLimiter
getName() - Method in interface io.github.resilience4j.ratelimiter.RateLimiter: Get the name of this RateLimiter
getNanosToWait() - Method in class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter.AtomicRateLimiterMetrics
getNumberOfWaitingThreads() - Method in class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter.AtomicRateLimiterMetrics: Returns an estimate of the number of threads waiting for permission in this JVM process.
getNumberOfWaitingThreads() - Method in interface io.github.resilience4j.ratelimiter.RateLimiter.Metrics: Returns an estimate of the number of threads waiting for permission in this JVM process.
getPermission(Duration) - Method in class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter: Acquires a permission from this rate limiter, blocking until one is available.
getPermission(Duration) - Method in class io.github.resilience4j.ratelimiter.internal.SemaphoreBasedRateLimiter: Acquires a permission from this rate limiter, blocking until one is available.
getPermission(Duration) - Method in interface io.github.resilience4j.ratelimiter.RateLimiter: Acquires a permission from this rate limiter, blocking until one is available.
getRateLimiterConfig() - Method in class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter: Get the RateLimiterConfig of this RateLimiter.
getRateLimiterConfig() - Method in class io.github.resilience4j.ratelimiter.internal.SemaphoreBasedRateLimiter: Get the RateLimiterConfig of this RateLimiter.
getRateLimiterConfig() - Method in interface io.github.resilience4j.ratelimiter.RateLimiter: Get the RateLimiterConfig of this RateLimiter.
getRateLimiterName() - Method in class io.github.resilience4j.ratelimiter.event.AbstractRateLimiterEvent
getRateLimiterName() - Method in interface io.github.resilience4j.ratelimiter.event.RateLimiterEvent
getTimeoutDuration() - Method in class io.github.resilience4j.ratelimiter.RateLimiterConfig
getTimeoutDurationInNanos() - Method in class io.github.resilience4j.ratelimiter.RateLimiterConfig

I

InMemoryRateLimiterRegistry - Class in io.github.resilience4j.ratelimiter.internal: Backend RateLimiter manager.
InMemoryRateLimiterRegistry(RateLimiterConfig) - Constructor for class io.github.resilience4j.ratelimiter.internal.InMemoryRateLimiterRegistry
io.github.resilience4j.ratelimiter - package io.github.resilience4j.ratelimiter
io.github.resilience4j.ratelimiter.event - package io.github.resilience4j.ratelimiter.event
io.github.resilience4j.ratelimiter.internal - package io.github.resilience4j.ratelimiter.internal
io.github.resilience4j.ratelimiter.utils - package io.github.resilience4j.ratelimiter.utils

L

limitForPeriod(int) - Method in class io.github.resilience4j.ratelimiter.RateLimiterConfig.Builder: Configures the permissions limit for refresh period.
limitRefreshPeriod(Duration) - Method in class io.github.resilience4j.ratelimiter.RateLimiterConfig.Builder: Configures the period of limit refresh.

M

MetricNames - Class in io.github.resilience4j.ratelimiter.utils
MetricNames() - Constructor for class io.github.resilience4j.ratelimiter.utils.MetricNames

O

of(String, RateLimiterConfig) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter: Creates a RateLimiter with a custom RateLimiter configuration.
of(String, Supplier<RateLimiterConfig>) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter: Creates a RateLimiter with a custom RateLimiterConfig configuration.
of(RateLimiterConfig) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiterRegistry
ofDefaults(String) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter: Creates a RateLimiter with a default RateLimiterConfig configuration.
ofDefaults() - Static method in class io.github.resilience4j.ratelimiter.RateLimiterConfig: Creates a default RateLimiter configuration.
ofDefaults() - Static method in interface io.github.resilience4j.ratelimiter.RateLimiterRegistry: Returns a managed RateLimiterConfig or creates a new one with a default RateLimiterConfig configuration.
onFailure(EventConsumer<RateLimiterOnFailureEvent>) - Method in class io.github.resilience4j.ratelimiter.internal.RateLimiterEventProcessor
onFailure(EventConsumer<RateLimiterOnFailureEvent>) - Method in interface io.github.resilience4j.ratelimiter.RateLimiter.EventPublisher
onSuccess(EventConsumer<RateLimiterOnSuccessEvent>) - Method in class io.github.resilience4j.ratelimiter.internal.RateLimiterEventProcessor
onSuccess(EventConsumer<RateLimiterOnSuccessEvent>) - Method in interface io.github.resilience4j.ratelimiter.RateLimiter.EventPublisher

R

rateLimiter(String) - Method in class io.github.resilience4j.ratelimiter.internal.InMemoryRateLimiterRegistry: Returns a managed RateLimiter or creates a new one with the default RateLimiter configuration.
rateLimiter(String, RateLimiterConfig) - Method in class io.github.resilience4j.ratelimiter.internal.InMemoryRateLimiterRegistry: Returns a managed RateLimiter or creates a new one with a custom RateLimiter configuration.
rateLimiter(String, Supplier<RateLimiterConfig>) - Method in class io.github.resilience4j.ratelimiter.internal.InMemoryRateLimiterRegistry: Returns a managed RateLimiterConfig or creates a new one with a custom RateLimiterConfig configuration.
RateLimiter - Interface in io.github.resilience4j.ratelimiter: A RateLimiter instance is thread-safe can be used to decorate multiple requests.
rateLimiter(String) - Method in interface io.github.resilience4j.ratelimiter.RateLimiterRegistry: Returns a managed RateLimiter or creates a new one with the default RateLimiter configuration.
rateLimiter(String, RateLimiterConfig) - Method in interface io.github.resilience4j.ratelimiter.RateLimiterRegistry: Returns a managed RateLimiter or creates a new one with a custom RateLimiter configuration.
rateLimiter(String, Supplier<RateLimiterConfig>) - Method in interface io.github.resilience4j.ratelimiter.RateLimiterRegistry: Returns a managed RateLimiterConfig or creates a new one with a custom RateLimiterConfig configuration.
RateLimiter.EventPublisher - Interface in io.github.resilience4j.ratelimiter: An EventPublisher which can be used to register event consumers.
RateLimiter.Metrics - Interface in io.github.resilience4j.ratelimiter
RateLimiterConfig - Class in io.github.resilience4j.ratelimiter
RateLimiterConfig.Builder - Class in io.github.resilience4j.ratelimiter
RateLimiterEvent - Interface in io.github.resilience4j.ratelimiter.event: An event which is created by a RateLimiter.
RateLimiterEvent.Type - Enum in io.github.resilience4j.ratelimiter.event
RateLimiterEventProcessor - Class in io.github.resilience4j.ratelimiter.internal
RateLimiterEventProcessor() - Constructor for class io.github.resilience4j.ratelimiter.internal.RateLimiterEventProcessor
RateLimiterOnFailureEvent - Class in io.github.resilience4j.ratelimiter.event
RateLimiterOnFailureEvent(String) - Constructor for class io.github.resilience4j.ratelimiter.event.RateLimiterOnFailureEvent
RateLimiterOnSuccessEvent - Class in io.github.resilience4j.ratelimiter.event
RateLimiterOnSuccessEvent(String) - Constructor for class io.github.resilience4j.ratelimiter.event.RateLimiterOnSuccessEvent
RateLimiterRegistry - Interface in io.github.resilience4j.ratelimiter: Manages all RateLimiter instances.
RequestNotPermitted - Exception in io.github.resilience4j.ratelimiter: Exception that indicates that current thread was not able to acquire permission from RateLimiter.
RequestNotPermitted(String) - Constructor for exception io.github.resilience4j.ratelimiter.RequestNotPermitted: The constructor with a message.
reservePermission(Duration) - Method in class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter: Reserves a permission from this rate limiter and returns nanoseconds you should wait for it.
reservePermission(Duration) - Method in class io.github.resilience4j.ratelimiter.internal.SemaphoreBasedRateLimiter: Reserves a permission from this rate limiter and returns nanoseconds you should wait for it.
reservePermission(Duration) - Method in interface io.github.resilience4j.ratelimiter.RateLimiter: Reserves a permission from this rate limiter and returns nanoseconds you should wait for it.

S

SemaphoreBasedRateLimiter - Class in io.github.resilience4j.ratelimiter.internal: A RateLimiter implementation that consists of Semaphore and scheduler that will refresh permissions after each RateLimiterConfig.limitRefreshPeriod.
SemaphoreBasedRateLimiter(String, RateLimiterConfig) - Constructor for class io.github.resilience4j.ratelimiter.internal.SemaphoreBasedRateLimiter: Creates a RateLimiter.
SemaphoreBasedRateLimiter(String, RateLimiterConfig, ScheduledExecutorService) - Constructor for class io.github.resilience4j.ratelimiter.internal.SemaphoreBasedRateLimiter: Creates a RateLimiter.

T

timeoutDuration(Duration) - Method in class io.github.resilience4j.ratelimiter.RateLimiterConfig.Builder: Configures the default wait for permission duration.
toString() - Method in class io.github.resilience4j.ratelimiter.event.AbstractRateLimiterEvent
toString() - Method in class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter
toString() - Method in class io.github.resilience4j.ratelimiter.internal.SemaphoreBasedRateLimiter
toString() - Method in class io.github.resilience4j.ratelimiter.RateLimiterConfig

V

valueOf(String) - Static method in enum io.github.resilience4j.ratelimiter.event.RateLimiterEvent.Type: Returns the enum constant of this type with the specified name.
values() - Static method in enum io.github.resilience4j.ratelimiter.event.RateLimiterEvent.Type: Returns an array containing the constants of this enum type, in the order they are declared.

W

waitForPermission(RateLimiter) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter: Will wait for permission within default timeout duration.
WAITING_THREADS - Static variable in class io.github.resilience4j.ratelimiter.utils.MetricNames

A B C D E F G I L M O R S T V W