Package dev.redcoke.mcserverping

Class MCServerPing

java.lang.Object

dev.redcoke.mcserverping.MCServerPing

public final class MCServerPing
extends Object

API for pinging and obtaining info about a Minecraft server.

Constructor Summary

Constructors

Constructor	Description
MCServerPing()

Method Summary

Modifier and Type	Method	Description
static @NotNull ServerPingResponse	getPing(String address)	Pings a Minecraft Server to obtain server info.
static @NotNull ServerPingResponse	getPing(String address, int port)	Pings a Minecraft Server to obtain server info.
static @NotNull ServerPingResponse	getPingWithTimeout(String address, int timeout)	Pings a Minecraft server to obtain info with the custom timeout parameter.
static ServerPingResponse	getPingWithTimeout(String address, int port, int timeout)	Pings a Minecraft Server to obtain server info with a custom timeout parameter.
static void	io(boolean b, String m)	Throws IOException when condition is false.
static int	readVarInt(DataInputStream in)	Reads a VarInt from a DataInputStream.
static void	writeVarInt(DataOutputStream out, int inputParamInt)

Methods inherited from class java.lang.Object

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

Constructor Detail

MCServerPing

public MCServerPing()

Method Detail

getPingWithTimeout

@Contract("null, _ -> fail")
@NotNull
public static @NotNull ServerPingResponse getPingWithTimeout(String address,
                                                             int timeout)
                                                      throws IOException,
                                                             TimeoutException

Pings a Minecraft server to obtain info with the custom timeout parameter.

Parameters:

address - The address to ping

timeout - The timeout for the socket

Returns:

The ping response.

Throws:

IOException - For any i/o exception during the data exchange.

TimeoutException - If the socket connection times out.

getPing

@Contract("null -> fail")
@NotNull
public static @NotNull ServerPingResponse getPing(String address)
                                           throws IOException,
                                                  TimeoutException

Pings a Minecraft Server to obtain server info.

Parameters:

address - server address

Returns:

MCServerPingResponse

Throws:

IOException - failed to resolve hostname

TimeoutException

getPing

@Contract("null, _ -> fail")
@NotNull
public static @NotNull ServerPingResponse getPing(String address,
                                                  int port)
                                           throws IOException,
                                                  TimeoutException

Pings a Minecraft Server to obtain server info.

Parameters:

address - server address

port - server port

Returns:

MCServerPingResponse server info

Throws:

IOException - failed to resolve hostname

TimeoutException - when the server does not respond within 3 seconds

See Also:

ServerPingResponse

getPingWithTimeout

public static ServerPingResponse getPingWithTimeout(String address,
                                                    int port,
                                                    int timeout)
                                             throws IOException,
                                                    TimeoutException

Pings a Minecraft Server to obtain server info with a custom timeout parameter.

Parameters:

address - server address

port - server port

timeout - The timeout for the socket

Returns:

MCServerPingResponse server info

Throws:

IOException - failed to resolve hostname

TimeoutException - when the server does not respond within 3 seconds

See Also:

ServerPingResponse

io

public static void io(boolean b,
                      String m)
               throws IOException

Throws IOException when condition is false.

Parameters:

b - Condition

m - Exception cause

Throws:

IOException - Exception

readVarInt

public static int readVarInt(DataInputStream in)
                      throws IOException,
                             TimeoutException

Reads a VarInt from a DataInputStream.

Parameters:

in - DataInputStream

Returns:

int

Throws:

IOException - Failed to read VarInt or invalid VarInt

TimeoutException - Timed out

writeVarInt

public static void writeVarInt(DataOutputStream out,
                               int inputParamInt)
                        throws IOException

Throws:

IOException