Uses of Interface
io.github.resilience4j.ratelimiter.RateLimiter

Packages that use RateLimiter

Package	Description
io.github.resilience4j.ratelimiter
io.github.resilience4j.ratelimiter.internal

Uses of RateLimiter in io.github.resilience4j.ratelimiter

Subinterfaces with type arguments of type RateLimiter in io.github.resilience4j.ratelimiter

Modifier and Type	Interface	Description
interface	RateLimiterRegistry	Manages all RateLimiter instances.

Fields in io.github.resilience4j.ratelimiter with type parameters of type RateLimiter

Modifier and Type	Field	Description
private List<io.github.resilience4j.core.registry.RegistryEventConsumer<RateLimiter>>	RateLimiterRegistry.Builder.registryEventConsumers
private io.github.resilience4j.core.RegistryStore<RateLimiter>	RateLimiterRegistry.Builder.registryStore

Methods in io.github.resilience4j.ratelimiter that return RateLimiter

Modifier and Type	Method	Description
static RateLimiter	RateLimiter.of(String name, RateLimiterConfig rateLimiterConfig)	Creates a RateLimiter with a custom RateLimiter configuration.
static RateLimiter	RateLimiter.of(String name, RateLimiterConfig rateLimiterConfig, Map<String,String> tags)	Creates a RateLimiter with a custom RateLimiter configuration.
static RateLimiter	RateLimiter.of(String name, Supplier<RateLimiterConfig> rateLimiterConfigSupplier)	Creates a RateLimiter with a custom RateLimiterConfig configuration.
static RateLimiter	RateLimiter.of(String name, Supplier<RateLimiterConfig> rateLimiterConfigSupplier, Map<String,String> tags)	Creates a RateLimiter with a custom RateLimiterConfig configuration.
static RateLimiter	RateLimiter.ofDefaults(String name)	Creates a RateLimiter with a default RateLimiterConfig configuration.
RateLimiter	RateLimiterRegistry.rateLimiter(String name)	Returns a managed RateLimiter or creates a new one with the default RateLimiter configuration.
RateLimiter	RateLimiterRegistry.rateLimiter(String name, RateLimiterConfig rateLimiterConfig)	Returns a managed RateLimiter or creates a new one with a custom RateLimiter configuration.
RateLimiter	RateLimiterRegistry.rateLimiter(String name, RateLimiterConfig rateLimiterConfig, Map<String,String> tags)	Returns a managed RateLimiter or creates a new one with a custom RateLimiter configuration.
RateLimiter	RateLimiterRegistry.rateLimiter(String name, String configName)	Returns a managed RateLimiter or creates a new one.
RateLimiter	RateLimiterRegistry.rateLimiter(String name, String configName, Map<String,String> tags)	Returns a managed RateLimiter or creates a new one.
RateLimiter	RateLimiterRegistry.rateLimiter(String name, Supplier<RateLimiterConfig> rateLimiterConfigSupplier)	Returns a managed RateLimiterConfig or creates a new one with a custom RateLimiterConfig configuration.
RateLimiter	RateLimiterRegistry.rateLimiter(String name, Supplier<RateLimiterConfig> rateLimiterConfigSupplier, Map<String,String> tags)	Returns a managed RateLimiterConfig or creates a new one with a custom RateLimiterConfig configuration.
RateLimiter	RateLimiterRegistry.rateLimiter(String name, Map<String,String> tags)	Returns a managed RateLimiter or creates a new one with the default RateLimiter configuration.

Methods in io.github.resilience4j.ratelimiter that return types with arguments of type RateLimiter

Modifier and Type	Method	Description
Set<RateLimiter>	RateLimiterRegistry.getAllRateLimiters()	Returns all managed RateLimiter instances.

Methods in io.github.resilience4j.ratelimiter with parameters of type RateLimiter

