svn commit: r669117 - /mina/trunk/core/src/main/java/org/apache/mina/common/AbstractPollingIoAcceptor.java

[jv...@apache.org]

Author: jvermillard
Date: Wed Jun 18 02:00:16 2008
New Revision: 669117

URL: http://svn.apache.org/viewvc?rev=669117&view=rev
Log:
AbstractPollingIoAcceptor javadoced finalized, TODO tag removed

Modified:
    mina/trunk/core/src/main/java/org/apache/mina/common/AbstractPollingIoAcceptor.java

Modified: mina/trunk/core/src/main/java/org/apache/mina/common/AbstractPollingIoAcceptor.java
URL: http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/common/AbstractPollingIoAcceptor.java?rev=669117&r1=669116&r2=669117&view=diff
==============================================================================
--- mina/trunk/core/src/main/java/org/apache/mina/common/AbstractPollingIoAcceptor.java (original)
+++ mina/trunk/core/src/main/java/org/apache/mina/common/AbstractPollingIoAcceptor.java Wed Jun 18 02:00:16 2008
@@ -32,8 +32,20 @@
 import java.util.concurrent.Executor;
 import java.util.concurrent.Executors;
 
+import org.apache.mina.transport.socket.nio.NioSocketAcceptor;
+
 /**
- * TODO Add documentation
+ * A base class for implementing transport using a polling strategy. The underlying sockets
+ * will be checked in an active loop and woke up when an socket needed to be processed.
+ * This class handle the logic behind binding, accepting and disposing the server sockets.
+ * The {@link AbstractIoAcceptor} {@link Executor} will be used for running client accepting 
+ * class and an {@link AbstractPollingIoProcessor} will be used for processing client I/O operations
+ * like reading, writing and closing.
+ * 
+ * All the low level methods for binding, accepting, closing need to be provided by the subclassing 
+ * implementation.
+ * 
+ * @see NioSocketAcceptor for a example of implementation
  * 
  * @author The Apache MINA Project (dev@mina.apache.org)
  * @version $Rev$, $Date$
@@ -251,6 +263,9 @@
      */
     protected abstract void close(H handle) throws Exception;
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     protected IoFuture dispose0() throws Exception {
         unbind();
@@ -261,6 +276,9 @@
         return disposalFuture;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     protected final Set<SocketAddress> bind0(
             List<? extends SocketAddress> localAddresses) throws Exception {
@@ -315,6 +333,9 @@
         }
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     protected final void unbind0(List<? extends SocketAddress> localAddresses)
             throws Exception {
@@ -511,6 +532,9 @@
         return cancelledHandles;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public final IoSession newSession(SocketAddress remoteAddress,
             SocketAddress localAddress) {
         throw new UnsupportedOperationException();