ILoadBalancer 3.2.0 API

All Implemented Interfaces:


public interface ILoadBalancer

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`LavalinkNode`	`selectNode()`	Selects a node based on the criteria of the load balancer.
`abstract LavalinkNode`	`selectNode(VoiceRegion region, Long guildId)`	Selects a node based on the criteria of the load balancer.
`abstract Unit`	`addPenaltyProvider(IPenaltyProvider penaltyProvider)`	Adds a penalty provider to the load balancer.
`abstract Unit`	`removePenaltyProvider(IPenaltyProvider penaltyProvider)`	Removes a penalty provider from the load balancer.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - selectNode
```
 LavalinkNode selectNode()
```
    Selects a node based on the criteria of the load balancer.
    
    Returns:
    
    The best node that matches the criteria
  - selectNode
```
 abstract LavalinkNode selectNode(VoiceRegion region, Long guildId)
```
    Selects a node based on the criteria of the load balancer.
    
    Parameters:
    
    region - A voice region may be provided to filter on the closest region to this node
    
    guildId - The ID of the guild to be associated with the returned node
    
    Returns:
    
    The best node that matches the criteria
  - addPenaltyProvider
```
 abstract Unit addPenaltyProvider(IPenaltyProvider penaltyProvider)
```
    Adds a penalty provider to the load balancer.
  - removePenaltyProvider
```
 abstract Unit removePenaltyProvider(IPenaltyProvider penaltyProvider)
```
    Removes a penalty provider from the load balancer.