me.lucko.helper.messaging.bungee

Class BungeeMessaging

java.lang.Object

me.lucko.helper.messaging.bungee.BungeeMessaging

All Implemented Interfaces:

PluginMessageListener

@NonnullByDefault
public final class BungeeMessaging
extends Object
implements PluginMessageListener

Wrapper class for the BungeeCord Plugin Messaging API, providing callbacks to read response data

See: https://www.spigotmc.org/wiki/bukkit-bungee-plugin-messaging-channel and https://github.com/SpigotMC/BungeeCord/blob/master/proxy/src/main/java/net/md_5/bungee/connection/DownstreamBridge.java#L223

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALL_SERVERS Server name to represent all servers on the proxy
static String	ONLINE_SERVERS Server name to represent only the online servers on the proxy

Method Summary

Modifier and Type	Method and Description
static void	connect(Player player, String serverName) Connects a player to said subserver
static void	connectOther(String playerName, String serverName) Connects a named player to said subserver
static void	forward(String serverName, String channelName, byte[] data) Sends a custom plugin message to a given server.
static void	forward(String serverName, String channelName, ByteArrayDataOutput data) Sends a custom plugin message to a given server.
static void	forwardToPlayer(String playerName, String channelName, byte[] data) Sends a custom plugin message to a given server.
static void	forwardToPlayer(String playerName, String channelName, ByteArrayDataOutput data) Sends a custom plugin message to a given server.
static void	getServer(Consumer<String> callback) Gets this servers name, as defined in the BungeeCord config
static void	getServers(Consumer<List<String>> callback) Get a list of server name strings, as defined in the BungeeCord config
static void	ip(Player player, Consumer<Map.Entry<String,Integer>> callback) Get the real IP of a player
static void	kickPlayer(String playerName, String reason) Kick a player from the proxy
static void	message(String playerName, String message) Send a message (as in chat message) to the specified player
void	onPluginMessageReceived(String channel, Player player, byte[] data)
static void	playerCount(String serverName, Consumer<Integer> callback) Gets the amount of players on a certain server, or all servers
static void	playerList(String serverName, Consumer<List<String>> callback) Gets a list of players connected on a certain server, or all servers.
static void	registerForwardCallback(String channelName, Predicate<ByteArrayDataInput> callback) Registers a callback to listen for messages sent on forwarded subchannels.
static void	registerForwardCallbackRaw(String channelName, Predicate<byte[]> callback) Registers a callback to listen for messages sent on forwarded subchannels.
static void	serverIp(String serverName, Consumer<Map.Entry<String,Integer>> callback) Get the IP of any server connected to the proxy
static void	uuid(Player player, Consumer<UUID> callback) Get the UUID of a player
static void	uuidOther(String playerName, Consumer<UUID> callback) Get the UUID of any player connected to the proxy

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ALL_SERVERS

public static final String ALL_SERVERS

Server name to represent all servers on the proxy

See Also:

Constant Field Values

ONLINE_SERVERS

public static final String ONLINE_SERVERS

Server name to represent only the online servers on the proxy

See Also:

Constant Field Values

Method Detail

connect

public static void connect(Player player,
                           String serverName)

Connects a player to said subserver

Parameters:

player - the player to connect

serverName - the name of the server to connect to

connectOther

public static void connectOther(String playerName,
                                String serverName)

Connects a named player to said subserver

Parameters:

playerName - the username of the player to connect

serverName - the name of the server to connect to

ip

public static void ip(Player player,
                      Consumer<Map.Entry<String,Integer>> callback)

Get the real IP of a player

Parameters:

player - the player to get the IP of

callback - a callback to consume the ip and port

playerCount

public static void playerCount(String serverName,
                               Consumer<Integer> callback)

Gets the amount of players on a certain server, or all servers

Parameters:

serverName - the name of the server to get the player count for. Use ALL_SERVERS to get the global count

callback - a callback to consume the count

playerList

public static void playerList(String serverName,
                              Consumer<List<String>> callback)

Gets a list of players connected on a certain server, or all servers.

