Module dev.bitbite.opennetlib

Package dev.bitbite.networking

Class Server

java.lang.Object

dev.bitbite.networking.Server

Direct Known Subclasses:

SSLServer

public abstract class Server
extends java.lang.Object

Represents an abstract implementation of the server-side connection.
The server must be started using start() for clients to be able to connect.
Shutting down the server can be done using close()
Incoming data from any client will be processed by the DataProcessingLayers and then propagated to processReceivedData(String, byte[]) containing the clients address of the client the data came from. In order to send data to the client you must request the proper CommunicationHandler using the servers ClientManager (ClientManager.getCommunicationHandlerByIP(String))

See Also:

ClientManager, CommunicationHandler, DataProcessingLayer, DataPreProcessor

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientManager	clientManager
protected DataPreProcessor	dataPreProcessor
protected DisconnectedClientDetector	disconnectedClientDetector
protected java.util.ArrayList<IOHandlerListener>	iOListeners
protected java.util.ArrayList<ServerListener>	listeners
int	PORT
protected java.net.ServerSocket	serverSocket

Constructor Summary

Constructors

Constructor	Description
Server(int port)	Creates a server object and sets the port the server will try to listen on

Method Summary

Modifier and Type	Method	Description
void	broadcast(byte[] data)	Sends the data to all connected clients.
void	close()	Initiates the closing process of the Server with closing the ClientManager and disabling the DataProcessingLayers.
protected void	notifyListeners(dev.bitbite.networking.Server.EventType type, java.lang.Object... args)	Calls the respective function of each listener depending on the event type. Optionally Propagates additional info such as exceptions.
protected void	openServerSocket()	Opens the ServerSocket.
protected abstract void	processReceivedData(java.lang.String clientAddress, byte[] data)	This function will be called once the server receives data from the client.
void	registerListener(IOHandlerListener listener)	Registers an IOHandlerListener
void	registerListener(ServerListener listener)	Registers a ClientListener
void	removeListener(IOHandlerListener listener)	Removes IOHandlerListener from the listeners
void	removeListener(ServerListener listener)	Removes ClientListener from the listeners
boolean	send(java.lang.String clientAddress, byte[] data)
void	start()	Opens a ServerSocket, initializes the DataProcessingLayers and starts listening on the specified port

Methods inherited from class java.lang.Object

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

Field Detail

PORT

public final int PORT

serverSocket

protected java.net.ServerSocket serverSocket

clientManager

protected ClientManager clientManager

dataPreProcessor

protected DataPreProcessor dataPreProcessor

disconnectedClientDetector

protected DisconnectedClientDetector disconnectedClientDetector

listeners

protected java.util.ArrayList<ServerListener> listeners

iOListeners

protected java.util.ArrayList<IOHandlerListener> iOListeners

Constructor Detail

Server

public Server(int port)

Creates a server object and sets the port the server will try to listen on

Parameters:

port - to listen on

Method Detail

start

public void start()

Opens a ServerSocket, initializes the DataProcessingLayers and starts listening on the specified port

openServerSocket

protected void openServerSocket()
                         throws java.io.IOException

Opens the ServerSocket. Moved to a different function to make it easier to replace the ServerSocket implementation.

Throws:

java.io.IOException - when the process of opening the ServerSocket fails.

close

public void close()

Initiates the closing process of the Server with closing the ClientManager and disabling the DataProcessingLayers. Finally, it closes the serverSocket

processReceivedData

protected abstract void processReceivedData(java.lang.String clientAddress,
                                            byte[] data)

This function will be called once the server receives data from the client.

Parameters:

clientAddress - of the client the data came from

data - sent by the server

send

public boolean send(java.lang.String clientAddress,
                    byte[] data)

broadcast

public void broadcast(byte[] data)

Sends the data to all connected clients.

Parameters:

data - to broadcast

registerListener

public void registerListener(ServerListener listener)

Registers a ClientListener

Parameters:

listener - to add

registerListener

public void registerListener(IOHandlerListener listener)

Registers an IOHandlerListener

Parameters:

listener - to add

removeListener

public void removeListener(ServerListener listener)

Removes ClientListener from the listeners

Parameters:

listener - to remove

removeListener

public void removeListener(IOHandlerListener listener)

Removes IOHandlerListener from the listeners

Parameters:

listener - to remove

notifyListeners

protected void notifyListeners(dev.bitbite.networking.Server.EventType type,
                               java.lang.Object... args)

Calls the respective function of each listener depending on the event type.
Optionally Propagates additional info such as exceptions.

Parameters:

type - of event that occured

args - optional additional data

Throws:

java.lang.IllegalArgumentException - if additional arguments are supplied whose types do not match the expected types of the listeners eventfunction

See Also:

ServerListener