lib.easyjava.net.tcp

Class TCPServer<S extends java.io.Serializable,R extends java.io.Serializable>

java.lang.Object

lib.easyjava.net.tcp.TCPServer<S,R>

Type Parameters:

S - the type that is sent to clients of this server

R - the type that is received from clients of this server

public abstract class TCPServer<S extends java.io.Serializable,R extends java.io.Serializable>
extends java.lang.Object

A base Server which can be extended to handle many different types of applications. Keeps track of connections automatically and defines event handlers to control server actions.

Author:

Rob Rua (robrua@alumni.cmu.edu)

Constructor Summary

Constructors

Constructor and Description
TCPServer(int port) Creates a server on the given port.
TCPServer(int port, java.lang.Class<R> receivingClass) Creates a server on the given port.
TCPServer(int port, java.lang.Class<R> receivingClass, Logger logger) Creates a server on the given port.
TCPServer(int port, Logger logger) Creates a server on the given port.

Method Summary

Modifier and Type	Method and Description
void	broadcast(S message) Broadcasts some data to all connected clients
java.util.Set<Connection<S,R>>	getConnections() Gets the currently connected clients
void	stop() Tells the server to shut down.

Methods inherited from class java.lang.Object

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

Constructor Detail

TCPServer

public TCPServer(int port)
          throws java.io.IOException

Creates a server on the given port. This constructor will result in errors if the incorrect type is sent to the server. Use the other if the types sent can't be ensured.

Parameters:

port - the port to run off of

Throws:

java.io.IOException - if the server could not be opened

TCPServer

public TCPServer(int port,
                 java.lang.Class<R> receivingClass)
          throws java.io.IOException

Creates a server on the given port. This constructor will ignore all received data which does not fit the given receivingClass.

Parameters:

port - the port to run off of

receivingClass - the type clients will send to this server

Throws:

java.io.IOException - if the server could not be opened

TCPServer

public TCPServer(int port,
                 java.lang.Class<R> receivingClass,
                 Logger logger)
          throws java.io.IOException

Creates a server on the given port. This constructor will ignore all received data which does not fit the given receivingClass.

Parameters:

port - the port to run off of

receivingClass - the type clients will send to this server

logger - the logger to log errors to instead of the console

Throws:

java.io.IOException - if the server could not be opened

TCPServer

public TCPServer(int port,
                 Logger logger)
          throws java.io.IOException

Creates a server on the given port. This constructor will result in errors if the incorrect type is sent to the server. Use the other if the types sent can't be ensured.

Parameters:

port - the port to run off of

logger - the logger to log errors to instead of the console

Throws:

java.io.IOException - if the server could not be opened

Method Detail

broadcast

public void broadcast(S message)
               throws BroadcastException

Broadcasts some data to all connected clients

Parameters:

message - the data to send

Throws:

BroadcastException - if one or all clients couldn't be sent the message

getConnections

public java.util.Set<Connection<S,R>> getConnections()

Gets the currently connected clients

Returns:

the clients

stop

public void stop()

Tells the server to shut down. May take a few moments.