Class EchoServer

java.lang.Object

org.newsclub.net.unix.server.SocketServer<SocketAddress, Socket, ServerSocket>

org.newsclub.net.unix.demo.server.EchoServer

public final class EchoServer
extends SocketServer<SocketAddress, Socket, ServerSocket>

A multi-threaded unix socket server that simply echoes all input, byte per byte.

Author:

Christian Kohlschütter

Constructor Summary

Constructors

Constructor	Description
EchoServer(SocketAddress listenAddress)

Method Summary

Modifier and Type	Method	Description
protected void	doServeSocket(Socket socket)	Called when a socket is ready to be served.
protected ServerSocket	newServerSocket()	Returns a new server socket.
protected void	onAfterServingSocket(Socket socket)	Called after the socket has been served.
protected void	onBeforeServingSocket(Socket socket)	Called before serving the socket.
protected void	onListenException(Exception e)	Called when an exception was thrown while listening on the server socket.
protected void	onServerBound(SocketAddress address)	Called when the server has been bound to a socket.
protected void	onServerBusy(long busySince)	Called when the server is busy / not ready to accept a new connection.
protected void	onServerReady(int activeCount)	Called when the server is ready to accept a new connection.
protected void	onServerShuttingDown()	Called when the server is shutting down.
protected void	onServerStarting()	Called when the server is starting up.
protected void	onServerStopped(ServerSocket theServerSocket)	Called when the server has been stopped.
protected void	onServingException(Socket socket, Throwable t)	Called when a throwable was thrown while serving a socket.
protected void	onSocketExceptionAfterAccept(Socket socket, SocketException e)	Called when a SocketException was thrown during "accept".
protected void	onSocketExceptionDuringAccept(SocketException e)	Called when a SocketException was thrown during "accept".
protected void	onSubmitted(Socket socket, Future<?> submit)	Called when a socket gets submitted into the process queue.

Methods inherited from class SocketServer

doSocketClose, getListenAddress, getMaxConcurrentConnections, getServerBusyTimeout, getServerTimeout, getSocketTimeout, isReady, isRunning, onListenException, onServingException, setMaxConcurrentConnections, setServerBusyTimeout, setServerTimeout, setSocketTimeout, start, startAndWaitToBecomeReady, startAndWaitToBecomeReady, startThenStopAfter, stop

Modifier and Type	Method	Description
protected void	doSocketClose(Socket socket)	Called upon closing a socket after serving the connection.
protected SocketAddress	getListenAddress()	Returns the address the server listens to.
int	getMaxConcurrentConnections()	Returns the maximum number of concurrent connections.
int	getServerBusyTimeout()	Returns the server-busy timeout (in milliseconds).
int	getServerTimeout()	Returns the server timeout (in milliseconds).
int	getSocketTimeout()	Returns the socket timeout (in milliseconds).
boolean	isReady()	Checks if the server is running and accepting new connections.
boolean	isRunning()	Checks if the server is running.
protected void	onListenException(Throwable t)	Called when an exception was thrown while listening on the server socket.
protected void	onServingException(Socket socket, Exception e)	Deprecated. Use SocketServer.onServingException(Socket, Throwable)
void	setMaxConcurrentConnections(int maxConcurrentConnections)	Sets the maximum number of concurrent connections.
void	setServerBusyTimeout(int timeout)	Sets the server-busy timeout (in milliseconds).
void	setServerTimeout(int timeout)	Sets the server timeout (in milliseconds).
void	setSocketTimeout(int timeout)	Sets the socket timeout (in milliseconds).
void	start()	Starts the server, and returns immediately.
void	startAndWaitToBecomeReady()	Starts the server and waits until it is ready or had to stop due to an error.
boolean	startAndWaitToBecomeReady(long duration, TimeUnit unit)	Starts the server and waits until it is ready or had to stop due to an error.
ScheduledFuture<IOException>	startThenStopAfter(long delay, TimeUnit unit)	Requests that the server will be stopped after the given time delay.
void	stop()	Stops the server.

Methods inherited from class Object

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

Constructor Details

EchoServer

public EchoServer(SocketAddress listenAddress)

Method Details

doServeSocket

protected void doServeSocket(Socket socket)
                      throws IOException

Description copied from class: SocketServer

Called when a socket is ready to be served.

Specified by:

doServeSocket in class SocketServer<SocketAddress, Socket, ServerSocket>

Parameters:

