ICluster class abstract
- Implemented types
Constructors
- ICluster()
Properties
- bestNode → INode
-
Get the best available node, it is recommended to use getOrCreatePlayerNode instead
as this won't create the player itself if it doesn't exists
read-only
- client → INyxx
-
A reference to the client
read-only
- clientId → Snowflake
-
The client id provided to lavalink;
read-only
-
connectedNodes
→ UnmodifiableMapView<
int, INode> -
Returns a map with the nodes connected to lavalink cluster
read-only
-
disconnectedNodes
→ UnmodifiableMapView<
int, INode> -
Returns a map with the nodes that are actually disconnected from lavalink
read-only
- eventDispatcher ↔ IEventDispatcher
-
Dispatcher of all lavalink events
latefinal
- hashCode → int
-
The hash code for this object.
read-onlyinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
read-onlyinherited
Methods
-
addNode(
NodeOptions options) → Future< void> - Adds and initializes a node
-
dispose(
) → Future< void> -
Perform cleanup
inherited
-
getDisconnectedNode(
int nodeId) → INode? - Attempts to retrieve a node disconnected from lavalink by its id, this method does not work with nodes that have exceeded the maximum reconnect attempts as those get removed from cluster
-
getOrCreatePlayerNode(
Snowflake guildId) → INode - Attempts to get the node containing a player for a specific guild id
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
createCluster(
INyxxWebsocket client, Snowflake clientId) → ICluster