svn commit: r668578 - /mina/trunk/core/src/main/java/org/apache/mina/common/AbstractIoService.java

[jv...@apache.org]

Author: jvermillard
Date: Tue Jun 17 02:06:38 2008
New Revision: 668578

URL: http://svn.apache.org/viewvc?rev=668578&view=rev
Log:
javadoc on the IoService "mother of all" constructor

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

Modified: mina/trunk/core/src/main/java/org/apache/mina/common/AbstractIoService.java
URL: http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/common/AbstractIoService.java?rev=668578&r1=668577&r2=668578&view=diff
==============================================================================
--- mina/trunk/core/src/main/java/org/apache/mina/common/AbstractIoService.java (original)
+++ mina/trunk/core/src/main/java/org/apache/mina/common/AbstractIoService.java Tue Jun 17 02:06:38 2008
@@ -142,6 +142,18 @@
      */
     private final IoSessionConfig sessionConfig;
 
+    /**
+	 * Constructor for {@link AbstractIoService}. You need to provide a default
+	 * session configuration and an {@link Executor} for handling I/O events. If
+	 * null {@link Executor} is provided, a default one will be created using
+	 * {@link Executors#newCachedThreadPool()}.
+	 * 
+	 * @param sessionConfig
+	 *            the default configuration for the managed {@link IoSession}
+	 * @param executor
+	 *            the {@link Executor} used for handling execution of I/O
+	 *            events. Can be <code>null</code>.
+	 */
     protected AbstractIoService(IoSessionConfig sessionConfig, Executor executor) {
         if (sessionConfig == null) {
             throw new NullPointerException("sessionConfig");