Package ch.qos.logback.core.net.server

Class ConcurrentServerRunner<T extends Client>

  • All Implemented Interfaces:
    ServerRunner<T>, ContextAware, java.lang.Runnable
    Direct Known Subclasses:
    RemoteAppenderServerRunner, RemoteReceiverServerRunner
    public abstract class ConcurrentServerRunner<T extends Client>
extends ContextAwareBase
implements java.lang.Runnable, ServerRunner<T>
    A concurrent ServerRunner.

    An instance of this object is created with a ServerListener and an Executor. On invocation of the #start() method, it passes itself to the given Executor and returns immediately. 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 LoggingContext 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.

    • Field Detail

      • clientsLock

        private final java.util.concurrent.locks.Lock clientsLock

      • clients

        private final java.util.Collection<T extends Client> clients

      • executor

        private final java.util.concurrent.Executor executor

      • running

        private boolean running

    • Constructor Detail

      • ConcurrentServerRunner

        public ConcurrentServerRunner​(ServerListener<T> listener,
                              java.util.concurrent.Executor executor)
        Constructs a new server runner.
        Parameters:
        listener - the listener from which the server will accept new clients
        executor - 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.

    • Method Detail

      • isRunning

        public boolean isRunning()
        Gets a flag indicating whether the server is currently running.
        Specified by:
        isRunning in interface ServerRunner<T extends Client>
        Returns:
        flag state

      • setRunning

        protected void setRunning​(boolean running)

      • stop

        public void stop()
          throws java.io.IOException
        Stops execution of the runner.

        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.

        Specified by:
        stop in interface ServerRunner<T extends Client>
        Throws:
        java.io.IOException

      • accept

        public void accept​(ClientVisitor<T> visitor)
        Presents each connected client to the given visitor.
        Specified by:
        accept in interface ServerRunner<T extends Client>
        Parameters:
        visitor - the subject visitor

      • copyClients

        private java.util.Collection<T> copyClients()
        Creates a copy of the collection of all clients that are presently being tracked by the server.
        Returns:
        collection of client objects

      • run

        public void run()
        Specified by:
        run in interface java.lang.Runnable

      • configureClient

        protected abstract boolean configureClient​(T client)
        Configures a connected client.

        A subclass implements this method to perform any necessary configuration of the client object before its Runnable.run() method is invoked.

        Parameters:
        client - the subject client
        Returns:
        true if configuration was successful; if the return value is false the client connection will be dropped

      • addClient

        private void addClient​(T client)
        Adds a client to the collection of those being tracked by the server.
        Parameters:
        client - the client to add

      • removeClient

        private void removeClient​(T client)
        Removes a client from the collection of those being tracked by the server.
        Parameters:
        client - the client to remote