discord4j.rest.request

Class RouterOptions

java.lang.Object

discord4j.rest.request.RouterOptions

public class RouterOptions
extends Object

Options used to control the behavior of a Router.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RouterOptions.Builder Builder for RouterOptions.

Field Summary

Fields

Modifier and Type	Field and Description
static Scheduler	DEFAULT_RATE_LIMIT_SCHEDULER The default Scheduler to delay rate limited requests.
static int	DEFAULT_REQUEST_PARALLELISM The default number of router requests allowed in parallel.
static Scheduler	DEFAULT_RESPONSE_SCHEDULER The default Scheduler to publish responses.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RouterOptions(RouterOptions.Builder builder)

Method Summary

Modifier and Type	Method and Description
static RouterOptions.Builder	builder() Returns a new RouterOptions.Builder to construct RouterOptions.
static RouterOptions	create() Returns a new RouterOptions with default settings.
GlobalRateLimiter	getGlobalRateLimiter() Returns the currently configured GlobalRateLimiter.
Scheduler	getRateLimitScheduler() Returns the defined scheduler for rate limiting delay purposes.
int	getRequestParallelism() Deprecated. for removal, using getGlobalRateLimiter() instead
Scheduler	getResponseScheduler() Returns the defined response scheduler.
List<ResponseFunction>	getResponseTransformers() Returns the list of ResponseFunction transformations that can be applied to every response.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_RESPONSE_SCHEDULER

public static final Scheduler DEFAULT_RESPONSE_SCHEDULER

The default Scheduler to publish responses. Allows blocking usage.

DEFAULT_RATE_LIMIT_SCHEDULER

public static final Scheduler DEFAULT_RATE_LIMIT_SCHEDULER

The default Scheduler to delay rate limited requests.

DEFAULT_REQUEST_PARALLELISM

public static final int DEFAULT_REQUEST_PARALLELISM

The default number of router requests allowed in parallel.

See Also:

Constant Field Values

Constructor Detail

RouterOptions

protected RouterOptions(RouterOptions.Builder builder)

Method Detail

builder

public static RouterOptions.Builder builder()

Returns a new RouterOptions.Builder to construct RouterOptions.

Returns:

a new RouterOptions builder

create

public static RouterOptions create()

Returns a new RouterOptions with default settings. See DEFAULT_RESPONSE_SCHEDULER and DEFAULT_RATE_LIMIT_SCHEDULER for the default values.

Returns:

a new RouterOptions

getResponseScheduler

public Scheduler getResponseScheduler()

Returns the defined response scheduler. Allows flexibility for blocking usage if a Scheduler that allows blocking is set.

Returns:

this option's response Scheduler

getRateLimitScheduler

public Scheduler getRateLimitScheduler()

Returns the defined scheduler for rate limiting delay purposes.

Returns:

this option's rate limiting Scheduler

getResponseTransformers

public List<ResponseFunction> getResponseTransformers()

Returns the list of ResponseFunction transformations that can be applied to every response. They are to be processed in the given order.

Returns:

a list of ResponseFunction objects.

getRequestParallelism

@Deprecated
public int getRequestParallelism()

Deprecated. for removal, using getGlobalRateLimiter() instead

Returns the number of allowed parallel requests the configured Router should adhere to.

Returns:

the number of allowed parallel requests.

getGlobalRateLimiter

public GlobalRateLimiter getGlobalRateLimiter()

Returns the currently configured GlobalRateLimiter. Defaults to SemaphoreGlobalRateLimiter with parallelism of DEFAULT_REQUEST_PARALLELISM or the value supplied via the builder.

Returns:

the configured GlobalRateLimiter