net.md_5.bungee.api.config

Interface ServerInfo

public interface ServerInfo

Class used to represent a server to connect to.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canAccess(CommandSender sender) Whether the player can access this server.
InetSocketAddress	getAddress() Gets the connectable host + port pair for this server.
String	getMotd() Returns the MOTD which should be used when this server is a forced host.
String	getName() Get the name of this server.
Collection<ProxiedPlayer>	getPlayers() Get the set of all players on this server.
void	ping(Callback<ServerPing> callback) Asynchronously gets the current player count on this server.
void	sendData(String channel, byte[] data) Send data by any available means to this server.
boolean	sendData(String channel, byte[] data, boolean queue) Send data by any available means to this server.

Method Detail

getName

String getName()

Get the name of this server.

Returns:

the configured name for this server address

getAddress

InetSocketAddress getAddress()

Gets the connectable host + port pair for this server. Implementations expect this to be used as the unique identifier per each instance of this class.

Returns:

the IP and port pair for this server

getPlayers

Collection<ProxiedPlayer> getPlayers()

Get the set of all players on this server.

Returns:

an unmodifiable collection of all players on this server

getMotd

String getMotd()

Returns the MOTD which should be used when this server is a forced host.

Returns:

the motd

canAccess

boolean canAccess(CommandSender sender)

Whether the player can access this server. It will only return false when the player has no permission and this server is restricted.

Parameters:

sender - the player to check access for

Returns:

whether access is granted to this server

sendData

void sendData(String channel,
            byte[] data)

Send data by any available means to this server. This data may be queued and there is no guarantee of its timely arrival.

Parameters:

channel - the channel to send this data via

data - the data to send

sendData

boolean sendData(String channel,
               byte[] data,
               boolean queue)

Send data by any available means to this server.

Parameters:

channel - the channel to send this data via

data - the data to send

queue - hold the message for later sending if it cannot be sent immediately.

Returns:

true if the message was sent immediately, false otherwise if queue is true, it has been queued, if it is false it has been discarded.

ping

void ping(Callback<ServerPing> callback)

Asynchronously gets the current player count on this server.

Parameters:

callback - the callback to call when the count has been retrieved.