socket - The socket to serve.

Throws:

IOException - If there was an error.

onServerStarting

protected void onServerStarting()

Description copied from class: SocketServer

Called when the server is starting up.

Overrides:

onServerStarting in class SocketServer<SocketAddress, Socket, ServerSocket>

onServerBound

protected void onServerBound(SocketAddress address)

Description copied from class: SocketServer

Called when the server has been bound to a socket. This is not called when you instantiated the server with a pre-bound socket.

Overrides:

onServerBound in class SocketServer<SocketAddress, Socket, ServerSocket>

Parameters:

address - The bound address.

onServerBusy

protected void onServerBusy(long busySince)

Description copied from class: SocketServer

Called when the server is busy / not ready to accept a new connection. The frequency on how often this method is called when the server is busy is determined by SocketServer.getServerBusyTimeout().

Overrides:

onServerBusy in class SocketServer<SocketAddress, Socket, ServerSocket>

Parameters:

busySince - The time stamp since the server became busy.

onServerReady

protected void onServerReady(int activeCount)

Description copied from class: SocketServer

Called when the server is ready to accept a new connection.

Overrides:

onServerReady in class SocketServer<SocketAddress, Socket, ServerSocket>

Parameters:

activeCount - The current number of active tasks (= serving sockets).

onServerStopped

protected void onServerStopped(ServerSocket theServerSocket)

Description copied from class: SocketServer

Called when the server has been stopped.

Overrides:

onServerStopped in class SocketServer<SocketAddress, Socket, ServerSocket>

Parameters:

theServerSocket - The server's socket that stopped, or null.

onSubmitted

protected void onSubmitted(Socket socket,
 Future<?> submit)

Description copied from class: SocketServer

Called when a socket gets submitted into the process queue.

Overrides:

onSubmitted in class SocketServer<SocketAddress, Socket, ServerSocket>

Parameters:

socket - The socket.

submit - The Future referencing the submission; it's "done" after the socket has been served.

onBeforeServingSocket

protected void onBeforeServingSocket(Socket socket)

Description copied from class: SocketServer

Called before serving the socket.

Overrides:

onBeforeServingSocket in class SocketServer<SocketAddress, Socket, ServerSocket>

Parameters:

socket - The socket.

onServerShuttingDown

protected void onServerShuttingDown()

Description copied from class: SocketServer

Called when the server is shutting down.

Overrides:

onServerShuttingDown in class SocketServer<SocketAddress, Socket, ServerSocket>

onSocketExceptionDuringAccept

protected void onSocketExceptionDuringAccept(SocketException e)

Description copied from class: SocketServer

Called when a SocketException was thrown during "accept".

Overrides:

onSocketExceptionDuringAccept in class SocketServer<SocketAddress, Socket, ServerSocket>

Parameters:

e - The exception.

onSocketExceptionAfterAccept

protected void onSocketExceptionAfterAccept(Socket socket,
 SocketException e)

Description copied from class: SocketServer

Called when a SocketException was thrown during "accept".

Overrides:

onSocketExceptionAfterAccept in class SocketServer<SocketAddress, Socket, ServerSocket>

Parameters:

socket - The socket.

e - The exception.

onServingException

protected void onServingException(Socket socket,
 Throwable t)

Description copied from class: SocketServer

Called when a throwable was thrown while serving a socket.

Overrides:

onServingException in class SocketServer<SocketAddress, Socket, ServerSocket>

Parameters:

socket - The socket.

t - The throwable.

onAfterServingSocket

protected void onAfterServingSocket(Socket socket)

Description copied from class: SocketServer

Called after the socket has been served.

Overrides:

onAfterServingSocket in class SocketServer<SocketAddress, Socket, ServerSocket>

Parameters:

socket - The socket.

onListenException

protected void onListenException(Exception e)

Description copied from class: SocketServer

Called when an exception was thrown while listening on the server socket.

Overrides:

onListenException in class SocketServer<SocketAddress, Socket, ServerSocket>

Parameters:

e - The exception.

See Also:

• SocketServer.onListenException(Throwable)

newServerSocket

protected ServerSocket newServerSocket()
                                throws IOException

Description copied from class: SocketServer

Returns a new server socket.

Specified by:

newServerSocket in class SocketServer<SocketAddress, Socket, ServerSocket>

Returns:

The new socket (an AFServerSocket if the listen address is an AFSocketAddress).

Throws:

IOException - on error.