samophis.lavalink.client.entities

Interface SocketHandler

public interface SocketHandler

A handler which takes incoming messages from Lavalink Nodes and responds in some way.

Note: LavaClient will override any handlers with names like voiceUpdate as they have predefined behaviours.

Since:

2.2.0

Author:

Sam Pritchard

Method Summary

Modifier and Type	Method and Description
static SocketHandler	from(java.lang.String name, java.util.function.BiConsumer<com.neovisionaries.ws.client.WebSocket,java.lang.String> rawHandler) Creates a new SocketHandler instance with a provided name and event handler.
java.lang.String	getName() Returns the not-null name of this handler (the name of the OP it responds to).
void	handleIncoming(com.neovisionaries.ws.client.WebSocket socket, java.lang.String data) Responds to an incoming OP from Lavalink in some pre-defined manner.

Method Detail

getName

@Nonnull
java.lang.String getName()

Returns the not-null name of this handler (the name of the OP it responds to).

Returns:

The not-null name of this handler.

handleIncoming

void handleIncoming(@Nonnull
                    com.neovisionaries.ws.client.WebSocket socket,
                    @Nonnull
                    java.lang.String data)

Responds to an incoming OP from Lavalink in some pre-defined manner.

Parameters:

socket - The not-null WebSocket connection between LavaClient and a Lavalink Node.

data - The not-null data from the event.

from

@Nonnull
static SocketHandler from(@Nonnull
                                   java.lang.String name,
                                   @Nonnull
                                   java.util.function.BiConsumer<com.neovisionaries.ws.client.WebSocket,java.lang.String> rawHandler)

Creates a new SocketHandler instance with a provided name and event handler.

Parameters:

name - The not-null name of the SocketHandler.

rawHandler - The not-null handler callback used to respond to incoming events.

Returns:

A not-null SocketHandler instance.