Class AFSocketServer<A extends AFSocketAddress>

java.lang.Object

org.newsclub.net.unix.server.SocketServer<A, AFSocket<? extends A>, AFServerSocket<? extends A>>

org.newsclub.net.unix.server.AFSocketServer<A>

Type Parameters:

A - The supported address type.

public abstract class AFSocketServer<A extends AFSocketAddress>
extends SocketServer<A, AFSocket<? extends A>, AFServerSocket<? extends A>>

A base implementation for a simple, multi-threaded socket server using AFSockets.

Author:

Christian Kohlschütter

Constructor Summary

Constructors

Constructor	Description
AFSocketServer(A listenAddress)	Creates a server using the given SocketAddress.
AFSocketServer(AFServerSocket<? extends A> serverSocket)	Creates a server using the given, bound ServerSocket.

Method Summary

Modifier and Type	Method	Description
protected AFServerSocket<A>	newServerSocket()	Returns a new server socket.

Methods inherited from class SocketServer

doServeSocket, doSocketClose, getListenAddress, getMaxConcurrentConnections, getServerBusyTimeout, getServerTimeout, getSocketTimeout, isReady, isRunning, onAfterServingSocket, onBeforeServingSocket, onListenException, onListenException, onServerBound, onServerBusy, onServerReady, onServerShuttingDown, onServerStarting, onServerStopped, onServingException, onServingException, onSocketExceptionAfterAccept, onSocketExceptionDuringAccept, onSubmitted, setMaxConcurrentConnections, setServerBusyTimeout, setServerTimeout, setSocketTimeout, start, startAndWaitToBecomeReady, startAndWaitToBecomeReady, startThenStopAfter, stop

Modifier and Type	Method	Description
protected abstract void	doServeSocket(AFSocket<? extends A> socket)	Called when a socket is ready to be served.
protected void	doSocketClose(AFSocket<? extends A> socket)	Called upon closing a socket after serving the connection.
protected A	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	onAfterServingSocket(AFSocket<? extends A> socket)	Called after the socket has been served.
protected void	onBeforeServingSocket(AFSocket<? extends A> socket)	Called before serving the socket.
protected void	onListenException(Exception e)	Deprecated. Use SocketServer.onListenException(Throwable)
protected void	onListenException(Throwable t)	Called when an exception was thrown while listening on the server socket.
protected void	onServerBound(A address)	Called when the server has been bound to a socket.
protected void	onServerBusy(long busyStartTime)	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(AFServerSocket<? extends A> socket)	Called when the server has been stopped.
protected void	onServingException(AFSocket<? extends A> socket, Exception e)	Deprecated. Use SocketServer.onServingException(Socket, Throwable)
protected void	onServingException(AFSocket<? extends A> socket, Throwable t)	Called when a throwable was thrown while serving a socket.
protected void	onSocketExceptionAfterAccept(AFSocket<? extends A> 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(AFSocket<? extends A> socket, Future<?> submission)	Called when a socket gets submitted into the process queue.
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

AFSocketServer

public AFSocketServer(AFServerSocket<? extends A> serverSocket)

Creates a server using the given, bound ServerSocket.

Parameters:

serverSocket - The server socket to use (must be bound).

AFSocketServer

public AFSocketServer(A listenAddress)

Creates a server using the given SocketAddress.

Parameters:

listenAddress - The address to bind the socket on.

Method Details

newServerSocket

protected AFServerSocket<A> newServerSocket()
                                     throws IOException

Description copied from class: SocketServer

Returns a new server socket.

Specified by:

newServerSocket in class SocketServer<A extends AFSocketAddress, AFSocket<? extends A extends AFSocketAddress>, AFServerSocket<? extends A extends AFSocketAddress>>

Returns:

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

Throws:

IOException - on error.