Package net.dv8tion.jda.api.requests

Class RestRateLimiter.RateLimitConfig

java.lang.Object

net.dv8tion.jda.api.requests.RestRateLimiter.RateLimitConfig

Enclosing interface:

RestRateLimiter

public static class RestRateLimiter.RateLimitConfig
extends Object

Configuration for the rate-limiter.

Constructor Summary

Constructors

Constructor	Description
RateLimitConfig(ScheduledExecutorService scheduler, ExecutorService elastic, RestRateLimiter.GlobalRateLimit globalRateLimit, boolean isRelative)
RateLimitConfig(ScheduledExecutorService scheduler, RestRateLimiter.GlobalRateLimit globalRateLimit, boolean isRelative)

Method Summary

Modifier and Type	Method	Description
ExecutorService	getElastic()	The elastic ExecutorService used to execute rate-limit tasks.
RestRateLimiter.GlobalRateLimit	getGlobalRateLimit()	The global rate-limit store.
ScheduledExecutorService	getPool()	Deprecated.
ScheduledExecutorService	getScheduler()	The ScheduledExecutorService used to schedule rate-limit tasks.
boolean	isRelative()	Whether to use RestRateLimiter.RESET_AFTER_HEADER.

Methods inherited from class java.lang.Object

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

Constructor Details

RateLimitConfig

public RateLimitConfig(@Nonnull
 ScheduledExecutorService scheduler,
 @Nonnull
 RestRateLimiter.GlobalRateLimit globalRateLimit,
 boolean isRelative)

RateLimitConfig

public RateLimitConfig(@Nonnull
 ScheduledExecutorService scheduler,
 @Nonnull
 ExecutorService elastic,
 @Nonnull
 RestRateLimiter.GlobalRateLimit globalRateLimit,
 boolean isRelative)

Method Details

getPool

@Nonnull
@Deprecated
@ReplaceWith("getScheduler() or getElastic()")
public ScheduledExecutorService getPool()

Deprecated.

The ScheduledExecutorService used to schedule rate-limit tasks.

Returns:

The ScheduledExecutorService

getScheduler

@Nonnull
public ScheduledExecutorService getScheduler()

The ScheduledExecutorService used to schedule rate-limit tasks.

Returns:

The ScheduledExecutorService

getElastic

@Nonnull
public ExecutorService getElastic()

The elastic ExecutorService used to execute rate-limit tasks.
This pool can potentially scale up and down depending on use.

It is also possible that this pool is identical to getScheduler().

Returns:

The elastic ExecutorService

getGlobalRateLimit

@Nonnull
public RestRateLimiter.GlobalRateLimit getGlobalRateLimit()

The global rate-limit store.

Returns:

The global rate-limit store

isRelative

public boolean isRelative()

Whether to use RestRateLimiter.RESET_AFTER_HEADER.
This is primarily to avoid NTP sync issues.

Returns:

True, if RestRateLimiter.RESET_AFTER_HEADER should be used instead of RestRateLimiter.RESET_HEADER