Modifier and Type	Method	Description
static RequestNotPermitted	RequestNotPermitted.createRequestNotPermitted(RateLimiter rateLimiter)	Static method to construct a RequestNotPermitted with a RateLimiter.
static <T> Callable<T>	RateLimiter.decorateCallable(RateLimiter rateLimiter, int permits, Callable<T> callable)	Creates a callable which is restricted by a RateLimiter.
static <T> Callable<T>	RateLimiter.decorateCallable(RateLimiter rateLimiter, Callable<T> callable)	Creates a callable which is restricted by a RateLimiter.
static <T,R> io.github.resilience4j.core.functions.CheckedFunction<T,R>	RateLimiter.decorateCheckedFunction(RateLimiter rateLimiter, int permits, io.github.resilience4j.core.functions.CheckedFunction<T,R> function)	Creates a function which is restricted by a RateLimiter.
static <T,R> io.github.resilience4j.core.functions.CheckedFunction<T,R>	RateLimiter.decorateCheckedFunction(RateLimiter rateLimiter, io.github.resilience4j.core.functions.CheckedFunction<T,R> function)	Creates a function which is restricted by a RateLimiter.
static <T,R> io.github.resilience4j.core.functions.CheckedFunction<T,R>	RateLimiter.decorateCheckedFunction(RateLimiter rateLimiter, Function<T,Integer> permitsCalculator, io.github.resilience4j.core.functions.CheckedFunction<T,R> function)	Creates a function which is restricted by a RateLimiter.
static io.github.resilience4j.core.functions.CheckedRunnable	RateLimiter.decorateCheckedRunnable(RateLimiter rateLimiter, int permits, io.github.resilience4j.core.functions.CheckedRunnable runnable)	Creates a runnable which is restricted by a RateLimiter.
static io.github.resilience4j.core.functions.CheckedRunnable	RateLimiter.decorateCheckedRunnable(RateLimiter rateLimiter, io.github.resilience4j.core.functions.CheckedRunnable runnable)	Creates a runnable which is restricted by a RateLimiter.
static <T> io.github.resilience4j.core.functions.CheckedSupplier<T>	RateLimiter.decorateCheckedSupplier(RateLimiter rateLimiter, int permits, io.github.resilience4j.core.functions.CheckedSupplier<T> supplier)	Creates a supplier which is restricted by a RateLimiter.
static <T> io.github.resilience4j.core.functions.CheckedSupplier<T>	RateLimiter.decorateCheckedSupplier(RateLimiter rateLimiter, io.github.resilience4j.core.functions.CheckedSupplier<T> supplier)	Creates a supplier which is restricted by a RateLimiter.
static <T> Supplier<CompletionStage<T>>	RateLimiter.decorateCompletionStage(RateLimiter rateLimiter, int permits, Supplier<CompletionStage<T>> supplier)	Returns a supplier which is decorated by a rateLimiter.
static <T> Supplier<CompletionStage<T>>	RateLimiter.decorateCompletionStage(RateLimiter rateLimiter, Supplier<CompletionStage<T>> supplier)	Returns a supplier which is decorated by a rateLimiter.
static <T> Consumer<T>	RateLimiter.decorateConsumer(RateLimiter rateLimiter, int permits, Consumer<T> consumer)	Creates a consumer which is restricted by a RateLimiter.
static <T> Consumer<T>	RateLimiter.decorateConsumer(RateLimiter rateLimiter, Consumer<T> consumer)	Creates a consumer which is restricted by a RateLimiter.
static <T> Consumer<T>	RateLimiter.decorateConsumer(RateLimiter rateLimiter, Function<T,Integer> permitsCalculator, Consumer<T> consumer)	Creates a consumer which is restricted by a RateLimiter.
static <T,R> Function<T,R>	RateLimiter.decorateFunction(RateLimiter rateLimiter, int permits, Function<T,R> function)	Creates a function which is restricted by a RateLimiter.
static <T,R> Function<T,R>	RateLimiter.decorateFunction(RateLimiter rateLimiter, Function<T,Integer> permitsCalculator, Function<T,R> function)	Creates a function which is restricted by a RateLimiter.
static <T,R> Function<T,R>	RateLimiter.decorateFunction(RateLimiter rateLimiter, Function<T,R> function)	Creates a function which is restricted by a RateLimiter.
static <T, F extends Future<T>> Supplier<F>	RateLimiter.decorateFuture(RateLimiter rateLimiter, int permits, Supplier<? extends F> supplier)	Returns a Supplier which is decorated by a RateLimiter.
static <T, F extends Future<T>> Supplier<F>	RateLimiter.decorateFuture(RateLimiter rateLimiter, Supplier<? extends F> supplier)	Returns a Supplier which is decorated by a RateLimiter.
static Runnable	RateLimiter.decorateRunnable(RateLimiter rateLimiter, int permits, Runnable runnable)	Creates a runnable which is restricted by a RateLimiter.
static Runnable	RateLimiter.decorateRunnable(RateLimiter rateLimiter, Runnable runnable)	Creates a runnable which is restricted by a RateLimiter.
static <T> Supplier<T>	RateLimiter.decorateSupplier(RateLimiter rateLimiter, int permits, Supplier<T> supplier)	Creates a supplier which is restricted by a RateLimiter.
static <T> Supplier<T>	RateLimiter.decorateSupplier(RateLimiter rateLimiter, Supplier<T> supplier)	Creates a supplier which is restricted by a RateLimiter.
static void	RateLimiter.waitForPermission(RateLimiter rateLimiter)	Will wait for permission within default timeout duration.
static void	RateLimiter.waitForPermission(RateLimiter rateLimiter, int permits)	Will wait for required number of permits within default timeout duration.

