Package discord4j.voice

Class VoiceReactorResources

java.lang.Object

discord4j.common.ReactorResources

discord4j.voice.VoiceReactorResources

public class VoiceReactorResources
extends ReactorResources

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

Allows customizing the Scheduler used to send and receive voice packets and also the UdpClient template for establishing UDP connections.

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class discord4j.common.ReactorResources

DEFAULT_BLOCKING_TASK_SCHEDULER, DEFAULT_HTTP_CLIENT, DEFAULT_TIMER_TASK_SCHEDULER

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VoiceReactorResources.Builder	builder()	Returns a new builder to create VoiceReactorResources.
static VoiceReactorResources.Builder	builder(ReactorResources reactorResources)	Returns a new builder to create VoiceReactorResources from a pre-configured ReactorResources, copying its settings.
static VoiceReactorResources	create()	Create a default set of Voice Gateway resources.
Scheduler	getReceiveTaskScheduler()	Returns the Scheduler used to run the voice receive loop.
Scheduler	getSendTaskScheduler()	Returns the Scheduler used to run the voice send loop.
UdpClient	getUdpClient()	Returns the UDP client used to create voice protocol connections.
VoiceReactorResources.Builder	mutate()	Returns a builder to create a new VoiceReactorResources with settings copied from the current VoiceReactorResources.

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

Constructor Detail

VoiceReactorResources

public VoiceReactorResources(ReactorResources parent)

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

Parameters:

parent - the resources instance to get properties from

VoiceReactorResources

public VoiceReactorResources(ReactorResources parent,
                             UdpClient udpClient,
                             Scheduler sendTaskScheduler,
                             Scheduler receiveTaskScheduler)

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

Parameters:

parent - the resources instance to get properties from

udpClient - the UDP client used to create voice protocol connections

sendTaskScheduler - the scheduler used to run the voice send loop

receiveTaskScheduler - the scheduler used to run the voice receive loop

VoiceReactorResources

public VoiceReactorResources(HttpClient httpClient,
                             Scheduler timerTaskScheduler,
                             Scheduler blockingTaskScheduler,
                             UdpClient udpClient,
                             Scheduler sendTaskScheduler,
                             Scheduler receiveTaskScheduler)

Create Voice 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

udpClient - the UDP client used to create voice protocol connections

sendTaskScheduler - the scheduler used to run the voice send loop

receiveTaskScheduler - the scheduler used to run the voice receive loop

VoiceReactorResources

protected VoiceReactorResources(VoiceReactorResources.Builder builder)

Method Detail

create

public static VoiceReactorResources create()

Create a default set of Voice Gateway resources.

Returns:

a new VoiceReactorResources using all default properties

builder

public static VoiceReactorResources.Builder builder()

Returns a new builder to create VoiceReactorResources.

Returns:

a builder to create VoiceReactorResources

builder

public static VoiceReactorResources.Builder builder(ReactorResources reactorResources)

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

Returns:

a builder to create VoiceReactorResources with settings copied from parent resources

mutate

public VoiceReactorResources.Builder mutate()

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

Returns:

a builder based off this instance properties

getUdpClient

public UdpClient getUdpClient()

Returns the UDP client used to create voice protocol connections.

Returns:

the UDP client

getSendTaskScheduler

public Scheduler getSendTaskScheduler()

Returns the Scheduler used to run the voice send loop.

Returns:

the send scheduler

getReceiveTaskScheduler

public Scheduler getReceiveTaskScheduler()

Returns the Scheduler used to run the voice receive loop.

Returns:

the receive scheduler