AudioNodeEntry (LavaClient 3.0.3 API)

```
public interface AudioNodeEntry
```
Represents an entry for an AudioNode with configuration options. This class can be constructed with an AudioNodeEntryBuilder.

Since:

0.1

Author:

SamOphis

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`long`	`getBaseReconnectInterval()` Returns a user-specified (or default) "base" interval used for reconnection purposes.
`LavaClient`	`getClient()` Fetches the `LavaClient` instance associated with this entry.
`SocketHandler`	`getHandlerByName(java.lang.String name)` Attempts to fetch a `SocketHandler` registered to this entry associated with a given name.
`java.util.Map<java.lang.String,SocketHandler>`	`getHandlerMap()` Fetches an unmodifiable view of the internal `SocketHandler` map.
`java.util.List<SocketHandler>`	`getHandlers()` Fetches an unmodifiable list containing all the `SocketHandlers` registered to this entry.
`java.lang.String`	`getHttpAddress()` Fetches the HTTP address of the `AudioNode` this entry represents, as used by the `LavaHttpManager` class.
`ReconnectIntervalFunction`	`getIntervalExpander()` Returns a user-specified (or default) `ReconnectIntervalFunction` used to change the next interval for the next reconnect attempt.
`java.util.concurrent.TimeUnit`	`getIntervalTimeUnit()` Returns a user-specified (or default) TimeUnit needed for LavaClient to know how long to wait for.
`long`	`getMaximumReconnectInterval()` Returns a user-specified (or default) maximum interval used for reconnection purposes.
`java.lang.String`	`getPassword()` Fetches the password of the associated `AudioNode`.
`java.lang.String`	`getRawAddress()` Fetches the server address of the `AudioNode` this entry represents, as provided by the user through an `AudioNodeEntryBuilder`.
`int`	`getRestPort()` Fetches the REST API port of the associated `AudioNode`.
`SocketInitializer`	`getSocketInitializer()` Fetches the possibly-null `SocketInitializer` used to "initialize" a LavaClient WebSocket connection.
`java.lang.String`	`getWebSocketAddress()` Fetches the WebSocket address (with the `'ws://'` scheme) of the `AudioNode` this entry represents.
`com.neovisionaries.ws.client.WebSocketFactory`	`getWebSocketFactory()` Returns a user-specified (or default) WebSocketFactory used to create the sockets needed to connect to nodes.
`int`	`getWebSocketPort()` Fetches the WebSocket port of the associated `AudioNode`.

- Method Detail
  - getClient
```
@Nonnull
LavaClient getClient()
```
    Fetches the LavaClient instance associated with this entry.
    Note: This entry gets its default values from the client.
    
    Returns:
    
    The LavaClient instance from which the entry gets its default values.
  - getRawAddress
```
@Nonnull
java.lang.String getRawAddress()
```
    Fetches the server address of the AudioNode this entry represents, as provided by the user through an AudioNodeEntryBuilder.
    
    Returns:
    
    The raw server address of the AudioNode this entry represents.
  - getHttpAddress
```
@Nonnull
java.lang.String getHttpAddress()
```
    Fetches the HTTP address of the AudioNode this entry represents, as used by the LavaHttpManager class.
    
    Returns:
    
    The HTTP address of the AudioNode this entry represents, with a default 'http://' scheme if not already provided.
  - getWebSocketAddress
```
@Nonnull
java.lang.String getWebSocketAddress()
```
    Fetches the WebSocket address (with the 'ws://' scheme) of the AudioNode this entry represents.
    This value cannot be specified manually -- it is constructed from the original server address passed to LavaClient.
    
    Returns:
    
    The WebSocket address of the AudioNode this entry represents.
  - getPassword
```
@Nonnull
java.lang.String getPassword()
```
    Fetches the password of the associated AudioNode.
    The password of this entry will be replaced with the default password if one isn't specified during construction of this entry.
    
    Returns:
    
    The password of the AudioNode this entry represents.
  - getWebSocketPort
```
@Nonnegative
int getWebSocketPort()
```
    Fetches the WebSocket port of the associated AudioNode.
    The WebSocket port of this entry will be replaced with the default WebSocket port if one isn't specified during construction of this entry.
    
    Returns:
    
    The WebSocket port of the AudioNode this entry represents.
  - getRestPort
```
@Nonnegative
int getRestPort()
```
    Fetches the REST API port of the associated AudioNode.
    The REST API port of this entry will be replaced with the default REST API port if one isn't specified during construction of this entry.
    
    Returns:
    
    The REST API port of the AudioNode this entry represents.
  - getSocketInitializer
```
@Nullable
SocketInitializer getSocketInitializer()
```
    Fetches the possibly-null SocketInitializer used to "initialize" a LavaClient WebSocket connection.
    
    Returns:
    
    The possibly-null SocketInitializer attached to this node entry.
  - getWebSocketFactory
```
@Nonnull
com.neovisionaries.ws.client.WebSocketFactory getWebSocketFactory()
```
    Returns a user-specified (or default) WebSocketFactory used to create the sockets needed to connect to nodes.
    
    Returns:
    
    A not-null WebSocketFactory.
  - getIntervalExpander
```
ReconnectIntervalFunction getIntervalExpander()
```
    Returns a user-specified (or default) ReconnectIntervalFunction used to change the next interval for the next reconnect attempt.
    
    Returns:
    
    A not-null ReconnectIntervalFunction.
  - getIntervalTimeUnit
```
@Nonnull
java.util.concurrent.TimeUnit getIntervalTimeUnit()
```
    Returns a user-specified (or default) TimeUnit needed for LavaClient to know how long to wait for.
    
    Returns:
    
    A not-null TimeUnit.
  - getBaseReconnectInterval
```
long getBaseReconnectInterval()
```
    Returns a user-specified (or default) "base" interval used for reconnection purposes.
    This value is basically the default interval, and it's used to reset old intervals as well as during initialization. This value CAN be negative.
    
    Returns:
    
    A possibly-negative base interval.
  - getMaximumReconnectInterval
```
@Nonnegative
long getMaximumReconnectInterval()
```
    Returns a user-specified (or default) maximum interval used for reconnection purposes.
    Users should not cap the values in their expanders themselves, but instead set the maximum value here. LavaClient will automatically cap the produced value so it doesn't exceed this number.
    
    Returns:
    
    A not-negative (positive) maximum value that intervals cannot exceed.
  - getHandlerMap
```
@Nonnull
java.util.Map<java.lang.String,SocketHandler> getHandlerMap()
```
    Fetches an unmodifiable view of the internal SocketHandler map.
    
    Returns:
    
    An unmodifiable view of the handler map.
  - getHandlers
```
@Nonnull
java.util.List<SocketHandler> getHandlers()
```
    Fetches an unmodifiable list containing all the SocketHandlers registered to this entry.
    
    Returns:
    
    An unmodifiable list containing SocketHandlers.
  - getHandlerByName
```
@Nullable
SocketHandler getHandlerByName(@Nonnull
                                         java.lang.String name)
```
    Attempts to fetch a SocketHandler registered to this entry associated with a given name.
    
    Parameters:
    
    name - The not-null name to look-up.
    
    Returns:
    
    A possibly-null SocketHandler instance.

Interface AudioNodeEntry

Method Summary

Method Detail

getClient

getRawAddress

getHttpAddress

getWebSocketAddress

getPassword

getWebSocketPort

getRestPort

getSocketInitializer

getWebSocketFactory

getIntervalExpander

getIntervalTimeUnit

getBaseReconnectInterval

getMaximumReconnectInterval

getHandlerMap

getHandlers

getHandlerByName