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 multipleGatewayClient
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 newGatewayResources
with the given parameters.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EventDispatcher
getEventDispatcher()
Distributes events to subscribers.GatewayReactorResources
getGatewayReactorResources()
Return theGatewayReactorResources
used to perform Gateway-related operations.IntentSet
getIntents()
MemberRequestFilter
getMemberRequestFilter()
Return aMemberRequestFilter
indicating whether this shard group should be requesting guild members.ShardCoordinator
getShardCoordinator()
Returns theShardCoordinator
that is capable of coordinating certain shard actions.Store
getStore()
Returns theStore
used to cache data during gateway sessions.VoiceReactorResources
getVoiceReactorResources()
Return theVoiceReactorResources
used to perform Voice Gateway-related operations.ReconnectOptions
getVoiceReconnectOptions()
Return the reconnect policy used to retry a connection to the Voice Gateway.
-
-
-
Constructor Detail
-
GatewayResources
public GatewayResources(Store store, EventDispatcher eventDispatcher, ShardCoordinator shardCoordinator, MemberRequestFilter memberRequestFilter, GatewayReactorResources gatewayReactorResources, VoiceReactorResources voiceReactorResources, ReconnectOptions voiceReconnectOptions, IntentSet intents)
Create a newGatewayResources
with the given parameters.- Parameters:
store
- an entity cacheeventDispatcher
- an event bus dedicated to distributeEvent
instancesshardCoordinator
- a middleware component to coordinate multiple shard-connecting effortsmemberRequestFilter
- a strategy to determine whether guild members should be requestedgatewayReactorResources
- a custom set of Reactor resources targeting Gateway operationsvoiceReactorResources
- a set of Reactor resources targeting Voice Gateway operationsvoiceReconnectOptions
- a reconnection policy for Voice Gateway connectionsintents
- a set of events to subscribe when connecting to the Gateway
-
-
Method Detail
-
getIntents
public IntentSet getIntents()
- Returns:
- The
IntentSet
tied to thisGatewayResources
-
getStore
public Store getStore()
Returns theStore
used to cache data during gateway sessions.- Returns:
- the
Store
instance
-
getEventDispatcher
public EventDispatcher getEventDispatcher()
Distributes events to subscribers. Starting from v3.1, theEventDispatcher
is capable of distributing events from allGatewayClient
connections (shards) that were specified when thisGatewayDiscordClient
was created.- Returns:
- the
EventDispatcher
tied to thisGatewayResources
-
getShardCoordinator
public ShardCoordinator getShardCoordinator()
Returns theShardCoordinator
that is capable of coordinating certain shard actions.- Returns:
- the
ShardCoordinator
tied to thisGatewayResources
-
getMemberRequestFilter
public MemberRequestFilter getMemberRequestFilter()
Return aMemberRequestFilter
indicating whether this shard group should be requesting guild members.- Returns:
- the
MemberRequestFilter
configured in thisGatewayResources
-
getGatewayReactorResources
public GatewayReactorResources getGatewayReactorResources()
Return theGatewayReactorResources
used to perform Gateway-related operations.- Returns:
- the Gateway Reactor resources
-
getVoiceReactorResources
public VoiceReactorResources getVoiceReactorResources()
Return theVoiceReactorResources
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
-
-