discord4j.core.shard

Class ShardingClientBuilder

java.lang.Object

discord4j.core.shard.ShardingClientBuilder

public class ShardingClientBuilder
extends Object

Builder suited for creating a sequence of DiscordClient each dedicated to a shard, while allowing resource sharing and login coordination.

Creates multiple Discord clients with many configurable options. It uses a recommended amount of shards but can be overridden through setShardCount(Integer).

Constructor Summary

Constructors

Constructor and Description
ShardingClientBuilder(String token) Initialize a new builder with the given token.

Method Summary

Modifier and Type	Method and Description
Flux<DiscordClientBuilder>	build() Create a sequence of DiscordClientBuilders each representing a shard, up to the resulting shard count, filtering out values not matching the predicate given by getShardIndexFilter().
RouterFactory	getRouterFactory() Deprecated.
RouterOptions	getRouterOptions() Deprecated.
Integer	getShardCount() Deprecated.
Predicate<Integer>	getShardIndexFilter() Deprecated.
ShardingStoreRegistry	getShardingStoreRegistry() Deprecated.
String	getToken() Deprecated.
ShardingClientBuilder	setRouterFactory(RouterFactory routerFactory) Set a new RouterFactory used to create a Router that executes Discord REST API requests and will be shared across all sharding clients created by this builder.
ShardingClientBuilder	setRouterOptions(RouterOptions routerOptions) Sets a new RouterOptions used to configure a RouterFactory.
ShardingClientBuilder	setShardCount(Integer shardCount) Change the shard count value given to each resulting shard.
ShardingClientBuilder	setShardIndexFilter(Predicate<Integer> shardIndexFilter) Set a new Predicate of shard index, indicating whether a shard should be created.
ShardingClientBuilder	setShardingStoreRegistry(ShardingStoreRegistry shardingStoreRegistry) Set a new ShardingStoreRegistry used to coordinate stores across shards.
ShardingClientBuilder	setToken(String token) Change the token stored in this builder.

Methods inherited from class java.lang.Object

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

Constructor Detail

ShardingClientBuilder

public ShardingClientBuilder(String token)

Initialize a new builder with the given token.

Parameters:

token - the bot token used to authenticate to Discord

Method Detail

getToken

@Deprecated
public String getToken()

Deprecated.

Retrieve the token set in this builder.

Returns:

the current bot token

setToken

public ShardingClientBuilder setToken(String token)

Change the token stored in this builder.

Parameters:

token - the new bot token

Returns:

this builder

getShardCount

@Nullable
 @Deprecated
public Integer getShardCount()

Deprecated.

Returns the shard count value to set while identifying each produced shard.

Returns:

the shard count, can be null, in which case use the recommended shard count given by the Routes endpoint.

setShardCount

public ShardingClientBuilder setShardCount(@Nullable
                                           Integer shardCount)

Change the shard count value given to each resulting shard. Can be set to null to use the recommended value from the Routes endpoint, that is calculated from the number of guilds this token is in.

Parameters:

shardCount - the shard count, can be null, in which case use a recommended value

Returns:

this builder

getRouterFactory

@Nullable
 @Deprecated
public RouterFactory getRouterFactory()

Deprecated.

Get the current RouterFactory used to create a Router that executes Discord REST API requests.

Returns:

the current RouterFactory used to create a Router that perform API requests

setRouterFactory

public ShardingClientBuilder setRouterFactory(@Nullable
                                              RouterFactory routerFactory)

Set a new RouterFactory used to create a Router that executes Discord REST API requests and will be shared across all sharding clients created by this builder.

Make sure the given factory is capable of coordinating rate limits across shards, otherwise use the default value as it is shard aware.

Parameters:

routerFactory - a new RouterFactory to create a Router that performs API requests. Pass null to use the default value

Returns:

this builder

getRouterOptions

@Nullable
 @Deprecated
public RouterOptions getRouterOptions()

Deprecated.

Return the current RouterOptions used to configure RouterFactory instances.

Returns:

the current RouterOptions used by this client

setRouterOptions

public ShardingClientBuilder setRouterOptions(@Nullable
                                              RouterOptions routerOptions)

Sets a new RouterOptions used to configure a RouterFactory.

RouterOptions instances provide a way to override the Scheduler used for retrieving API responses and scheduling rate limiting actions. It also allows changing the behavior associated with API errors through RouterOptions.Builder#onClientResponse(ResponseFunction).

If you use a default RouterFactory, it will use the supplied RouterOptions to configure itself while building this client.

Parameters:

routerOptions - a new RouterOptions to configure a RouterFactory

Returns:

this builder

getShardingStoreRegistry

@Nullable
 @Deprecated
public ShardingStoreRegistry getShardingStoreRegistry()

Deprecated.

Returns the current ShardingStoreRegistry used to coordinate stores across shards.

Returns:

the store registry

setShardingStoreRegistry

public ShardingClientBuilder setShardingStoreRegistry(@Nullable
                                                      ShardingStoreRegistry shardingStoreRegistry)

Set a new ShardingStoreRegistry used to coordinate stores across shards. The default value is to use ShardingJdkStoreRegistry. If you wish to disable this feature, set the resulting client stores to any non-coordinating value through DiscordClientBuilder.setStoreService(discord4j.store.api.service.StoreService) in order to override the default value that attempts to communicate with this registry.

Parameters:

shardingStoreRegistry - a new store registry to coordinate shards. Can be null to use the default value

Returns:

this builder

getShardIndexFilter

@Nullable
 @Deprecated
public Predicate<Integer> getShardIndexFilter()

Deprecated.

Returns the current Predicate used to include only a set of shards in the creation process. By default all shards given by the shard count are created.

Returns:

the current predicate of shard index indicating which shards should be created, can be null

setShardIndexFilter

public ShardingClientBuilder setShardIndexFilter(@Nullable
                                                 Predicate<Integer> shardIndexFilter)

Set a new Predicate of shard index, indicating whether a shard should be created. Can be used in scenarios when you want to partially colocate the shards given by shard count.

Parameters:

shardIndexFilter - the new predicate of shard index to use in order to filter shard creation

Returns:

this builder

build

public Flux<DiscordClientBuilder> build()

Create a sequence of DiscordClientBuilders each representing a shard, up to the resulting shard count, filtering out values not matching the predicate given by getShardIndexFilter().

This sequence can be further customized on a per-shard basis until you call DiscordClient.login():

 new ShardingClientBuilder(token)
     .build()
           .map(builder -> builder.setInitialPresence(
                    Presence.online(Activity.playing("Shard " + builder.getShardIndex()))))
     .map(DiscordClientBuilder::build)
     .flatMap(DiscordClient::login)
     .blockLast();
 

Login will be coordinated across this sequence, that is, a shard will identify to the gateway only when the previous one has connected successfully and the mandatory time between login attempt has passed (~5 seconds).

Returns:

a DiscordClient based on this builder parameters