Index

A B C D E F G I L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractRateLimiterEvent - Class in io.github.resilience4j.ratelimiter.event

AbstractRateLimiterEvent(String) - Constructor for class io.github.resilience4j.ratelimiter.event.AbstractRateLimiterEvent

AbstractRateLimiterEvent(String, int) - Constructor for class io.github.resilience4j.ratelimiter.event.AbstractRateLimiterEvent

ACCEPTABLE_REFRESH_PERIOD - Static variable in class io.github.resilience4j.ratelimiter.RateLimiterConfig

acquirePermission() - Method in interface io.github.resilience4j.ratelimiter.RateLimiter

Acquires a permission from this rate limiter, blocking until one is available, or the thread is interrupted.

acquirePermission(int) - Method in class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter

Acquires the given number of permits from this rate limiter, blocking until one is available, or the thread is interrupted.

acquirePermission(int) - Method in class io.github.resilience4j.ratelimiter.internal.SemaphoreBasedRateLimiter

Acquires the given number of permits from this rate limiter, blocking until one is available, or the thread is interrupted.

acquirePermission(int) - Method in interface io.github.resilience4j.ratelimiter.RateLimiter

Acquires the given number of permits from this rate limiter, blocking until one is available, or the thread is interrupted.

activeCycle - Variable in class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter.State

activePermissions - Variable in class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter.State

addRateLimiterConfig(String, RateLimiterConfig) - Method in class io.github.resilience4j.ratelimiter.RateLimiterRegistry.Builder

Configures a RateLimiterRegistry with a custom RateLimiter configuration.

addRegistryEventConsumer(RegistryEventConsumer) - Method in class io.github.resilience4j.ratelimiter.RateLimiterRegistry.Builder

Configures a RateLimiterRegistry with a RateLimiter registry event consumer.

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(String, RateLimiterConfig, Map) - Constructor for class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter

AtomicRateLimiter.AtomicRateLimiterMetrics - Class in io.github.resilience4j.ratelimiter.internal

Enhanced RateLimiter.Metrics with some implementation specific details

AtomicRateLimiter.State - Class in io.github.resilience4j.ratelimiter.internal

AtomicRateLimiter.State represents immutable state of AtomicRateLimiter where: activeCycle - AtomicRateLimiter cycle number that was used by the last RateLimiter.acquirePermission() call.

AtomicRateLimiterMetrics() - Constructor for class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter.AtomicRateLimiterMetrics

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

build() - Method in class io.github.resilience4j.ratelimiter.RateLimiterRegistry.Builder

Builds a RateLimiterRegistry

Builder() - Constructor for class io.github.resilience4j.ratelimiter.RateLimiterConfig.Builder

Builder() - Constructor for class io.github.resilience4j.ratelimiter.RateLimiterRegistry.Builder

Builder(RateLimiterConfig) - Constructor for class io.github.resilience4j.ratelimiter.RateLimiterConfig.Builder

C

calculateNextState(int, long, AtomicRateLimiter.State) - Method in class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter

A side-effect-free function that can calculate next AtomicRateLimiter.State from current.

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.

checkLimitForPeriod(int) - Static method in class io.github.resilience4j.ratelimiter.RateLimiterConfig

checkLimitRefreshPeriod(Duration) - Static method in class io.github.resilience4j.ratelimiter.RateLimiterConfig

checkTimeoutDuration(Duration) - Static method in class io.github.resilience4j.ratelimiter.RateLimiterConfig

compareAndSet(AtomicRateLimiter.State, AtomicRateLimiter.State) - Method in class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter

Atomically sets the value to the given updated value if the current value == the expected value.

config - Variable in class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter.State

CONFIG_MUST_NOT_BE_NULL - Static variable in class io.github.resilience4j.ratelimiter.internal.SemaphoreBasedRateLimiter

configureScheduler() - Method in class io.github.resilience4j.ratelimiter.internal.SemaphoreBasedRateLimiter

consumeEvent(RateLimiterEvent) - Method in class io.github.resilience4j.ratelimiter.internal.RateLimiterEventProcessor

createRequestNotPermitted(RateLimiter) - Static method in exception class io.github.resilience4j.ratelimiter.RequestNotPermitted

Static method to construct a RequestNotPermitted with a RateLimiter.

creationTime - Variable in class io.github.resilience4j.ratelimiter.event.AbstractRateLimiterEvent

