net.lenni0451.mcping.pings

Class ATCPPing

java.lang.Object

net.lenni0451.mcping.pings.APing

net.lenni0451.mcping.pings.ATCPPing

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

ClassicPing, LegacyPing, ModernPing, SocketPing

public abstract class ATCPPing
extends APing

The abstract class used to implement TCP based pings.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	ATCPPing.PacketReader
protected static interface	ATCPPing.PacketWriter

Field Summary

Fields

Modifier and Type	Field and Description
protected int	connectTimeout
protected int	protocolVersion
protected int	readTimeout
protected ITCPSocketFactory	socketFactory

Fields inherited from class net.lenni0451.mcping.pings.APing

gson

Constructor Summary

Constructors

Constructor and Description
ATCPPing(ITCPSocketFactory socketFactory, int connectTimeout, int readTimeout, int protocolVersion)

Method Summary

Modifier and Type	Method and Description
void	close()
protected ITCPSocket	connect(ServerAddress serverAddress) Connect a socket to the given server address.
protected void	prepareResponse(ServerAddress serverAddress, com.google.gson.JsonObject response) Prepare the response by adding default server information.
protected abstract void	readPacket(MCInputStream is, int packetId, ATCPPing.PacketReader packetReader) Read a packet from the input stream.
protected abstract void	writePacket(MCOutputStream os, int packetId, ATCPPing.PacketWriter packetWriter) Write a packet to the output stream.

Methods inherited from class net.lenni0451.mcping.pings.APing

getDefaultPort, ping, prepareResponse

Methods inherited from class java.lang.Object

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

Field Detail

socketFactory

protected final ITCPSocketFactory socketFactory

connectTimeout

protected final int connectTimeout

readTimeout

protected final int readTimeout

protocolVersion

protected final int protocolVersion

Constructor Detail

ATCPPing

public ATCPPing(ITCPSocketFactory socketFactory,
                int connectTimeout,
                int readTimeout,
                int protocolVersion)

Method Detail

connect

protected final ITCPSocket connect(ServerAddress serverAddress)
                            throws java.io.IOException

Connect a socket to the given server address.

Parameters:

serverAddress - The server address

Returns:

The connected socket

Throws:

java.io.IOException - If an I/O error occurs

ConnectTimeoutException - If the connection timed out

ConnectionRefusedException - If the connection was refused

close

public void close()
           throws java.lang.Exception

Throws:

java.lang.Exception

writePacket

protected abstract void writePacket(MCOutputStream os,
                                    int packetId,
                                    ATCPPing.PacketWriter packetWriter)
                             throws java.io.IOException

Write a packet to the output stream.

Parameters:

os - The output stream

packetId - The packet id

packetWriter - The packet writer

Throws:

java.io.IOException - If an I/O error occurs

readPacket

protected abstract void readPacket(MCInputStream is,
                                   int packetId,
                                   ATCPPing.PacketReader packetReader)
                            throws java.io.IOException

Read a packet from the input stream.

Parameters:

is - The input stream

packetId - The packet id

packetReader - The packet reader

Throws:

java.io.IOException - If an I/O error occurs

prepareResponse

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

Prepare the response by adding default server information.
See APing.prepareResponse(ServerAddress, JsonObject, int) for more information.

Parameters:

serverAddress - The server address

response - The response