discord4j.rest.request

Class SingleRouterFactory

java.lang.Object

discord4j.rest.request.SingleRouterFactory

All Implemented Interfaces:

RouterFactory

public class SingleRouterFactory
extends Object
implements RouterFactory

A monolithic RouterFactory that caches a Router captured at instantiation instead of producing a new one each time getRouter(discord4j.rest.http.client.DiscordWebClient) or getRouter(DiscordWebClient, RouterOptions) is called.

Suited for sharing a router in order to coordinate its work across shards. It is not suited for distributed scenarios where multiple shards exist across processes unless care is taken to properly coordinate each request externally.

Constructor Summary

Constructors

Constructor and Description
SingleRouterFactory(Router router) Create a new SingleRouterFactory that will always produce the given Router instance.

Method Summary

Modifier and Type	Method and Description
Router	getRouter(DiscordWebClient httpClient) Retrieve a Router configured to process API requests.
Router	getRouter(DiscordWebClient httpClient, 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

SingleRouterFactory

public SingleRouterFactory(Router router)

Create a new SingleRouterFactory that will always produce the given Router instance.

Parameters:

router - the Router instance that will be produced by this factory.

Method Detail

getRouter

public Router getRouter(DiscordWebClient httpClient)

Description copied from interface: RouterFactory

Retrieve a Router configured to process API requests.

Specified by:

getRouter in interface RouterFactory

Parameters:

httpClient - a web client to parameterize the Router creation

Returns:

a Router prepared to process API requests

getRouter

public Router getRouter(DiscordWebClient httpClient,
                        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:

httpClient - 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