Package me.remigio07.chatplugin.api.server.util.socket

Class Client

java.lang.Object

me.remigio07.chatplugin.api.server.util.socket.Client

public class Client
extends Object

Client socket.

Obtain instances of this class with Client(InetAddress, int).

Constructor Summary

Constructors

Constructor	Description
Client(InetAddress serverAddress, int serverPort)	Constructs a new client socket.

Method Summary

Modifier and Type	Method	Description
ConnectionOutcome	connect(String id)	Connects this client to its server using the given ID.
void	disconnect()	Manually disconnects this client from the server.
String	getID()	Gets this client's ID.
DataInputStream	getInput()	Gets this client's data input stream.
DataOutputStream	getOutput()	Gets this client's data output stream.
InetAddress	getServerAddress()	Gets this client's server's address.
int	getServerPort()	Gets this client's server's port.
Socket	getSocket()	Gets this client's socket.
boolean	isConnected()	Checks if this client is currently connected to the server.
void	run()	Deprecated. Internal use only; do not call this method.
void	sendPacket(PacketSerializer packet)	Sends a packet to the server.

Methods inherited from class java.lang.Object

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

Constructor Details

Client

public Client(InetAddress serverAddress,
 int serverPort)

Constructs a new client socket.

Call connect(String) to connect it.

Parameters:

serverAddress - Server's address

serverPort - Server's port [0 - 65535]

Throws:

IllegalArgumentException - If port is outside of range [0 - 65535]

Method Details

connect

public ConnectionOutcome connect(String id)
                          throws IOException,
InterruptedException

Connects this client to its server using the given ID.

Parameters:

id - Client's ID

Returns:

Connection's outcome

Throws:

IOException - If something goes wrong

InterruptedException - If the identification task gets interrupted

See Also:

• ClientConnectionEvent

disconnect

public void disconnect()
                throws IOException

Manually disconnects this client from the server.

Throws:

IOException - If something goes wrong

See Also:

• ClientDisconnectionEvent

run

@Deprecated
public void run()

Deprecated.

Internal use only; do not call this method.

Automatic packet listener.

See Also:

• ClientReceivePacketEvent

sendPacket

public void sendPacket(PacketSerializer packet)

Sends a packet to the server.

Will do nothing if !isConnected().

Parameters:

packet - Packet to send

Throws:

IllegalStateException - If PacketSerializer.toArray() fails

isConnected

public boolean isConnected()

Checks if this client is currently connected to the server.

Returns:

Whether this client is connected

getServerAddress

public InetAddress getServerAddress()

Gets this client's server's address.

Returns:

Server's address

getServerPort

public int getServerPort()

Gets this client's server's port.

Returns:

Server's port

getSocket

public Socket getSocket()

Gets this client's socket.

Will return null if !isConnected().

Returns:

Client's socket

getID

public String getID()

Gets this client's ID.

Will return null if !isConnected().

Returns:

Client's ID

getInput

public DataInputStream getInput()

Gets this client's data input stream.

Will return null if !isConnected().

Returns:

Client's input stream

getOutput

public DataOutputStream getOutput()

Gets this client's data output stream.

Will return null if !isConnected().

Returns:

Client's output stream