currentNanoTime() - Method in class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter

Calculates time elapsed from the class loading.

custom() - Static method in class io.github.resilience4j.ratelimiter.RateLimiterConfig

Returns a builder to create a custom RateLimiterConfig.

custom() - Static method in interface io.github.resilience4j.ratelimiter.RateLimiterRegistry

Returns a builder to create a custom RateLimiterRegistry.

D

decorateCallable(RateLimiter, int, Callable) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter

Creates a callable which is restricted by a RateLimiter.

decorateCallable(RateLimiter, Callable) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter

Creates a callable which is restricted by a RateLimiter.

decorateCheckedFunction(RateLimiter, int, CheckedFunction) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter

Creates a function which is restricted by a RateLimiter.

decorateCheckedFunction(RateLimiter, CheckedFunction) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter

Creates a function which is restricted by a RateLimiter.

decorateCheckedFunction(RateLimiter, Function, CheckedFunction) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter

Creates a function which is restricted by a RateLimiter.

decorateCheckedRunnable(RateLimiter, int, CheckedRunnable) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter

Creates a runnable 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, int, CheckedSupplier) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter

Creates a supplier which is restricted by a RateLimiter.

decorateCheckedSupplier(RateLimiter, CheckedSupplier) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter

Creates a supplier which is restricted by a RateLimiter.

decorateCompletionStage(RateLimiter, int, Supplier) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter

Returns a supplier which is decorated by a rateLimiter.

decorateCompletionStage(RateLimiter, Supplier) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter

Returns a supplier which is decorated by a rateLimiter.

decorateConsumer(RateLimiter, int, Consumer) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter

Creates a consumer which is restricted by a RateLimiter.

decorateConsumer(RateLimiter, Consumer) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter

Creates a consumer which is restricted by a RateLimiter.

decorateConsumer(RateLimiter, Function, Consumer) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter

Creates a consumer which is restricted by a RateLimiter.

decorateFunction(RateLimiter, int, Function) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter

Creates a function which is restricted by a RateLimiter.

decorateFunction(RateLimiter, Function, Function) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter

Creates a function which is restricted by a RateLimiter.

decorateFunction(RateLimiter, Function) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter

Creates a function which is restricted by a RateLimiter.

decorateFuture(RateLimiter, int, Supplier) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter

Returns a Supplier which is decorated by a RateLimiter.

decorateFuture(RateLimiter, Supplier) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter

Returns a Supplier which is decorated by a RateLimiter.

decorateRunnable(RateLimiter, int, Runnable) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter

Creates a runnable 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, int, Supplier) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter

Creates a supplier which is restricted by a RateLimiter.

decorateSupplier(RateLimiter, Supplier) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter

Creates a supplier which is restricted by a RateLimiter.

DEFAULT_CONFIG - Static variable in class io.github.resilience4j.ratelimiter.RateLimiterRegistry.Builder

DEFAULT_PREFIX - Static variable in class io.github.resilience4j.ratelimiter.utils.MetricNames

DEFAULT_WRITABLE_STACK_TRACE_ENABLED - Static variable in class io.github.resilience4j.ratelimiter.RateLimiterConfig

divCeil(int, int) - Static method in class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter

Divide two integers and round result to the bigger near mathematical integer.

DRAINED - Enum constant in enum class io.github.resilience4j.ratelimiter.event.RateLimiterEvent.Type

drainIfNeeded(Either) - Method in interface io.github.resilience4j.ratelimiter.RateLimiter

Deprecated.

because of changing visibility to private in Java9+

drainPermissions() - Method in class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter

drainPermissions() - Method in class io.github.resilience4j.ratelimiter.internal.SemaphoreBasedRateLimiter

drainPermissions() - Method in interface io.github.resilience4j.ratelimiter.RateLimiter

Drains all the permits left in the current period.

drainPermissionsOnResult - Variable in class io.github.resilience4j.ratelimiter.RateLimiterConfig.Builder

drainPermissionsOnResult - Variable in class io.github.resilience4j.ratelimiter.RateLimiterConfig

drainPermissionsOnResult(Predicate) - Method in class io.github.resilience4j.ratelimiter.RateLimiterConfig.Builder

Allows you to check the result of a call decorated by this rate limiter and make a decision should we drain all the permissions left it the current period.

E

eventProcessor - Variable in class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter

