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

Class ServerSocketListener<T extends Client>

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.net.ServerSocket serverSocket  

    • Constructor Summary

      Constructors 
      Constructor Description
      ServerSocketListener​(java.net.ServerSocket serverSocket)
      Constructs a new listener.

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      T acceptClient()
      Accepts the next client that appears on this listener.
      void close()
      Closes any underlying Closeable resources associated with this listener.
      protected abstract T createClient​(java.lang.String id, java.net.Socket socket)
      Creates the client object for a new socket connection
      private java.lang.String socketAddressToString​(java.net.SocketAddress address)
      Converts a socket address to a reasonable display string.
      java.lang.String toString()

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • serverSocket

        private final java.net.ServerSocket serverSocket

    • Constructor Detail

      • ServerSocketListener

        public ServerSocketListener​(java.net.ServerSocket serverSocket)
        Constructs a new listener.
        Parameters:
        serverSocket - server socket delegate

    • Method Detail

      • acceptClient

        public T acceptClient()
               throws java.io.IOException
        Accepts the next client that appears on this listener.

        An implementation of this method is expected to block the calling thread and not return until either a client appears or an exception occurs.

        Specified by:
        acceptClient in interface ServerListener<T extends Client>
        Returns:
        client object
        Throws:
        java.io.IOException

      • createClient

        protected abstract T createClient​(java.lang.String id,
                                  java.net.Socket socket)
                           throws java.io.IOException
        Creates the client object for a new socket connection
        Parameters:
        id - identifier string for the client
        socket - client's socket connection
        Returns:
        client object
        Throws:
        java.io.IOException

      • close

        public void close()
        Closes any underlying Closeable resources associated with this listener.

        Note that (as described in Doug Lea's discussion about interrupting I/O operations in "Concurrent Programming in Java" (Addison-Wesley Professional, 2nd edition, 1999) this method is used to interrupt any blocked I/O operation in the client when the server is shutting down. The client implementation must anticipate this potential, and gracefully exit when the blocked I/O operation throws the relevant IOException subclass.

        Note also, that unlike Closeable.close() this method is not permitted to propagate any IOException that occurs when closing the underlying resource(s).

        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Specified by:
        close in interface ServerListener<T extends Client>

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • socketAddressToString

        private java.lang.String socketAddressToString​(java.net.SocketAddress address)
        Converts a socket address to a reasonable display string.
        Parameters:
        address - the subject socket address
        Returns:
        display string