Package discord4j.core

Class GatewayResources

java.lang.Object

discord4j.core.GatewayResources

public class GatewayResources
extends Object

A set of dependencies required to build and coordinate multiple GatewayClient instances.

Constructor Summary

Constructors

Constructor	Description
GatewayResources(Store store, EventDispatcher eventDispatcher, ShardCoordinator shardCoordinator, MemberRequestFilter memberRequestFilter, GatewayReactorResources gatewayReactorResources, VoiceReactorResources voiceReactorResources, ReconnectOptions voiceReconnectOptions, IntentSet intents)	Create a new GatewayResources with the given parameters.

Method Summary

Modifier and Type	Method	Description
EventDispatcher	getEventDispatcher()	Distributes events to subscribers.
GatewayReactorResources	getGatewayReactorResources()	Return the GatewayReactorResources used to perform Gateway-related operations.
IntentSet	getIntents()	Returns an IntentSet containing the Intents declared by the user
MemberRequestFilter	getMemberRequestFilter()	Return a MemberRequestFilter indicating whether this shard group should be requesting guild members.
ShardCoordinator	getShardCoordinator()	Returns the ShardCoordinator that is capable of coordinating certain shard actions.
Store	getStore()	Returns the Store used to cache data during gateway sessions.
VoiceReactorResources	getVoiceReactorResources()	Return the VoiceReactorResources used to perform Voice Gateway-related operations.
ReconnectOptions	getVoiceReconnectOptions()	Return the reconnect policy used to retry a connection to the Voice Gateway.

Methods inherited from class java.lang.Object

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

Constructor Detail

GatewayResources

public GatewayResources(Store store,
                        EventDispatcher eventDispatcher,
                        ShardCoordinator shardCoordinator,
                        MemberRequestFilter memberRequestFilter,
                        GatewayReactorResources gatewayReactorResources,
                        VoiceReactorResources voiceReactorResources,
                        ReconnectOptions voiceReconnectOptions,
                        IntentSet intents)

Create a new GatewayResources with the given parameters.

Parameters:

store - an entity cache

eventDispatcher - an event bus dedicated to distribute Event instances

shardCoordinator - a middleware component to coordinate multiple shard-connecting efforts

memberRequestFilter - a strategy to determine whether guild members should be requested

gatewayReactorResources - a custom set of Reactor resources targeting Gateway operations

voiceReactorResources - a set of Reactor resources targeting Voice Gateway operations

voiceReconnectOptions - a reconnection policy for Voice Gateway connections

intents - a set of events to subscribe when connecting to the Gateway

Method Detail

getIntents

public IntentSet getIntents()

Returns an IntentSet containing the Intents declared by the user

Returns:

The IntentSet tied to this GatewayResources

getStore

public Store getStore()

Returns the Store used to cache data during gateway sessions.

Returns:

the Store instance

getEventDispatcher

public EventDispatcher getEventDispatcher()

Distributes events to subscribers. Starting from v3.1, the EventDispatcher is capable of distributing events from all GatewayClient connections (shards) that were specified when this GatewayDiscordClient was created.

Returns:

the EventDispatcher tied to this GatewayResources

getShardCoordinator

public ShardCoordinator getShardCoordinator()

Returns the ShardCoordinator that is capable of coordinating certain shard actions.

Returns:

the ShardCoordinator tied to this GatewayResources

getMemberRequestFilter

public MemberRequestFilter getMemberRequestFilter()

Return a MemberRequestFilter indicating whether this shard group should be requesting guild members.

Returns:

the MemberRequestFilter configured in this GatewayResources

getGatewayReactorResources

public GatewayReactorResources getGatewayReactorResources()

Return the GatewayReactorResources used to perform Gateway-related operations.

Returns:

the Gateway Reactor resources

getVoiceReactorResources

public VoiceReactorResources getVoiceReactorResources()

Return the VoiceReactorResources used to perform Voice Gateway-related operations.

Returns:

the Voice Gateway Reactor resources

getVoiceReconnectOptions

public ReconnectOptions getVoiceReconnectOptions()

Return the reconnect policy used to retry a connection to the Voice Gateway.

Returns:

a reconnection policy