svn commit: r593026 - /mina/trunk/core/src/main/java/org/apache/mina/common/SimpleIoProcessorPool.java

[tr...@apache.org]

Author: trustin
Date: Wed Nov  7 22:01:45 2007
New Revision: 593026

URL: http://svn.apache.org/viewvc?rev=593026&view=rev
Log:
Added example code to SimpleIoProcessorPool JavaDoc

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

Modified: mina/trunk/core/src/main/java/org/apache/mina/common/SimpleIoProcessorPool.java
URL: http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/common/SimpleIoProcessorPool.java?rev=593026&r1=593025&r2=593026&view=diff
==============================================================================
--- mina/trunk/core/src/main/java/org/apache/mina/common/SimpleIoProcessorPool.java (original)
+++ mina/trunk/core/src/main/java/org/apache/mina/common/SimpleIoProcessorPool.java Wed Nov  7 22:01:45 2007
@@ -46,6 +46,22 @@
  * <li>A public constructor with one {@link Executor} parameter.</li>
  * <li>A public default constructor</li>
  * </ol>
+ * The following is an example for the NIO socket transport:
+ * <pre><code>
+ * // Create a shared pool.
+ * SimpleIoProcessorPool pool = new SimpleIoProcessorPool(NioProcessor.class, 16);
+ * 
+ * // Create two services that share the same pool.
+ * SocketAcceptor acceptor = new NioSocketAcceptor(pool);
+ * SocketConnector connector = new NioSocketConnector(pool);
+ * 
+ * ...
+ * 
+ * // Release related resorcese.
+ * connector.dispose();
+ * acceptor.dispose();
+ * pool.dispose();
+ * </code></pre>
  * 
  * @author The Apache MINA Project (dev@mina.apache.org)
  * @version $Rev$, $Date$