discord4j.rest.request

Class SemaphoreGlobalRateLimiter

java.lang.Object

discord4j.rest.request.SemaphoreGlobalRateLimiter

All Implemented Interfaces:

GlobalRateLimiter

public class SemaphoreGlobalRateLimiter
extends Object
implements GlobalRateLimiter

A GlobalRateLimiter that uses fair Semaphore instances as implementation. Can be configured with the amount of permits it allows before blocking further acquire attempts until permits are released.

Constructor Summary

Constructors

Constructor and Description
SemaphoreGlobalRateLimiter(int parallelism) Creates a new global rate limiter with the specified parallelism level.

Method Summary

Modifier and Type	Method and Description
Duration	getRemaining() Returns the Duration remaining until the current global rate limit is completed.
void	rateLimitFor(Duration duration) Sets a new rate limit that will be applied to every new resource acquired.
<T> Flux<T>	withLimiter(Publisher<T> stage) Provides a scope to perform reactive operations under this limiter resources.

Methods inherited from class java.lang.Object

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

Constructor Detail

SemaphoreGlobalRateLimiter

public SemaphoreGlobalRateLimiter(int parallelism)

Creates a new global rate limiter with the specified parallelism level.

Parameters:

parallelism - the maximum number of requests that this limiter will allow in parallel

Method Detail

rateLimitFor

public void rateLimitFor(Duration duration)

Sets a new rate limit that will be applied to every new resource acquired.

Specified by:

rateLimitFor in interface GlobalRateLimiter

Parameters:

duration - the Duration every new acquired resource should wait before being used

getRemaining

public Duration getRemaining()

Description copied from interface: GlobalRateLimiter

Returns the Duration remaining until the current global rate limit is completed. Can be negative or zero if there is no currently active global rate limit.

Specified by:

getRemaining in interface GlobalRateLimiter

Returns:

a positive Duration indicating the remaining time a global rate limit is being applied. Zero or negative if no global rate limit is currently active.

withLimiter

public <T> Flux<T> withLimiter(Publisher<T> stage)

Provides a scope to perform reactive operations under this limiter resources. Resources are acquired on subscription and released when the given stage has completed or terminated with an error.

Specified by:

withLimiter in interface GlobalRateLimiter

Type Parameters:

T - the type of the stage supplier

Parameters:

stage - a Mono that will manage this limiter resources

Returns:

a Mono where each subscription represents acquiring a rate limiter resource