samophis.lavalink.client.entities

Interface ReconnectIntervalFunction

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ReconnectIntervalFunction

A function used by LavaClient to determine how to expand the reconnection interval upon the next reconnect attempt.

By default, LavaClient will expand the old interval by raising 2 to the number of connection attempts, capped at fifteen seconds. You should not automatically cap the result as LavaClient already does that.
Additionally, the function must return a positive long, and the provided AudioNode and old reconnect interval are guaranteed to be not-null and positive respectively, if called by LavaClient.

Since:

2.6.0

Author:

Samuel Pritchard

Method Summary

Modifier and Type	Method and Description
long	expand(AudioNode node, long oldReconnectInterval) The actual expander method itself.

Method Detail

expand

@Nonnegative
long expand(@Nonnull
                         AudioNode node,
                         @Nonnegative
                         long oldReconnectInterval)

The actual expander method itself. Accepts an AudioNode as well as the old reconnect interval returned by AudioNode.getReconnectInterval().

Note: When "expanding" intervals, you can return any positive long/integer. This means you can customize the waiting periods to your liking. LavaClient will throw an IllegalArgumentException if the value returned by this method is negative.

Parameters:

node - The AudioNode to attempt a reconnect to.

oldReconnectInterval - The last reconnect interval.

Returns:

A not-negative (positive) interval.