samophis.lavalink.client.entities

Interface EventWaiter

public interface EventWaiter

Represents a "logical" waiter used to send a full Voice Update to a possibly-provided AudioNode upon all the information being available.

This uses no sleep/wait logic, and so if Discord fails to send any information nothing bad will happen besides some angry developers. Additionally, this waiter CANNOT be used again, so you must recreate it for every voice connection that utilizes it.
Further note that this waiter will only send Lavalink Voice Updates -- the actual Discord Voice State Update and the rate limiting for the events is still something the end-user MUST implement to work properly.

Since:

0.2.2

Author:

SamOphis

Method Summary

Modifier and Type	Method and Description
static EventWaiter	from(LavaClient client, AudioNode node, java.util.function.Consumer<AudioNode> callback, long guild_id) Creates a new EventWaiter object for an associated AudioNode and Guild ID.
static EventWaiter	from(LavaClient client, AudioNode node, long guild_id) Creates a new EventWaiter object for an associated AudioNode and Guild ID.
static EventWaiter	from(LavaClient client, java.util.function.Consumer<AudioNode> callback, long guild_id) Creates a new EventWaiter object using the best AudioNode and provied Guild ID.
static EventWaiter	from(LavaClient client, long guild_id) Creates a new EventWaiter using the "best node" that has the least load on it and an associated Guild ID.
java.util.function.Consumer<AudioNode>	getCallback() Fetches the possibly-null callback used to execute code directly after a connection attempt while preserving order.
LavaClient	getClient() Fetches the LavaClient instance specified during construction of this event waiter.
java.lang.String	getEndpoint() Fetches the Voice Server Endpoint as set by the end-user.
long	getGuildId() Fetches the ID of the Guild to open an Audio Stream to, as specified by the end-user.
AudioNode	getNode() Fetches the not-null AudioNode this EventWaiter will send an update to.
java.lang.String	getSessionId() Fetches the Session ID as set by the end-user.
java.lang.String	getToken() Fetches the Voice Token (NOT the same as an Account Token) as set by the end-user.
void	setServerAndTryConnect(java.lang.String token, java.lang.String endpoint) Sets the Voice Token and Endpoint, attempting to connect if the Session ID has also been set.
void	setSessionIdAndTryConnect(java.lang.String session_id) Sets the Session ID and tries to connect if both the Voice Token and Endpoint have also been set.
void	tryConnect() Attempts to connect to the provided AudioNode regardless of current state.

Method Detail

getClient

@Nonnull
LavaClient getClient()

Fetches the LavaClient instance specified during construction of this event waiter.

Returns:

The LavaClient instance attached to this event waiter.

getSessionId

@Nullable
java.lang.String getSessionId()

Fetches the Session ID as set by the end-user. This may be 'null' at any given time.

Returns:

The possibly-null-or-invalid Session ID as set by the end-user.

getToken

@Nullable
java.lang.String getToken()

Fetches the Voice Token (NOT the same as an Account Token) as set by the end-user. This may be 'null' at any given time.

Returns:

The possibly-null-or-invalid Voice Token as set by the end-user.

getEndpoint

@Nullable
java.lang.String getEndpoint()

Fetches the Voice Server Endpoint as set by the end-user. This may be 'null' at any given time.

Returns:

The possibly-null-or-invalid Voice Server Endpoint as set by the end-user.

getCallback

@Nullable
java.util.function.Consumer<AudioNode> getCallback()

Fetches the possibly-null callback used to execute code directly after a connection attempt while preserving order.

Returns:

The provided, possibly-null connection callback.

getNode

@Nonnull
AudioNode getNode()

Fetches the not-null AudioNode this EventWaiter will send an update to.

LavaClient will automatically set this to the AudioNode with the least load on it if the user does not provide a node to connect to.

Returns:

The not-null AudioNode this EventWaiter will send an update to.

getGuildId

@Nonnegative
long getGuildId()

Fetches the ID of the Guild to open an Audio Stream to, as specified by the end-user.

Returns:

The possibly-invalid ID of the Guild to open an Audio Stream to, as specified by the end-user.

setSessionIdAndTryConnect

void setSessionIdAndTryConnect(@Nonnull
                               java.lang.String session_id)

Sets the Session ID and tries to connect if both the Voice Token and Endpoint have also been set.

Connecting will create or fetch a pre-existing LavaPlayer instance which is then cached.

Parameters:

session_id - The not-null Session ID to set.

Throws:

java.lang.NullPointerException - If 'session_id' is null.

setServerAndTryConnect

