Package net.dv8tion.jda.api.utils

Class SessionController.ShardedGateway

java.lang.Object

net.dv8tion.jda.api.utils.SessionController.ShardedGateway

Enclosing interface:

SessionController

public static class SessionController.ShardedGateway
extends Object

POJO containing the gateway endpoint and recommended shard total for a shard manager.

Constructor Summary

Constructors

Constructor	Description
ShardedGateway(String url, int shardTotal)	Creates a new GatewayBot instance with the provided properties
ShardedGateway(String url, int shardTotal, int concurrency)

Method Summary

Modifier and Type	Method	Description
int	getConcurrency()	The concurrency level for this bot.
int	getShardTotal()	The recommended shard total
String	getUrl()	The gateway endpoint

Methods inherited from class java.lang.Object

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

Constructor Details

ShardedGateway

public ShardedGateway(String url,
 int shardTotal)

Creates a new GatewayBot instance with the provided properties

Parameters:

url - The gateway endpoint (wss)

shardTotal - The recommended shard total

ShardedGateway

public ShardedGateway(String url,
 int shardTotal,
 int concurrency)

Method Details

getUrl

@Nonnull
public String getUrl()

The gateway endpoint

Returns:

The endpoint

getShardTotal

public int getShardTotal()

The recommended shard total

Returns:

The shard total

getConcurrency

public int getConcurrency()

The concurrency level for this bot.
This should not be a custom value as discord determines the eligible concurrency. Using a different concurrency value could result in issues and possibly a ban due to login spam.

Returns:

The concurrency level

See Also:

• SessionController.setConcurrency(int)