PluginEventHandler.java

package dev.arbjerg.lavalink.api;

/**
 * Must be provided as a bean
 */
public abstract class PluginEventHandler {

    /**
     * Fired upon a new WebSocket being opened
     *
     * @param context the new websocket
     * @param resumed if the context was resumed and thus reused
     */
    public void onWebSocketOpen(ISocketContext context, boolean resumed) {}

    /**
     * Fired upon a WebSocket being closed while being configured for resuming
     *
     * @param context the socket context
     */
    public void onSocketContextPaused(ISocketContext context) {}

    /**
     * Fired once the WebSocket is closed without being resumable or when a WebSocket can no longer be resumed
     *
     * @param context the socket context
     */
    public void onSocketContextDestroyed(ISocketContext context) {}

    /**
     * Fired upon a WebSocket message being received
     *
     * @param context the websocket
     * @param message the message, presumably in JSON
     */
    public void onWebsocketMessageIn(ISocketContext context, String message) {}

    /**
     * Fired upon a WebSocket message being sent
     *
     * @param context the websocket
     * @param message the message, presumably in JSON
     */
    public void onWebSocketMessageOut(ISocketContext context, String message) {}

    /**
     * Fired upon a new player being created
     *
     * @param context the websocket
     * @param player  the new player
     */
    public void onNewPlayer(ISocketContext context, IPlayer player) {}

    /**
     * Fired upon a player being destroyed
     *
     * @param context the websocket
     * @param player  the player to be destroyed
     */
    public void onDestroyPlayer(ISocketContext context, IPlayer player) {}
}