svn commit: r383792 - /directory/trunks/mina/core/src/main/java/org/apache/mina/filter/ThreadPoolFilter.java

[ni...@apache.org]

Author: niklas
Date: Mon Mar  6 21:41:10 2006
New Revision: 383792

URL: http://svn.apache.org/viewcvs?rev=383792&view=rev
Log:
Added Javadoc for the start/stop methods.

Modified:
    directory/trunks/mina/core/src/main/java/org/apache/mina/filter/ThreadPoolFilter.java

Modified: directory/trunks/mina/core/src/main/java/org/apache/mina/filter/ThreadPoolFilter.java
URL: http://svn.apache.org/viewcvs/directory/trunks/mina/core/src/main/java/org/apache/mina/filter/ThreadPoolFilter.java?rev=383792&r1=383791&r2=383792&view=diff
==============================================================================
--- directory/trunks/mina/core/src/main/java/org/apache/mina/filter/ThreadPoolFilter.java (original)
+++ directory/trunks/mina/core/src/main/java/org/apache/mina/filter/ThreadPoolFilter.java Mon Mar  6 21:41:10 2006
@@ -44,6 +44,15 @@
  * This is an implementation of
  * <a href="http://deuce.doc.wustl.edu/doc/pspdfs/lf.pdf">Leader/Followers
  * thread pool</a> by Douglas C. Schmidt et al.
+ * </p>
+ * <p>
+ * Use the {@link #start()} and {@link #stop()} methods to force this filter
+ * to start/stop processing events. Alternatively, {@link #start()} will be
+ * called automatically the first time an instance of this filter is added
+ * to a filter chain. Calling {@link #stop()} is not required either since
+ * all workers are daemon threads which means that any workers still alive
+ * when the JVM terminates will die automatically.
+ * </p>
  * 
  * @author The Apache Directory Project (dev@directory.apache.org)
  * @version $Rev$, $Date$
@@ -180,6 +189,10 @@
         }
     }
 
+    /**
+     * Starts handling new events. This will be called automatically if not
+     * already called the first time this filter is added to a filter chain. 
+     */
     public void start()
     {
         shuttingDown = false;
@@ -188,6 +201,9 @@
         leader.lead();
     }
 
+    /**
+     * Stops handling events and terminates all active worker threads.
+     */
     public void stop()
     {
         shuttingDown = true;