AudioNode (LavaClient 3.0.3 API)

```
public interface AudioNode
```
Represents a remote, independent audio-sending node running Lavalink Server that the client connects to.
Upon creation, LavaClient attempts to open a new connection to the node. Unlike the JDA Client, LavaClient will keep trying to reconnect to nodes unless the server closes the connection with close-code 1000, or until the client manually closes the connection.
When trying to open a new WebSocket connection to the node, initially LavaClient won't throw exceptions (it'll just log), however when trying to connect through openConnection(), there's a chance exceptions can be thrown.

Since:

0.1

Author:

SamOphis

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`closeConnection()` Attempts to close the current connection to the matching Lavalink Node.
`void`	`closeConnection(SocketConnectionHandler disconnectHandler)` Attempts to close the current connection, assigning a callback to be called upon the socket closing.
`LoadBalancer`	`getBalancer()` Fetches the not-null `LoadBalancer` that is responsible for determining the penalty imposed on the node.
`long`	`getBaseReconnectInterval()` Returns the "default" interval, which is used to set the actual interval before and after successful reconnects.
`LavaClient`	`getClient()` Returns the not-null `LavaClient` associated with this node object.
`SocketConnectionHandler`	`getConnectionCallback()` Returns a possibly-null `SocketConnectionHandler` specified by the user after a WebSocket Connection to this node successfully opens.
`SocketConnectionHandler`	`getDisconnectionCallback()` Returns a possibly-null `SocketConnectionHandler` specified by the user after the WebSocket Connection to this node closes.
`AudioNodeEntry`	`getEntry()` Returns the actual, not-null `entry` used to create this node object.
`ReconnectIntervalFunction`	`getIntervalExpander()` Returns a user-specified `ReconnectIntervalFunction` or the default one if it wasn't manually specified.
`java.util.concurrent.TimeUnit`	`getIntervalTimeUnit()` Returns the time unit LavaClient will attempt to wait in before attempting to reconnect.
`long`	`getMaximumReconnectInterval()` Returns the maximum interval LavaClient will wait before attempting to reconnect.
`int`	`getReconnectAttempts()` Returns the current amount of reconnects that have been attempted by LavaClient, set to zero if either none have been attempted or right after a reconnect succeeds.
`long`	`getReconnectInterval()` Returns the interval last used to try to reconnect to this node, set to the base reconnect interval if a reconnect hasn't been attempted, or just after a reconnect has succeeded.
`com.neovisionaries.ws.client.WebSocket`	`getSocket()` Returns the raw, possibly-null, third-party WebSocket connection to the node.
`Statistics`	`getStatistics()` Fetches the possibly-null `Statistics` data sent from this specific node, updated every minute.
`com.neovisionaries.ws.client.WebSocketFactory`	`getWebSocketFactory()` Returns a user-specified WebSocketFactory or the default LavaClient-provided one used to create WebSocket instances.
`boolean`	`isAvailable()` Returns whether or not the WebSocket connection is open (available).
`boolean`	`isUsingLavalinkVersionThree()` Returns whether or not this node is running Lavalink v3 based on response headers from the initial connection.
`void`	`openConnection()` Attempts to open a connection to the matching Lavalink Node.
`void`	`openConnection(SocketConnectionHandler connectHandler)` Attempts to open a connection to this node, assigning a callback to be called upon the socket actually opening.

- Method Detail
  - getClient
```
@Nonnull
LavaClient getClient()
```
    Returns the not-null LavaClient associated with this node object.
    
    Returns:
    
    The associated LavaClient.
  - getSocket
```
@Nullable
com.neovisionaries.ws.client.WebSocket getSocket()
```
    Returns the raw, possibly-null, third-party WebSocket connection to the node.
    It's advised that you seriously don't mess with this unless you know exactly what you are doing!
    Note: As of v2.5.0, this object can be null if LavaClient fails to connect to the node.
    
    Returns:
    
    The possibly-null WebSocket connection.
  - getBalancer
```
@Nonnull
LoadBalancer getBalancer()
```
    Fetches the not-null LoadBalancer that is responsible for determining the penalty imposed on the node.
    
    Returns:
    
    The not-null LoadBalancer.
  - getStatistics
```
@Nullable
Statistics getStatistics()
```
    Fetches the possibly-null Statistics data sent from this specific node, updated every minute.
    When initially connecting and for a short time afterwards this object may be null.
    
    Returns:
    
    The possibly-null Statistics data updated every minute.
  - getEntry
```
@Nonnull
AudioNodeEntry getEntry()
```
    Returns the actual, not-null entry used to create this node object.
    
    Returns:
    
    The entry data used to create the node.
  - isAvailable
```
boolean isAvailable()
```
    Returns whether or not the WebSocket connection is open (available).
    
    Returns:
    
    Whether or not the WebSocket connection is open.
  - isUsingLavalinkVersionThree
```
boolean isUsingLavalinkVersionThree()
```
    Returns whether or not this node is running Lavalink v3 based on response headers from the initial connection.
    
    Returns:
    
    Whether or not this node is running Lavalink v3.
  - getReconnectInterval
```
@Nonnegative
long getReconnectInterval()
```
    Returns the interval last used to try to reconnect to this node, set to the base reconnect interval if a reconnect hasn't been attempted, or just after a reconnect has succeeded.
    
    Returns:
    
    The reconnect interval last used to reconnect to this node.
  - getReconnectAttempts
