net.lenni0451.mcping.pings

Class APing

java.lang.Object

net.lenni0451.mcping.pings.APing

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

ATCPPing, AUDPPing

public abstract class APing
extends java.lang.Object
implements java.lang.AutoCloseable

The abstract class used to implement a ping.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.google.gson.Gson	gson

Constructor Summary

Constructors

Constructor and Description
APing()

Method Summary

Modifier and Type	Method and Description
abstract int	getDefaultPort()
abstract void	ping(ServerAddress serverAddress, IStatusListener statusListener) Ping the server and call the status listener.
protected void	prepareResponse(ServerAddress serverAddress, com.google.gson.JsonObject response, int protocolVersion) Prepare the response by adding default server information like the host, port, protocol versions and the description.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

gson

protected final com.google.gson.Gson gson

Constructor Detail

APing

public APing()

Method Detail

getDefaultPort

public abstract int getDefaultPort()

Returns:

The default port of this ping protocol

ping

public abstract void ping(ServerAddress serverAddress,
                          IStatusListener statusListener)

Ping the server and call the status listener.

Parameters:

serverAddress - The server address

statusListener - The status listener

prepareResponse

protected final void prepareResponse(ServerAddress serverAddress,
                                     com.google.gson.JsonObject response,
                                     int protocolVersion)

Prepare the response by adding default server information like the host, port, protocol versions and the description.
The description is converted to a string if it is a json object. You can use my library MCStructs to parse the description component if required.

Parameters:

serverAddress - The server address

response - The response

protocolVersion - The protocol version