eventProcessor - Variable in class io.github.resilience4j.ratelimiter.internal.SemaphoreBasedRateLimiter

executeCallable(int, Callable) - Method in interface io.github.resilience4j.ratelimiter.RateLimiter

Decorates and executes the decorated Callable.

executeCallable(Callable) - Method in interface io.github.resilience4j.ratelimiter.RateLimiter

Decorates and executes the decorated Callable.

executeCheckedSupplier(int, CheckedSupplier) - Method in interface io.github.resilience4j.ratelimiter.RateLimiter

Decorates and executes the decorated Supplier.

executeCheckedSupplier(CheckedSupplier) - Method in interface io.github.resilience4j.ratelimiter.RateLimiter

Decorates and executes the decorated Supplier.

executeCompletionStage(Supplier) - Method in interface io.github.resilience4j.ratelimiter.RateLimiter

Decorates and executes the decorated CompletionStage.

executeRunnable(int, Runnable) - Method in interface io.github.resilience4j.ratelimiter.RateLimiter

Decorates and executes the decorated Runnable.

executeRunnable(Runnable) - Method in interface io.github.resilience4j.ratelimiter.RateLimiter

Decorates and executes the decorated Runnable.

executeSupplier(int, Supplier) - Method in interface io.github.resilience4j.ratelimiter.RateLimiter

Decorates and executes the decorated Supplier.

executeSupplier(Supplier) - Method in interface io.github.resilience4j.ratelimiter.RateLimiter

Decorates and executes the decorated Supplier.

F

FAILED_ACQUIRE - Enum constant in enum class io.github.resilience4j.ratelimiter.event.RateLimiterEvent.Type

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 class io.github.resilience4j.ratelimiter.internal.SemaphoreBasedRateLimiter.SemaphoreBasedRateLimiterMetrics

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.

getDrainPermissionsOnResult() - Method in class io.github.resilience4j.ratelimiter.RateLimiterConfig

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 interface io.github.resilience4j.ratelimiter.event.RateLimiterEvent

getEventType() - Method in class io.github.resilience4j.ratelimiter.event.RateLimiterOnDrainedEvent

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

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

getNanoTimeStart() - Method in class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter

getNumberOfPermits() - Method in class io.github.resilience4j.ratelimiter.event.AbstractRateLimiterEvent

getNumberOfPermits() - Method in interface io.github.resilience4j.ratelimiter.event.RateLimiterEvent

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 class io.github.resilience4j.ratelimiter.internal.SemaphoreBasedRateLimiter.SemaphoreBasedRateLimiterMetrics

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.

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

getTags() - Method in class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter

Returns an unmodifiable map with tags assigned to this RateLimiter.

getTags() - Method in class io.github.resilience4j.ratelimiter.internal.SemaphoreBasedRateLimiter

getTags() - Method in interface io.github.resilience4j.ratelimiter.RateLimiter

Returns an unmodifiable map with tags assigned to this RateLimiter.

getTimeoutDuration() - Method in class io.github.resilience4j.ratelimiter.RateLimiterConfig

I

InMemoryRateLimiterRegistry - Class in io.github.resilience4j.ratelimiter.internal

Backend RateLimiter manager.

InMemoryRateLimiterRegistry() - Constructor for class io.github.resilience4j.ratelimiter.internal.InMemoryRateLimiterRegistry

The constructor with default default.

InMemoryRateLimiterRegistry(RateLimiterConfig) - Constructor for class io.github.resilience4j.ratelimiter.internal.InMemoryRateLimiterRegistry

The constructor with custom default config.

InMemoryRateLimiterRegistry(RateLimiterConfig, RegistryEventConsumer) - Constructor for class io.github.resilience4j.ratelimiter.internal.InMemoryRateLimiterRegistry

InMemoryRateLimiterRegistry(RateLimiterConfig, RegistryEventConsumer, Map) - Constructor for class io.github.resilience4j.ratelimiter.internal.InMemoryRateLimiterRegistry

InMemoryRateLimiterRegistry(RateLimiterConfig, List) - Constructor for class io.github.resilience4j.ratelimiter.internal.InMemoryRateLimiterRegistry

InMemoryRateLimiterRegistry(RateLimiterConfig, List, Map) - Constructor for class io.github.resilience4j.ratelimiter.internal.InMemoryRateLimiterRegistry