```
@Nonnegative
int getReconnectAttempts()
```
    Returns the current amount of reconnects that have been attempted by LavaClient, set to zero if either none have been attempted or right after a reconnect succeeds.
    
    Returns:
    
    The current amount of reconnects to this node performed by LavaClient.
  - getBaseReconnectInterval
```
@Nonnegative
long getBaseReconnectInterval()
```
    Returns the "default" interval, which is used to set the actual interval before and after successful reconnects.
    
    Returns:
    
    The "default" reconnect interval.
  - getMaximumReconnectInterval
```
@Nonnegative
long getMaximumReconnectInterval()
```
    Returns the maximum interval LavaClient will wait before attempting to reconnect.
    If the value returned by getReconnectInterval() is smaller, that will be used, otherwise this will.
    
    Returns:
    
    The maximum interval LavaClient will wait before attempting to reconnect.
  - getIntervalTimeUnit
```
@Nonnull
java.util.concurrent.TimeUnit getIntervalTimeUnit()
```
    Returns the time unit LavaClient will attempt to wait in before attempting to reconnect.
    
    Returns:
    
    The time unit LavaClient will wait in for reconnect attempts.
  - getIntervalExpander
```
@Nonnull
ReconnectIntervalFunction getIntervalExpander()
```
    Returns a user-specified ReconnectIntervalFunction or the default one if it wasn't manually specified.
    This function is used to get the next interval for the next reconnect attempt.
    
    Returns:
    
    The not-null ReconnectIntervalFunction used by this node for reconnecting purposes.
  - getWebSocketFactory
```
@Nonnull
com.neovisionaries.ws.client.WebSocketFactory getWebSocketFactory()
```
    Returns a user-specified WebSocketFactory or the default LavaClient-provided one used to create WebSocket instances.
    Note: This configuration approach can be combined with SocketInitializers in order to configure everything that can be configured socket-wise.
    
    Returns:
    
    The not-null WebSocketFactory used to create the WebSocket instance that connects to this node.
  - getConnectionCallback
```
@Nullable
SocketConnectionHandler getConnectionCallback()
```
    Returns a possibly-null SocketConnectionHandler specified by the user after a WebSocket Connection to this node successfully opens.
    This callback is set via the openConnection(SocketConnectionHandler) method, which opens a connection AND sets the callback.
    LavaClient automatically sets the provided callback to null either after 2 seconds due to a timeout or right after connecting, mainly so that old callbacks aren't re-called.
    
    Returns:
    
    The possibly-null SocketConnectionHandler
  - getDisconnectionCallback
```
@Nullable
SocketConnectionHandler getDisconnectionCallback()
```
    Returns a possibly-null SocketConnectionHandler specified by the user after the WebSocket Connection to this node closes.
    This callback is set via the closeConnection(SocketConnectionHandler) method, which closes the connection AND sets the callback.
    LavaClient automatically sets the provided callback to null either after 2 seconds due to a timeout or right after disconnecting, mainly so that old callbacks aren't re-called.
    
    Returns:
    
    The possibly-null SocketConnectionHandler
  - openConnection
```
void openConnection()
```
    Attempts to open a connection to the matching Lavalink Node.
    This can be used to reconnect (open a new WebSocket connection), usually in the case of disconnection or if LavaClient failed to connect normally.
    
    Throws:
    
    java.lang.IllegalStateException - If a connection to the node is already open and available to use.
    
    SocketConnectionException - If LavaClient failed to open a connection to this node.
    
    See Also:
    
    openConnection(SocketConnectionHandler)
  - openConnection
```
void openConnection(@Nullable
                    SocketConnectionHandler connectHandler)
```
    Attempts to open a connection to this node, assigning a callback to be called upon the socket actually opening.
    The provided callback can be null, in which case no callback will be executed. To make it a little bit easier, you can avoid manually specifying null by using the openConnection()} method.
    
    Parameters:
    
    connectHandler - The possibly-null SocketConnectionHandler callback.
    
    Throws:
    
    java.lang.IllegalStateException - If the connection to the node is already open and available to use.
    
    SocketConnectionException - If LavaClient failed to open a connection to this node.
  - closeConnection
```
void closeConnection()
```
    Attempts to close the current connection to the matching Lavalink Node.
    This can be used to completely disconnect LavaClient from a node (and by extension, all LavaPlayers).
    
    Throws:
    
    java.lang.IllegalStateException - If the connection to the node is null or already closed/unavailable.
    
    See Also:
    
    closeConnection(SocketConnectionHandler)
  - closeConnection
```
void closeConnection(@Nullable
                     SocketConnectionHandler disconnectHandler)
```
    Attempts to close the current connection, assigning a callback to be called upon the socket closing.
    The provided callback can be null, in which case no callback will be executed. To make it a little bit easier, you can avoid manually specifying null by using the closeConnection()} method.
    
    Parameters:
    
    disconnectHandler - The possibly-null SocketConnectionHandler callback.
    
    Throws:
    
    java.lang.IllegalStateException - If the connection to the node is null or already closed/unavailable.

Interface AudioNode

Method Summary

Method Detail

getClient

getSocket

getBalancer

getStatistics

getEntry

isAvailable

isUsingLavalinkVersionThree

getReconnectInterval

getReconnectAttempts

getBaseReconnectInterval

getMaximumReconnectInterval

getIntervalTimeUnit

getIntervalExpander

getWebSocketFactory

getConnectionCallback

getDisconnectionCallback

openConnection

openConnection

closeConnection

closeConnection