net.lenni0451.mcping.pings

Interface IStatusListener

public interface IStatusListener

The interface used to listen for the status of a ping.

Important:
Some servers don't respond with a ping which causes the onPing(IPingResponse, long) method to not be called.
Make sure to also implement onResponse(IPingResponse) if you need the actual response.
If the server does not correctly respond with a ping the onError(Throwable) method will be called together with the onResponse(IPingResponse) method.
Only if the onPing(IPingResponse, long) method is called the ping will be treated successful.

Method Summary

Modifier and Type	Method and Description
default void	onConnected() Called when the connection to the server was established.
default void	onError(java.lang.Throwable throwable) Called when the ping failed with an exception.
default void	onPing(IPingResponse pingResponse, long ping) Called when the ping was successful.
default void	onResponse(IPingResponse pingResponse) Called when the server responded with a status message.

Method Detail

onError

default void onError(java.lang.Throwable throwable)

Called when the ping failed with an exception.
Common exceptions:
ConnectionRefusedException - The connection was refused by the server (unbound port, firewall, etc.)
UnknownHostException - The server address is invalid or the server is offline
ConnectTimeoutException - The connect timed out (server is offline or the connection is too slow)
DataReadException - The server responded with invalid data
PacketReadException - The server responded with invalid packets
ReadTimeoutException - The server did not respond in time
IOException - An unknown I/O error occurred

Parameters:

throwable - The thrown exception

onConnected

default void onConnected()

Called when the connection to the server was established.

onResponse

default void onResponse(IPingResponse pingResponse)

Called when the server responded with a status message.

Parameters:

pingResponse - The response

onPing

default void onPing(IPingResponse pingResponse,
                    long ping)

Called when the ping was successful.

Parameters:

pingResponse - The response

ping - The ping in ms