Package server

Class TcpServer

java.lang.Object

server.TcpServer

All Implemented Interfaces:

java.lang.AutoCloseable, java.lang.Runnable

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	TcpServer.ClientConnection

Constructor Summary

Constructors

Constructor	Description
TcpServer(int port)
TcpServer(int port, int timeout)
TcpServer(int port, int timeout, int backLog)
TcpServer(int port, int timeout, int backLog, boolean startImmediately)
TcpServer(int port, int timeout, int backLog, java.net.InetAddress bindAddr)
TcpServer(int port, int timeout, int backLog, java.net.InetAddress bindAddr, boolean startImmediately)

Method Summary

Modifier and Type	Method	Description
void	addCommandListener(CommandListener listener)
void	addConnectionListener(ServerConnectionListener listener)
void	addMessageListener(MessageListener listener)
void	close()	Attempts to gracefully-ish shutdown the server and disconnect all existing client connections
java.net.InetAddress	getSocketAddress()
void	removeAllListeners()
void	removeCommandListener(CommandListener listener)
void	removeConnectionListener(ServerConnectionListener listener)
void	removeMessageListener(MessageListener listener)
void	run()
void	sendCommand(java.io.PrintWriter outgoing, java.security.PublicKey key, java.lang.String command, java.lang.String arguments)	Sends a command to the client
void	sendText(java.io.PrintWriter outgoing, java.security.PublicKey key, java.lang.String data)	Sends a simple message to the client containing data
java.util.concurrent.CompletableFuture<java.lang.Void>	start()	Starts up the server if it is not already running

Methods inherited from class java.lang.Object

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

Constructor Detail

TcpServer

public TcpServer(int port)

Parameters:

port - port number that the server is to connect to

TcpServer

public TcpServer(int port,
                 int timeout)

Parameters:

port - port number that the server is to connect to

timeout - how many milliseconds of zero activity until a client is automatically disconnected

TcpServer

public TcpServer(int port,
                 int timeout,
                 int backLog)

Parameters:

port - port number that the server is to connect to

timeout - how many milliseconds of zero activity until a client is automatically disconnected

backLog - how many connections are allowed

TcpServer

public TcpServer(int port,
                 int timeout,
                 int backLog,
                 java.net.InetAddress bindAddr)

Parameters:

port - port number that the server is to connect to

timeout - how many milliseconds of zero activity until a client is automatically disconnected

backLog - how many connections are allowed

bindAddr - the local InetAddress the server will bind to. Leave null if you want to use "localhost"

TcpServer

public TcpServer(int port,
                 int timeout,
                 int backLog,
                 boolean startImmediately)
          throws ServerException

Parameters:

port - port number that the server is to connect to

timeout - how many milliseconds of zero activity until a client is automatically disconnected

backLog - how many connections are allowed

startImmediately - should the server immediately connect and start

Throws:

ServerException

TcpServer

public TcpServer(int port,
                 int timeout,
                 int backLog,
                 java.net.InetAddress bindAddr,
                 boolean startImmediately)
          throws ServerException

Parameters:

port - port number that the server is to connect to

timeout - how many milliseconds of zero activity until a client is automatically disconnected

backLog - how many connections are allowed

startImmediately - should the server immediately connect and start

bindAddr - the local InetAddress the server will bind to. Leave null if you want to use "localhost"

Throws:

ServerException

Method Detail

getSocketAddress

public java.net.InetAddress getSocketAddress()

Returns:

the InetAddress of the server

start

public java.util.concurrent.CompletableFuture<java.lang.Void> start()
                                                             throws ServerException

Starts up the server if it is not already running

Returns:

an empty CompletableFuture when the server has finished starting up

Throws:

ServerException - if something goes wrong during startup

addMessageListener

public void addMessageListener(MessageListener listener)

removeMessageListener

public void removeMessageListener(MessageListener listener)

addCommandListener

public void addCommandListener(CommandListener listener)

removeCommandListener

public void removeCommandListener(CommandListener listener)

addConnectionListener

public void addConnectionListener(ServerConnectionListener listener)

removeConnectionListener

public void removeConnectionListener(ServerConnectionListener listener)

removeAllListeners

public void removeAllListeners()

run

public void run()

Specified by:

run in interface java.lang.Runnable

sendText

public void sendText(java.io.PrintWriter outgoing,
                     java.security.PublicKey key,
                     java.lang.String data)

Sends a simple message to the client containing data

Parameters:

outgoing - PrintWriter used for sending messages to the client

key - PublicKey of the client used to encrypt the data

data - String data to be sent to the client

sendCommand

public void sendCommand(java.io.PrintWriter outgoing,
                        java.security.PublicKey key,
                        java.lang.String command,
                        java.lang.String arguments)

Sends a command to the client

Parameters:

outgoing - PrintWriter used to communicate to the client

key - PublicKey of the client used to encrypt the data

command - the command to be sent

arguments - the command arguments

close

public void close()

Attempts to gracefully-ish shutdown the server and disconnect all existing client connections

Specified by:

close in interface java.lang.AutoCloseable