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 and Description
GatewayResources(StateView stateView, EventDispatcher eventDispatcher, ShardCoordinator shardCoordinator, MemberRequestFilter memberRequestFilter, GatewayReactorResources gatewayReactorResources, VoiceReactorResources voiceReactorResources, ReconnectOptions voiceReconnectOptions, discord4j.discordjson.possible.Possible<IntentSet> intents) Create a new GatewayResources with the given parameters.

Method Summary

Modifier and Type	Method and Description
EventDispatcher	getEventDispatcher() Distributes events to subscribers.
GatewayReactorResources	getGatewayReactorResources() Return the GatewayReactorResources used to perform Gateway-related operations.
discord4j.discordjson.possible.Possible<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.
StateView	getStateView() Repository aggregate view of all caching related operations.
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(StateView stateView,
                        EventDispatcher eventDispatcher,
                        ShardCoordinator shardCoordinator,
                        MemberRequestFilter memberRequestFilter,
                        GatewayReactorResources gatewayReactorResources,
                        VoiceReactorResources voiceReactorResources,
                        ReconnectOptions voiceReconnectOptions,
                        discord4j.discordjson.possible.Possible<IntentSet> intents)

Create a new GatewayResources with the given parameters.

Parameters:

stateView - a read-only facade for an entity cache based off StateHolder

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

Method Detail

getIntents

public discord4j.discordjson.possible.Possible<IntentSet> getIntents()

Returns an IntentSet containing the Intents declared by the user

Returns:

The IntentSet tied to this GatewayResources

getStateView

public StateView getStateView()

Repository aggregate view of all caching related operations. Discord Gateway mandates its clients to cache its updates through events coming from the real-time websocket. The StateView is a read-only facade for StateHolder which is the mediator for the underlying Store instances for each cached entity.

Returns:

the StateView tied to this GatewayResources

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