InMemoryRateLimiterRegistry(RateLimiterConfig, Map) - Constructor for class io.github.resilience4j.ratelimiter.internal.InMemoryRateLimiterRegistry

InMemoryRateLimiterRegistry(Map) - Constructor for class io.github.resilience4j.ratelimiter.internal.InMemoryRateLimiterRegistry

InMemoryRateLimiterRegistry(Map, RegistryEventConsumer) - Constructor for class io.github.resilience4j.ratelimiter.internal.InMemoryRateLimiterRegistry

InMemoryRateLimiterRegistry(Map, RegistryEventConsumer, Map) - Constructor for class io.github.resilience4j.ratelimiter.internal.InMemoryRateLimiterRegistry

InMemoryRateLimiterRegistry(Map, List) - Constructor for class io.github.resilience4j.ratelimiter.internal.InMemoryRateLimiterRegistry

InMemoryRateLimiterRegistry(Map, List, Map) - Constructor for class io.github.resilience4j.ratelimiter.internal.InMemoryRateLimiterRegistry

InMemoryRateLimiterRegistry(Map, List, Map, RegistryStore) - Constructor for class io.github.resilience4j.ratelimiter.internal.InMemoryRateLimiterRegistry

InMemoryRateLimiterRegistry(Map, Map) - 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

isWritableStackTraceEnabled() - Method in class io.github.resilience4j.ratelimiter.RateLimiterConfig

L

LIMIT_REFRESH_PERIOD_MUST_NOT_BE_NULL - Static variable in class io.github.resilience4j.ratelimiter.RateLimiterConfig

LIMIT_REFRESH_PERIOD_TOO_LARGE - Static variable in class io.github.resilience4j.ratelimiter.RateLimiterConfig

limitForPeriod - Variable in class io.github.resilience4j.ratelimiter.RateLimiterConfig.Builder

limitForPeriod - Variable in class io.github.resilience4j.ratelimiter.RateLimiterConfig

limitForPeriod(int) - Method in class io.github.resilience4j.ratelimiter.RateLimiterConfig.Builder

Configures the permissions limit for refresh period.

limitRefreshPeriod - Variable in class io.github.resilience4j.ratelimiter.RateLimiterConfig.Builder

limitRefreshPeriod - Variable in class io.github.resilience4j.ratelimiter.RateLimiterConfig

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

metrics - Variable in class io.github.resilience4j.ratelimiter.internal.SemaphoreBasedRateLimiter

N

name - Variable in class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter

name - Variable in class io.github.resilience4j.ratelimiter.internal.SemaphoreBasedRateLimiter

NAME_MUST_NOT_BE_NULL - Static variable in class io.github.resilience4j.ratelimiter.internal.SemaphoreBasedRateLimiter

nanosToWait - Variable in class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter.State

nanosToWaitForPermission(int, long, int, int, long, long) - Method in class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter

Calculates time to wait for the required permits of permissions to get accumulated

nanoTimeStart - Variable in class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter

numberOfPermits - Variable in class io.github.resilience4j.ratelimiter.event.AbstractRateLimiterEvent

O

of(RateLimiterConfig) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiterRegistry

Creates a RateLimiterRegistry with a custom RateLimiter configuration.

of(RateLimiterConfig, RegistryEventConsumer) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiterRegistry

Creates a RateLimiterRegistry with a custom default RateLimiter configuration and a RateLimiter registry event consumer.

of(RateLimiterConfig, List) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiterRegistry

Creates a RateLimiterRegistry with a custom default RateLimiter configuration and a list of RateLimiter registry event consumers.

of(String, RateLimiterConfig) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter

Creates a RateLimiter with a custom RateLimiter configuration.

of(String, RateLimiterConfig, Map) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter

Creates a RateLimiter with a custom RateLimiter configuration.

of(String, Supplier) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter

Creates a RateLimiter with a custom RateLimiterConfig configuration.

of(String, Supplier, Map) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter

Creates a RateLimiter with a custom RateLimiterConfig configuration.

of(Map) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiterRegistry

Creates a ThreadPoolBulkheadRegistry with a Map of shared RateLimiter configurations.

of(Map, RegistryEventConsumer) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiterRegistry

Creates a RateLimiterRegistry with a Map of shared RateLimiter configurations and a RateLimiter registry event consumer.

of(Map, RegistryEventConsumer, Map) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiterRegistry

