Package client

Class TcpClient

java.lang.Object

client.TcpClient

All Implemented Interfaces:

java.lang.AutoCloseable, java.lang.Runnable

public class TcpClient
extends java.lang.Object
implements java.lang.AutoCloseable, java.lang.Runnable

Constructor Summary

Constructors

Constructor	Description
TcpClient(java.lang.String host, int port)	Creates a new TcpClient bound to the specified host and port
TcpClient(java.lang.String host, int port, boolean connectImmediately)	Creates a new TcpClient bound to the specified host and port

Method Summary

Modifier and Type	Method	Description
void	addCommandListener(CommandListener listener)
void	addMessageListener(MessageListener listener)
void	close()	Attempts to gracefully-ish disconnect from the server that the client is connected to
java.util.concurrent.CompletableFuture<java.lang.Void>	connect()	Attempts to connect the client to the server specified when creating the client object
java.util.Optional<ClientConnection>	getConnection()
void	removeAllListeners()
void	removeCommandListener(CommandListener listener)
void	removeMessageListener(MessageListener listener)
void	run()
void	sendCommand(java.lang.String command, java.lang.String arguments)	Attempts to format, encrypt, and send the command and arguments to the server that the client is currently connected to
void	sendText(java.lang.String data)	Attempts to encrypt and send the data to the server that the client is currently connected to

Methods inherited from class java.lang.Object

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

Constructor Detail

TcpClient

public TcpClient(java.lang.String host,
                 int port)

Creates a new TcpClient bound to the specified host and port

Parameters:

host - the host name, or null for the loopback address.

port - the port number.

TcpClient

public TcpClient(java.lang.String host,
                 int port,
                 boolean connectImmediately)
          throws ClientException

Creates a new TcpClient bound to the specified host and port

Parameters:

host - the address of the server

port - the port the client should try to connect to the server through

connectImmediately - true if you want the client to automatically connect to the server

Throws:

ClientException

Method Detail

connect

public java.util.concurrent.CompletableFuture<java.lang.Void> connect()
                                                               throws ClientException

Attempts to connect the client to the server specified when creating the client object

Returns:

an empty completed future when the client is fully connected to the server

Throws:

ClientException - if the client failed to create a secure connection with the server

addMessageListener

public void addMessageListener(MessageListener listener)

removeMessageListener

public void removeMessageListener(MessageListener listener)

addCommandListener

public void addCommandListener(CommandListener listener)

removeCommandListener

public void removeCommandListener(CommandListener listener)

removeAllListeners

public void removeAllListeners()

getConnection

public java.util.Optional<ClientConnection> getConnection()

run

public void run()

Specified by:

run in interface java.lang.Runnable

sendText

public void sendText(java.lang.String data)
              throws ClientException

Attempts to encrypt and send the data to the server that the client is currently connected to

Parameters:

data - the String to be sent to the server

Throws:

ClientException - if something went wrong while trying to send the message

java.lang.IllegalArgumentException - if data is null

sendCommand

public void sendCommand(java.lang.String command,
                        java.lang.String arguments)
                 throws ClientException

Attempts to format, encrypt, and send the command and arguments to the server that the client is currently connected to

Parameters:

command -

arguments -

Throws:

ClientException - if something went wrong while trying to send the message

close

public void close()

Attempts to gracefully-ish disconnect from the server that the client is connected to

Specified by:

close in interface java.lang.AutoCloseable