Method parameters in io.github.resilience4j.ratelimiter with type arguments of type RateLimiter

Modifier and Type	Method	Description
RateLimiterRegistry.Builder	RateLimiterRegistry.Builder.addRegistryEventConsumer(io.github.resilience4j.core.registry.RegistryEventConsumer<RateLimiter> registryEventConsumer)	Configures a RateLimiterRegistry with a RateLimiter registry event consumer.
static RateLimiterRegistry	RateLimiterRegistry.of(RateLimiterConfig defaultRateLimiterConfig, io.github.resilience4j.core.registry.RegistryEventConsumer<RateLimiter> registryEventConsumer)	Creates a RateLimiterRegistry with a custom default RateLimiter configuration and a RateLimiter registry event consumer.
static RateLimiterRegistry	RateLimiterRegistry.of(RateLimiterConfig defaultRateLimiterConfig, List<io.github.resilience4j.core.registry.RegistryEventConsumer<RateLimiter>> registryEventConsumers)	Creates a RateLimiterRegistry with a custom default RateLimiter configuration and a list of RateLimiter registry event consumers.
static RateLimiterRegistry	RateLimiterRegistry.of(Map<String, RateLimiterConfig> configs, io.github.resilience4j.core.registry.RegistryEventConsumer<RateLimiter> registryEventConsumer)	Creates a RateLimiterRegistry with a Map of shared RateLimiter configurations and a RateLimiter registry event consumer.
static RateLimiterRegistry	RateLimiterRegistry.of(Map<String, RateLimiterConfig> configs, io.github.resilience4j.core.registry.RegistryEventConsumer<RateLimiter> registryEventConsumer, Map<String,String> tags)	Creates a RateLimiterRegistry with a Map of shared RateLimiter configurations and a RateLimiter registry event consumer.
static RateLimiterRegistry	RateLimiterRegistry.of(Map<String, RateLimiterConfig> configs, List<io.github.resilience4j.core.registry.RegistryEventConsumer<RateLimiter>> registryEventConsumers)	Creates a RateLimiterRegistry with a Map of shared RateLimiter configurations and a list of RateLimiter registry event consumers.
RateLimiterRegistry.Builder	RateLimiterRegistry.Builder.withRegistryStore(io.github.resilience4j.core.RegistryStore<RateLimiter> registryStore)

Uses of RateLimiter in io.github.resilience4j.ratelimiter.internal

Classes in io.github.resilience4j.ratelimiter.internal that implement RateLimiter

Modifier and Type	Class	Description
class	AtomicRateLimiter	AtomicRateLimiter splits all nanoseconds from the start of epoch into cycles.
class	SemaphoreBasedRateLimiter	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.

Subclasses with type arguments of type RateLimiter in io.github.resilience4j.ratelimiter.internal

Modifier and Type	Class	Description
class	InMemoryRateLimiterRegistry	Backend RateLimiter manager.

Methods in io.github.resilience4j.ratelimiter.internal that return RateLimiter