void setServerAndTryConnect(@Nonnull
                            java.lang.String token,
                            @Nonnull
                            java.lang.String endpoint)

Sets the Voice Token and Endpoint, attempting to connect if the Session ID has also been set.

Connecting will create or fetch a pre-existing LavaPlayer instance which is then cached.

Parameters:

token - The not-null Voice Token to set.

endpoint - The not-null Voice Server Endpoint to set.

Throws:

java.lang.NullPointerException - If either 'token' or 'endpoint' are null.

tryConnect

void tryConnect()

Attempts to connect to the provided AudioNode regardless of current state.

The user should have absolutely no need to call this method at all. It's pretty dangerous.

Throws:

java.lang.IllegalStateException - If the created LavaPlayer instance is null or in the incorrect State.

from

@Nonnull
static EventWaiter from(@Nonnull
                                 LavaClient client,
                                 @Nullable
                                 AudioNode node,
                                 @Nullable
                                 java.util.function.Consumer<AudioNode> callback,
                                 @Nonnegative
                                 long guild_id)

Creates a new EventWaiter object for an associated AudioNode and Guild ID.

LavaClient will replace the node with the "best node" that has the least load on it if the node is null.
This additionally allows a callback to be used once LavaClient attempts to send a Voice Update to Lavalink.

Parameters:

client - The not-null LavaClient instance used to get the best node.

node - The possibly-null AudioNode to connect to.

callback - The possibly-null callback to use right after LavaClient attempts to connect.

guild_id - The positive ID of the Guild to open an Audio Stream to.

Returns:

A new EventWaiter object with the provided AudioNode and Guild ID.

Throws:

java.lang.NullPointerException - If the provided client was null.

java.lang.IllegalArgumentException - If the provided Guild ID was negative.

See Also:

from(LavaClient, long), from(LavaClient, AudioNode, long), from(LavaClient, Consumer, long)

from

@Nonnull
static EventWaiter from(@Nonnull
                                 LavaClient client,
                                 @Nullable
                                 AudioNode node,
                                 @Nonnegative
                                 long guild_id)

Creates a new EventWaiter object for an associated AudioNode and Guild ID.

LavaClient will replace the node with the "best node" that has the least load on it if the node is null.

Parameters:

client - The not-null LavaClient instance used to get the best node.

node - The possibly-null AudioNode to connect to.

guild_id - The positive ID of the Guild to open an Audio Stream to.

Returns:

A new EventWaiter object with the provided AudioNode and Guild ID.

Throws:

java.lang.NullPointerException - If the provided client was null.

java.lang.IllegalArgumentException - If the provided Guild ID was negative.

See Also:

from(LavaClient, long), from(LavaClient, AudioNode, Consumer, long), from(LavaClient, Consumer, long)

from

@Nonnull
static EventWaiter from(@Nonnull
                                 LavaClient client,
                                 @Nonnegative
                                 long guild_id)

Creates a new EventWaiter using the "best node" that has the least load on it and an associated Guild ID.

Parameters:

client - The not-null LavaClient instance used to get the best node.

guild_id - The positive ID of the Guild to open an Audio Stream to.

Returns:

A new EventWaiter object with the AudioNode that has the least load on it and the associated Guild ID.

Throws:

java.lang.NullPointerException - If the provided client was null.

java.lang.IllegalArgumentException - If the provided Guild ID was negative.

See Also:

from(LavaClient, AudioNode, Consumer, long), from(LavaClient, AudioNode, long), from(LavaClient, Consumer, long)

from

@Nonnull
static EventWaiter from(@Nonnull
                                 LavaClient client,
                                 @Nullable
                                 java.util.function.Consumer<AudioNode> callback,
                                 @Nonnegative
                                 long guild_id)

Creates a new EventWaiter object using the best AudioNode and provied Guild ID.

LavaClient will replace the node with the "best node" that has the least load on it if the node is null.
This additionally allows a callback to be used once LavaClient attempts to send a Voice Update to Lavalink.

Parameters:

client - The not-null LavaClient instance used to fetch the best node.

callback - The possibly-null callback to use right after LavaClient attempts to connect.

guild_id - The positive ID of the Guild to open an Audio Stream to.

Returns:

A new EventWaiter object with the provided AudioNode and Guild ID.

Throws:

java.lang.NullPointerException - If the provided client was null.

java.lang.IllegalArgumentException - If the provided Guild ID was negative.

See Also:

from(LavaClient, long), from(LavaClient, AudioNode, long), from(LavaClient, AudioNode, Consumer, long)