Creates a RateLimiterRegistry with a Map of shared RateLimiter configurations and a RateLimiter registry event consumer.

of(Map, List) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiterRegistry

Creates a RateLimiterRegistry with a Map of shared RateLimiter configurations and a list of RateLimiter registry event consumers.

of(Map, Map) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiterRegistry

Creates a ThreadPoolBulkheadRegistry with a Map of shared RateLimiter configurations.

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 RateLimiter configuration.

ofDefaults(String) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter

Creates a RateLimiter with a default RateLimiterConfig configuration.

onError(Throwable) - Method in interface io.github.resilience4j.ratelimiter.RateLimiter

Records a failed call.

onFailure(EventConsumer) - Method in class io.github.resilience4j.ratelimiter.internal.RateLimiterEventProcessor

onFailure(EventConsumer) - Method in interface io.github.resilience4j.ratelimiter.RateLimiter.EventPublisher

onResult(Object) - Method in interface io.github.resilience4j.ratelimiter.RateLimiter

This method must be invoked when a call returned a result and the result predicate should decide if the call was successful or not.

onSuccess() - Method in interface io.github.resilience4j.ratelimiter.RateLimiter

Records a successful call.

onSuccess(EventConsumer) - Method in class io.github.resilience4j.ratelimiter.internal.RateLimiterEventProcessor

onSuccess(EventConsumer) - Method in interface io.github.resilience4j.ratelimiter.RateLimiter.EventPublisher

P

publishRateLimiterAcquisitionEvent(boolean, int) - Method in class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter

publishRateLimiterAcquisitionEvent(boolean, int) - Method in class io.github.resilience4j.ratelimiter.internal.SemaphoreBasedRateLimiter

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) - 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 class io.github.resilience4j.ratelimiter.internal.InMemoryRateLimiterRegistry

Returns a managed RateLimiter or creates a new one with a custom 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, RateLimiterConfig, Map) - 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, RateLimiterConfig, Map) - Method in interface io.github.resilience4j.ratelimiter.RateLimiterRegistry

Returns a managed RateLimiter or creates a new one with a custom RateLimiter configuration.

rateLimiter(String, String) - Method in class io.github.resilience4j.ratelimiter.internal.InMemoryRateLimiterRegistry

Returns a managed RateLimiter or creates a new one.

rateLimiter(String, String) - Method in interface io.github.resilience4j.ratelimiter.RateLimiterRegistry

Returns a managed RateLimiter or creates a new one.

rateLimiter(String, String, Map) - Method in class io.github.resilience4j.ratelimiter.internal.InMemoryRateLimiterRegistry

Returns a managed RateLimiter or creates a new one.

rateLimiter(String, String, Map) - Method in interface io.github.resilience4j.ratelimiter.RateLimiterRegistry

Returns a managed RateLimiter or creates a new one.

rateLimiter(String, Supplier) - Method in class io.github.resilience4j.ratelimiter.internal.InMemoryRateLimiterRegistry

Returns a managed RateLimiterConfig or creates a new one with a custom RateLimiterConfig configuration.

rateLimiter(String, Supplier) - Method in interface io.github.resilience4j.ratelimiter.RateLimiterRegistry

Returns a managed RateLimiterConfig or creates a new one with a custom RateLimiterConfig configuration.

rateLimiter(String, Supplier, Map) - Method in class io.github.resilience4j.ratelimiter.internal.InMemoryRateLimiterRegistry

Returns a managed RateLimiterConfig or creates a new one with a custom RateLimiterConfig configuration.

rateLimiter(String, Supplier, Map) - Method in interface io.github.resilience4j.ratelimiter.RateLimiterRegistry

Returns a managed RateLimiterConfig or creates a new one with a custom RateLimiterConfig configuration.

rateLimiter(String, Map) - 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, Map) - Method in interface io.github.resilience4j.ratelimiter.RateLimiterRegistry

Returns a managed RateLimiter or creates a new one with the default RateLimiter configuration.

RateLimiter - Interface in io.github.resilience4j.ratelimiter

A RateLimiter instance is thread-safe can be used to decorate multiple requests.

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 - Variable in class io.github.resilience4j.ratelimiter.internal.SemaphoreBasedRateLimiter

RateLimiterConfig - Class in io.github.resilience4j.ratelimiter

RateLimiterConfig(Duration, Duration, int, Predicate, boolean) - Constructor for class io.github.resilience4j.ratelimiter.RateLimiterConfig

