Package net.dv8tion.jda.api.utils

Class SessionControllerAdapter

java.lang.Object

net.dv8tion.jda.api.utils.SessionControllerAdapter

All Implemented Interfaces:

SessionController

Direct Known Subclasses:

ConcurrentSessionController

public class SessionControllerAdapter
extends Object
implements SessionController

Simple implementation of SessionController without supporting concurrency.

See Also:

• ConcurrentSessionController

Nested Class Summary

Nested classes/interfaces inherited from interface net.dv8tion.jda.api.utils.SessionController

SessionController.GlobalRateLimitAdapter, SessionController.SessionConnectNode, SessionController.ShardedGateway

Field Summary

Fields inherited from interface net.dv8tion.jda.api.utils.SessionController

IDENTIFY_DELAY

Constructor Summary

Constructors

Constructor	Description
SessionControllerAdapter()

Method Summary

Modifier and Type	Method	Description
void	appendSession(SessionController.SessionConnectNode node)	Called by a JDA session when a WebSocket should be started.
RestRateLimiter.GlobalRateLimit	getRateLimitHandle()	The store for global rate-limits of all types.
SessionController.ShardedGateway	getShardedGateway(JDA api)	Called by DefaultShardManager when a new shards is starting.
void	removeSession(SessionController.SessionConnectNode node)	Called by a JDA session when a shutdown has been requested.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.dv8tion.jda.api.utils.SessionController

getGateway, getGlobalRatelimit, setConcurrency, setGlobalRatelimit

Constructor Details

SessionControllerAdapter

public SessionControllerAdapter()

Method Details

appendSession

public void appendSession(@Nonnull
 SessionController.SessionConnectNode node)

Description copied from interface: SessionController

Called by a JDA session when a WebSocket should be started. (Connecting and Reconnecting)
This should only add the node to a queue and execute the queue with respect to the SessionController.IDENTIFY_DELAY.

Specified by:

appendSession in interface SessionController

Parameters:

node - The SessionConnectNode

removeSession

public void removeSession(@Nonnull
 SessionController.SessionConnectNode node)

Description copied from interface: SessionController

Called by a JDA session when a shutdown has been requested.
When this happened the SessionConnectNode.run(boolean) will be a no-op and does not contribute to the SessionController.IDENTIFY_DELAY.

Specified by:

removeSession in interface SessionController

Parameters:

node - The SessionConnectNode to remove from the queue.

getRateLimitHandle

@Nonnull
public RestRateLimiter.GlobalRateLimit getRateLimitHandle()

Description copied from interface: SessionController

The store for global rate-limits of all types.
This can be used to share the global rate-limit information between shards on the same IP.

Specified by:

getRateLimitHandle in interface SessionController

Returns:

The global rate-limiter

getShardedGateway

@Nonnull
public SessionController.ShardedGateway getShardedGateway(@Nonnull
 JDA api)

Description copied from interface: SessionController

Called by DefaultShardManager when a new shards is starting.
Should provide a SessionController.ShardedGateway with (gateway, shardTotal).

Specified by:

getShardedGateway in interface SessionController

Parameters:

api - The current JDA instance (used for RestActions and ShardInfo)

Returns:

The ShardedGateway instance consisting of the gateway endpoint to connect to and the shardTotal

See Also:

• SessionController.getGateway()