Package discord4j.gateway

Class GatewayReactorResources

java.lang.Object

discord4j.common.ReactorResources

discord4j.gateway.GatewayReactorResources

public class GatewayReactorResources
extends ReactorResources

Provides an extra level of configuration for ReactorResources, tailored for the Gateway operations.

Allows customizing the Scheduler used to send gateway payloads.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final Supplier<Scheduler>	DEFAULT_PAYLOAD_SENDER_SCHEDULER

Fields inherited from class discord4j.common.ReactorResources

DEFAULT_BLOCKING_TASK_SCHEDULER, DEFAULT_HTTP_CLIENT, DEFAULT_TIMER_TASK_SCHEDULER

Constructor Summary

Constructors

Modifier	Constructor	Description
	GatewayReactorResources(ReactorResources parent)	Create Gateway resources based off ReactorResources properties, and providing defaults for the remaining properties.
	GatewayReactorResources(ReactorResources parent, Scheduler payloadSenderScheduler)	Create Gateway resources based off ReactorResources properties, and allowing customization of the remaining properties.
protected	GatewayReactorResources(GatewayReactorResources.Builder builder)
	GatewayReactorResources(HttpClient httpClient, Scheduler timerTaskScheduler, Scheduler blockingTaskScheduler, Scheduler payloadSenderScheduler)	Create Gateway resources allowing full customization of its properties.

Method Summary

Modifier and Type	Method	Description
static GatewayReactorResources.Builder	builder()	Returns a new builder to create GatewayReactorResources.
static GatewayReactorResources.Builder	builder(ReactorResources reactorResources)	Returns a new builder to create GatewayReactorResources from a pre-configured ReactorResources, copying its settings.
static GatewayReactorResources	create()	Create a default set of Gateway resources.
Scheduler	getPayloadSenderScheduler()	Get the scheduler used for sending gateway payloads.
GatewayReactorResources.Builder	mutate()	Returns a builder to create a new GatewayReactorResources with settings copied from the current GatewayReactorResources.

Methods inherited from class discord4j.common.ReactorResources

getBlockingTaskScheduler, getHttpClient, getTimerTaskScheduler, newHttpClient, newHttpClient

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_PAYLOAD_SENDER_SCHEDULER

public static final Supplier<Scheduler> DEFAULT_PAYLOAD_SENDER_SCHEDULER

Constructor Details

GatewayReactorResources

public GatewayReactorResources(ReactorResources parent)

Create Gateway resources based off ReactorResources properties, and providing defaults for the remaining properties.

Parameters:

parent - the resources instance to get properties from

GatewayReactorResources

public GatewayReactorResources(ReactorResources parent,
 Scheduler payloadSenderScheduler)

Create Gateway resources based off ReactorResources properties, and allowing customization of the remaining properties.

Parameters:

parent - the resources instance to get properties from

payloadSenderScheduler - a Scheduler for sending payloads. A default can be created from DEFAULT_PAYLOAD_SENDER_SCHEDULER

GatewayReactorResources

public GatewayReactorResources(HttpClient httpClient,
 Scheduler timerTaskScheduler,
 Scheduler blockingTaskScheduler,
 Scheduler payloadSenderScheduler)

Create Gateway resources allowing full customization of its properties.

Parameters:

httpClient - the HTTP client to use for initiating Gateway websocket connections. A default is provided in ReactorResources.DEFAULT_HTTP_CLIENT

timerTaskScheduler - the scheduler for timed tasks. A default can be created from ReactorResources.DEFAULT_TIMER_TASK_SCHEDULER

blockingTaskScheduler - the scheduler for blocking tasks. A default can be created from ReactorResources.DEFAULT_BLOCKING_TASK_SCHEDULER

payloadSenderScheduler - a scheduler for sending payloads. A default can be created from DEFAULT_PAYLOAD_SENDER_SCHEDULER

GatewayReactorResources

protected GatewayReactorResources(GatewayReactorResources.Builder builder)

Method Details

create

public static GatewayReactorResources create()

Create a default set of Gateway resources.

Returns:

a new GatewayReactorResources using all default properties

builder

public static GatewayReactorResources.Builder builder()

Returns a new builder to create GatewayReactorResources.

Returns:

a builder to create GatewayReactorResources

builder

public static GatewayReactorResources.Builder builder(ReactorResources reactorResources)

Returns a new builder to create GatewayReactorResources from a pre-configured ReactorResources, copying its settings.

Returns:

a builder to create GatewayReactorResources with settings copied from parent resources

mutate

public GatewayReactorResources.Builder mutate()

Returns a builder to create a new GatewayReactorResources with settings copied from the current GatewayReactorResources.

Returns:

a builder based off this instance properties

getPayloadSenderScheduler

public Scheduler getPayloadSenderScheduler()

Get the scheduler used for sending gateway payloads.

Returns:

a scheduler for payload tasks