Modifier and Type	Method	Description
RateLimiter	InMemoryRateLimiterRegistry.rateLimiter(String name)	Returns a managed RateLimiter or creates a new one with the default RateLimiter configuration.
RateLimiter	InMemoryRateLimiterRegistry.rateLimiter(String name, RateLimiterConfig config)	Returns a managed RateLimiter or creates a new one with a custom RateLimiter configuration.
RateLimiter	InMemoryRateLimiterRegistry.rateLimiter(String name, RateLimiterConfig config, Map<String,String> tags)	Returns a managed RateLimiter or creates a new one with a custom RateLimiter configuration.
RateLimiter	InMemoryRateLimiterRegistry.rateLimiter(String name, String configName)	Returns a managed RateLimiter or creates a new one.
RateLimiter	InMemoryRateLimiterRegistry.rateLimiter(String name, String configName, Map<String,String> tags)	Returns a managed RateLimiter or creates a new one.
RateLimiter	InMemoryRateLimiterRegistry.rateLimiter(String name, Supplier<RateLimiterConfig> rateLimiterConfigSupplier)	Returns a managed RateLimiterConfig or creates a new one with a custom RateLimiterConfig configuration.
RateLimiter	InMemoryRateLimiterRegistry.rateLimiter(String name, Supplier<RateLimiterConfig> rateLimiterConfigSupplier, Map<String,String> tags)	Returns a managed RateLimiterConfig or creates a new one with a custom RateLimiterConfig configuration.
RateLimiter	InMemoryRateLimiterRegistry.rateLimiter(String name, Map<String,String> tags)	Returns a managed RateLimiter or creates a new one with the default RateLimiter configuration.

Methods in io.github.resilience4j.ratelimiter.internal that return types with arguments of type RateLimiter

Modifier and Type	Method	Description
Set<RateLimiter>	InMemoryRateLimiterRegistry.getAllRateLimiters()	Returns all managed RateLimiter instances.

Constructor parameters in io.github.resilience4j.ratelimiter.internal with type arguments of type RateLimiter

Modifier	Constructor	Description
	InMemoryRateLimiterRegistry(RateLimiterConfig defaultConfig, io.github.resilience4j.core.registry.RegistryEventConsumer<RateLimiter> registryEventConsumer)
	InMemoryRateLimiterRegistry(RateLimiterConfig defaultConfig, io.github.resilience4j.core.registry.RegistryEventConsumer<RateLimiter> registryEventConsumer, Map<String,String> tags)
	InMemoryRateLimiterRegistry(RateLimiterConfig defaultConfig, List<io.github.resilience4j.core.registry.RegistryEventConsumer<RateLimiter>> registryEventConsumers)
	InMemoryRateLimiterRegistry(RateLimiterConfig defaultConfig, List<io.github.resilience4j.core.registry.RegistryEventConsumer<RateLimiter>> registryEventConsumers, Map<String,String> tags)
	InMemoryRateLimiterRegistry(Map<String, RateLimiterConfig> configs, io.github.resilience4j.core.registry.RegistryEventConsumer<RateLimiter> registryEventConsumer)
	InMemoryRateLimiterRegistry(Map<String, RateLimiterConfig> configs, io.github.resilience4j.core.registry.RegistryEventConsumer<RateLimiter> registryEventConsumer, Map<String,String> tags)
	InMemoryRateLimiterRegistry(Map<String, RateLimiterConfig> configs, List<io.github.resilience4j.core.registry.RegistryEventConsumer<RateLimiter>> registryEventConsumers)
	InMemoryRateLimiterRegistry(Map<String, RateLimiterConfig> configs, List<io.github.resilience4j.core.registry.RegistryEventConsumer<RateLimiter>> registryEventConsumers, Map<String,String> tags)
	InMemoryRateLimiterRegistry(Map<String, RateLimiterConfig> configs, List<io.github.resilience4j.core.registry.RegistryEventConsumer<RateLimiter>> registryEventConsumers, Map<String,String> tags, io.github.resilience4j.core.RegistryStore<RateLimiter> registryStore)
	InMemoryRateLimiterRegistry(Map<String, RateLimiterConfig> configs, List<io.github.resilience4j.core.registry.RegistryEventConsumer<RateLimiter>> registryEventConsumers, Map<String,String> tags, io.github.resilience4j.core.RegistryStore<RateLimiter> registryStore)