RateLimiterConfig.Builder - Class in io.github.resilience4j.ratelimiter

rateLimiterConfigsMap - Variable in class io.github.resilience4j.ratelimiter.RateLimiterRegistry.Builder

RateLimiterEvent - Interface in io.github.resilience4j.ratelimiter.event

An event which is created by a RateLimiter.

RateLimiterEvent.Type - Enum Class in io.github.resilience4j.ratelimiter.event

RateLimiterEventProcessor - Class in io.github.resilience4j.ratelimiter.internal

RateLimiterEventProcessor() - Constructor for class io.github.resilience4j.ratelimiter.internal.RateLimiterEventProcessor

rateLimiterName - Variable in class io.github.resilience4j.ratelimiter.event.AbstractRateLimiterEvent

RateLimiterOnDrainedEvent - Class in io.github.resilience4j.ratelimiter.event

RateLimiterOnDrainedEvent(String, int) - Constructor for class io.github.resilience4j.ratelimiter.event.RateLimiterOnDrainedEvent

RateLimiterOnFailureEvent - Class in io.github.resilience4j.ratelimiter.event

RateLimiterOnFailureEvent(String) - Constructor for class io.github.resilience4j.ratelimiter.event.RateLimiterOnFailureEvent

RateLimiterOnFailureEvent(String, int) - 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

RateLimiterOnSuccessEvent(String, int) - Constructor for class io.github.resilience4j.ratelimiter.event.RateLimiterOnSuccessEvent

RateLimiterRegistry - Interface in io.github.resilience4j.ratelimiter

Manages all RateLimiter instances.

RateLimiterRegistry.Builder - Class in io.github.resilience4j.ratelimiter

refreshLimit() - Method in class io.github.resilience4j.ratelimiter.internal.SemaphoreBasedRateLimiter

registryEventConsumers - Variable in class io.github.resilience4j.ratelimiter.RateLimiterRegistry.Builder

registryStore - Variable in class io.github.resilience4j.ratelimiter.RateLimiterRegistry.Builder

RequestNotPermitted - Exception Class in io.github.resilience4j.ratelimiter

Exception that indicates that current thread was not able to acquire permission from RateLimiter.

RequestNotPermitted(String, boolean) - Constructor for exception class io.github.resilience4j.ratelimiter.RequestNotPermitted

reservePermission() - Method in class io.github.resilience4j.ratelimiter.internal.SemaphoreBasedRateLimiter

Reserving permissions is not supported in the semaphore based implementation.

reservePermission() - Method in interface io.github.resilience4j.ratelimiter.RateLimiter

Reserves a permission from this rate limiter and returns nanoseconds you should wait for it.

reservePermission(int) - Method in class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter

Reserves the given number permits from this rate limiter and returns nanoseconds you should wait for it.

reservePermission(int) - Method in class io.github.resilience4j.ratelimiter.internal.SemaphoreBasedRateLimiter

reservePermission(int) - Method in interface io.github.resilience4j.ratelimiter.RateLimiter

Reserves the given number permits from this rate limiter and returns nanoseconds you should wait for it.

reservePermissions(RateLimiterConfig, int, long, long, int, long) - Method in class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter

Determines whether caller can acquire permission before timeout or not and then creates corresponding AtomicRateLimiter.State.

S

scheduledFuture - Variable in class io.github.resilience4j.ratelimiter.internal.SemaphoreBasedRateLimiter

scheduleLimitRefresh() - Method in class io.github.resilience4j.ratelimiter.internal.SemaphoreBasedRateLimiter

scheduler - Variable in class io.github.resilience4j.ratelimiter.internal.SemaphoreBasedRateLimiter

semaphore - Variable in class io.github.resilience4j.ratelimiter.internal.SemaphoreBasedRateLimiter

SemaphoreBasedRateLimiter - Class in io.github.resilience4j.ratelimiter.internal

A RateLimiter implementation that consists of Semaphore and scheduler that will refresh permissions after each RateLimiterConfig.getLimitRefreshPeriod(), you can invoke SemaphoreBasedRateLimiter.shutdown() to close the limiter.

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.

SemaphoreBasedRateLimiter(String, RateLimiterConfig, ScheduledExecutorService, Map) - Constructor for class io.github.resilience4j.ratelimiter.internal.SemaphoreBasedRateLimiter

Creates a RateLimiter.

