public abstract class ConcurrentServerRunner<T extends Client> extends ContextAwareBase implements Runnable, ServerRunner<T>
ServerRunner.
An instance of this object is created with a ServerListener and
an Executor. On invocation of its run() method by the
Executor it begins accepting client connections via its ServerListener.
As each new Client is accepted, the client is configured with the
runner's ch.qos.logback.classic.LoggerContext and is then passed
to the Executor for concurrent execution of the client's service loop.
On invocation of the stop() method, the runner closes the listener
and each of the connected clients (by invoking Client.close()
effectively interrupting any blocked I/O calls and causing these concurrent
subtasks to exit gracefully). This ensures that before the stop()
method returns (1) all I/O resources have been released and (2) all
of the threads of the Executor are idle.
context| Constructor and Description |
|---|
ConcurrentServerRunner(ServerListener<T> listener,
Executor executor)
Constructs a new server runner.
|
| Modifier and Type | Method and Description |
|---|---|
void |
accept(ClientVisitor<T> visitor)
Presents each connected client to the given visitor.
|
protected abstract boolean |
configureClient(T client)
Configures a connected client.
|
boolean |
isRunning()
Gets a flag indicating whether the server is currently running.
|
void |
run() |
protected void |
setRunning(boolean running) |
void |
stop()
Stops execution of the runner.
|
addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, getDeclaredOrigin, getStatusManager, setContextclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitaddError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, setContextpublic ConcurrentServerRunner(ServerListener<T> listener, Executor executor)
listener - the listener from which the server will accept new
clientsexecutor - a executor that will facilitate execution of the
listening and client-handling tasks; while any Executor
is allowed here, outside of unit testing the only reasonable choice
is a bounded thread pool of some kind.public boolean isRunning()
isRunning in interface ServerRunner<T extends Client>protected void setRunning(boolean running)
public void stop()
throws IOException
This method must cause all I/O and thread resources associated with the runner to be released. If the receiver has not been started, this method must have no effect.
stop in interface ServerRunner<T extends Client>IOException - failed to stop runnerpublic void accept(ClientVisitor<T> visitor)
accept in interface ServerRunner<T extends Client>visitor - the subject visitorprotected abstract boolean configureClient(T client)
A subclass implements this method to perform any necessary configuration
of the client object before its Runnable.run() method is invoked.
client - the subject clienttrue if configuration was successful; if the return
value is false the client connection will be dropped