discord4j.rest.request

Class DefaultRouterFactory

java.lang.Object

discord4j.rest.request.DefaultRouterFactory

All Implemented Interfaces:

RouterFactory

public class DefaultRouterFactory
extends Object
implements RouterFactory

A monolithic RouterFactory that can build Router instances to execute Discord API requests.

This factory creates a new instance each time so it is not fit for coordinating sharding requests. For those cases, see SingleRouterFactory.

Constructor Summary

Constructors

Constructor and Description
DefaultRouterFactory() Create a DefaultRouterFactory with default options.
DefaultRouterFactory(RouterOptions routerOptions) Create a DefaultRouterFactory configured with the given RouterOptions.
DefaultRouterFactory(Scheduler responseScheduler, Scheduler rateLimitScheduler) Deprecated. use DefaultRouterFactory(RouterOptions)

Method Summary

Modifier and Type	Method and Description
Router	getRouter(DiscordWebClient webClient) Retrieve a Router configured to process API requests.
Router	getRouter(DiscordWebClient webClient, RouterOptions routerOptions) Retrieve a Router that can be further configured with the given RouterOptions to process API requests.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultRouterFactory

public DefaultRouterFactory()

Create a DefaultRouterFactory with default options. See RouterOptions.create() for information about the default values.

DefaultRouterFactory

@Deprecated
public DefaultRouterFactory(Scheduler responseScheduler,
                                        Scheduler rateLimitScheduler)

Deprecated. use DefaultRouterFactory(RouterOptions)

Create a DefaultRouterFactory with the given Scheduler options.

Parameters:

responseScheduler - the Scheduler used to publish responses

rateLimitScheduler - the Scheduler used to delay rate limited requests

DefaultRouterFactory

public DefaultRouterFactory(RouterOptions routerOptions)

Create a DefaultRouterFactory configured with the given RouterOptions.

Parameters:

routerOptions - the options to configure the produced Router instances

Method Detail

getRouter

public Router getRouter(DiscordWebClient webClient)

Description copied from interface: RouterFactory

Retrieve a Router configured to process API requests.

Specified by:

getRouter in interface RouterFactory

Parameters:

webClient - a web client to parameterize the Router creation

Returns:

a Router prepared to process API requests

getRouter

public Router getRouter(DiscordWebClient webClient,
                        RouterOptions routerOptions)

Description copied from interface: RouterFactory

Retrieve a Router that can be further configured with the given RouterOptions to process API requests.

Specified by:

getRouter in interface RouterFactory

Parameters:

webClient - a web client to parameterize the Router creation

routerOptions - a configuration object to control the behavior of the resulting Router

Returns:

a Router prepared to process API requests