SemaphoreBasedRateLimiter(String, RateLimiterConfig, Map) - Constructor for class io.github.resilience4j.ratelimiter.internal.SemaphoreBasedRateLimiter

Creates a RateLimiter.

SemaphoreBasedRateLimiter.SemaphoreBasedRateLimiterMetrics - Class in io.github.resilience4j.ratelimiter.internal

SemaphoreBasedRateLimiterMetrics() - Constructor for class io.github.resilience4j.ratelimiter.internal.SemaphoreBasedRateLimiter.SemaphoreBasedRateLimiterMetrics

serialVersionUID - Static variable in class io.github.resilience4j.ratelimiter.RateLimiterConfig

shutdown() - Method in class io.github.resilience4j.ratelimiter.internal.SemaphoreBasedRateLimiter

Close the scheduled task that refresh permissions if you don't use the SemaphoreBasedRateLimiter anymore.

state - Variable in class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter

State(RateLimiterConfig, long, int, long) - Constructor for class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter.State

SUCCESSFUL_ACQUIRE - Enum constant in enum class io.github.resilience4j.ratelimiter.event.RateLimiterEvent.Type

T

tags - Variable in class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter

tags - Variable in class io.github.resilience4j.ratelimiter.internal.SemaphoreBasedRateLimiter

tags - Variable in class io.github.resilience4j.ratelimiter.RateLimiterRegistry.Builder

TIMEOUT_DURATION_MUST_NOT_BE_NULL - Static variable in class io.github.resilience4j.ratelimiter.RateLimiterConfig

TIMEOUT_DURATION_TOO_LARGE - Static variable in class io.github.resilience4j.ratelimiter.RateLimiterConfig

timeoutDuration - Variable in class io.github.resilience4j.ratelimiter.RateLimiterConfig.Builder

timeoutDuration - Variable in class io.github.resilience4j.ratelimiter.RateLimiterConfig

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

Type() - Constructor for enum class io.github.resilience4j.ratelimiter.event.RateLimiterEvent.Type

U

updateStateWithBackOff(int, long) - Method in class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter

Atomically updates the current AtomicRateLimiter.State with the results of applying the AtomicRateLimiter.calculateNextState(int, long, AtomicRateLimiter.State), returning the updated AtomicRateLimiter.State.

V

validateDurationWithinRange(Duration, String) - Static method in class io.github.resilience4j.ratelimiter.RateLimiterConfig

valueOf(String) - Static method in enum class io.github.resilience4j.ratelimiter.event.RateLimiterEvent.Type

Returns the enum constant of this class with the specified name.

values() - Static method in enum class io.github.resilience4j.ratelimiter.event.RateLimiterEvent.Type

Returns an array containing the constants of this enum class, in the order they are declared.

W

waitForPermission(long) - Method in class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter

Parks Thread for nanosToWait.

waitForPermission(RateLimiter) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter

Will wait for permission within default timeout duration.

waitForPermission(RateLimiter, int) - Static method in interface io.github.resilience4j.ratelimiter.RateLimiter

Will wait for required number of permits within default timeout duration.

waitForPermissionIfNecessary(long, long) - Method in class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter

If nanosToWait is bigger than 0 it tries to park Thread for nanosToWait but not longer then timeoutInNanos.

WAITING_THREADS - Static variable in class io.github.resilience4j.ratelimiter.utils.MetricNames

waitingThreads - Variable in class io.github.resilience4j.ratelimiter.internal.AtomicRateLimiter

withRateLimiterConfig(RateLimiterConfig) - Method in class io.github.resilience4j.ratelimiter.RateLimiterRegistry.Builder

Configures a RateLimiterRegistry with a custom default RateLimiter configuration.

withRegistryStore(RegistryStore) - Method in class io.github.resilience4j.ratelimiter.RateLimiterRegistry.Builder

withTags(Map) - Method in class io.github.resilience4j.ratelimiter.RateLimiterRegistry.Builder

Configures a RateLimiterRegistry with Tags.

writableStackTraceEnabled - Variable in class io.github.resilience4j.ratelimiter.RateLimiterConfig.Builder

writableStackTraceEnabled - Variable in class io.github.resilience4j.ratelimiter.RateLimiterConfig

writableStackTraceEnabled(boolean) - Method in class io.github.resilience4j.ratelimiter.RateLimiterConfig.Builder

Enables writable stack traces.

A B C D E F G I L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form