Parameters:

serverName - the name of the server to get the player list for. Use ALL_SERVERS to get the global list

callback - a callback to consume the player list

getServers

public static void getServers(Consumer<List<String>> callback)

Get a list of server name strings, as defined in the BungeeCord config

Parameters:

callback - a callback to consume the list of server names

message

public static void message(String playerName,
                           String message)

Send a message (as in chat message) to the specified player

Parameters:

playerName - the username of the player to send the message to

message - the message to send

getServer

public static void getServer(Consumer<String> callback)

Gets this servers name, as defined in the BungeeCord config

Parameters:

callback - a callback to consume the name

uuid

public static void uuid(Player player,
                        Consumer<UUID> callback)

Get the UUID of a player

Parameters:

player - the player to get the uuid of

callback - a callback to consume the uuid

uuidOther

public static void uuidOther(String playerName,
                             Consumer<UUID> callback)

Get the UUID of any player connected to the proxy

Parameters:

playerName - the username of the player to get the uuid of

callback - a callback to consume the uuid

serverIp

public static void serverIp(String serverName,
                            Consumer<Map.Entry<String,Integer>> callback)

Get the IP of any server connected to the proxy

Parameters:

serverName - the name of the server to get the ip of

callback - a callback to consume the ip and port

kickPlayer

public static void kickPlayer(String playerName,
                              String reason)

Kick a player from the proxy

Parameters:

playerName - the username of the player to kick

reason - the reason to display to the player when they are kicked

forward

public static void forward(String serverName,
                           String channelName,
                           byte[] data)

Sends a custom plugin message to a given server.

You can use registerForwardCallbackRaw(String, Predicate) to register listeners on a given subchannel.

Parameters:

serverName - the name of the server to send to. use ALL_SERVERS to send to all servers, or ONLINE_SERVERS to only send to servers which are online.

channelName - the name of the subchannel

data - the data to send

forward

public static void forward(String serverName,
                           String channelName,
                           ByteArrayDataOutput data)

Sends a custom plugin message to a given server.

You can use registerForwardCallback(String, Predicate) to register listeners on a given subchannel.

Parameters:

serverName - the name of the server to send to. use ALL_SERVERS to send to all servers, or ONLINE_SERVERS to only send to servers which are online.

channelName - the name of the subchannel

data - the data to send

forwardToPlayer

public static void forwardToPlayer(String playerName,
                                   String channelName,
                                   byte[] data)

Sends a custom plugin message to a given server.

You can use registerForwardCallbackRaw(String, Predicate) to register listeners on a given subchannel.

Parameters:

playerName - the username of a player. BungeeCord will send the forward message to their server.

channelName - the name of the subchannel

data - the data to send

forwardToPlayer

public static void forwardToPlayer(String playerName,
                                   String channelName,
                                   ByteArrayDataOutput data)

Sends a custom plugin message to a given server.

You can use registerForwardCallback(String, Predicate) to register listeners on a given subchannel.

Parameters:

playerName - the username of a player. BungeeCord will send the forward message to their server.

channelName - the name of the subchannel

data - the data to send

registerForwardCallbackRaw

public static void registerForwardCallbackRaw(String channelName,
                                              Predicate<byte[]> callback)

Registers a callback to listen for messages sent on forwarded subchannels.

Use forward(String, String, byte[]) to dispatch messages.

Parameters:

channelName - the name of the channel to listen on

callback - the callback. the predicate should return true when the callback should be unregistered.

registerForwardCallback

public static void registerForwardCallback(String channelName,
                                           Predicate<ByteArrayDataInput> callback)

Registers a callback to listen for messages sent on forwarded subchannels.

Use forward(String, String, ByteArrayDataOutput) to dispatch messages.

Parameters:

channelName - the name of the channel to listen on

callback - the callback. the predicate should return true when the callback should be unregistered.

onPluginMessageReceived

public void onPluginMessageReceived(String channel,
                                    Player player,
                                    byte[] data)

Specified by:

onPluginMessageReceived in interface PluginMessageListener