svn commit: r593390 - in /mina/trunk/core/src/main/java/org/apache/mina/filter/executor: AbstractExecutorFilter.java ExecutorFilter.java UnorderedExecutorFilter.java

[tr...@apache.org]

Author: trustin
Date: Thu Nov  8 18:06:27 2007
New Revision: 593390

URL: http://svn.apache.org/viewvc?rev=593390&view=rev
Log:
Merged AbstractExecutorFilter and UnorderedExecutorFilter into ExecutorFilter

Added:
    mina/trunk/core/src/main/java/org/apache/mina/filter/executor/ExecutorFilter.java
      - copied, changed from r593381, mina/trunk/core/src/main/java/org/apache/mina/filter/executor/AbstractExecutorFilter.java
Removed:
    mina/trunk/core/src/main/java/org/apache/mina/filter/executor/AbstractExecutorFilter.java
    mina/trunk/core/src/main/java/org/apache/mina/filter/executor/UnorderedExecutorFilter.java

Copied: mina/trunk/core/src/main/java/org/apache/mina/filter/executor/ExecutorFilter.java (from r593381, mina/trunk/core/src/main/java/org/apache/mina/filter/executor/AbstractExecutorFilter.java)
URL: http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/filter/executor/ExecutorFilter.java?p2=mina/trunk/core/src/main/java/org/apache/mina/filter/executor/ExecutorFilter.java&p1=mina/trunk/core/src/main/java/org/apache/mina/filter/executor/AbstractExecutorFilter.java&r1=593381&r2=593390&rev=593390&view=diff
==============================================================================
--- mina/trunk/core/src/main/java/org/apache/mina/filter/executor/AbstractExecutorFilter.java (original)
+++ mina/trunk/core/src/main/java/org/apache/mina/filter/executor/ExecutorFilter.java Thu Nov  8 18:06:27 2007
@@ -37,13 +37,32 @@
 import org.apache.mina.common.WriteRequest;
 
 /**
- * A base abstract class for generic filters that forward I/O events to
- * {@link Executor} to enforce a certain thread model.
+ * A filter that forwards I/O events to {@link Executor} to enforce a certain
+ * thread model while allowing the events per session to be processed
+ * simultaneously. You can apply various thread model by inserting this filter
+ * to a {@link IoFilterChain}.
+ * <p>
+ * Please note that this filter doesn't manage the life cycle of the underlying
+ * {@link Executor}.  You have to destroy or stop it by yourself.
+ * <p>
+ * This filter does not maintain the order of events per session and thus
+ * more than one event handler methods can be invoked at the same time with
+ * mixed order.  For example, let's assume that messageReceived, messageSent,
+ * and sessionClosed events are fired.
+ * <ul>
+ * <li>All event handler methods can be called simultaneously.
+ *     (e.g. messageReceived and messageSent can be invoked at the same time.)</li>
+ * <li>The event order can be mixed up.
+ *     (e.g. sessionClosed or messageSent can be invoked before messageReceived
+ *           is invoked.)</li>
+ * </ul>
+ * If you need to maintain the order of events per session, please use
+ * {@link OrderedThreadPoolExecutor} as its underlying {@link Executor}.
  *
  * @author The Apache MINA Project (dev@mina.apache.org)
  * @version $Rev$, $Date$
  */
-public abstract class AbstractExecutorFilter extends IoFilterAdapter {
+public class ExecutorFilter extends IoFilterAdapter {
 
     static final ThreadLocal<IoSession> currentSession = new ThreadLocal<IoSession>();
     
@@ -54,7 +73,7 @@
      * Creates a new instance with the default thread pool implementation
      * (<tt>new ThreadPoolExecutor(0, 16, 60, TimeUnit.SECONDS, new SynchronousQueue())</tt>).
      */
-    protected AbstractExecutorFilter(IoEventType... eventTypes) {
+    protected ExecutorFilter(IoEventType... eventTypes) {
         this(new ThreadPoolExecutor(
                 0, 16, 60, TimeUnit.SECONDS,
                 new SynchronousQueue<Runnable>()), eventTypes);
@@ -63,7 +82,7 @@
     /**
      * Creates a new instance with the specified <tt>executor</tt>.
      */
-    protected AbstractExecutorFilter(Executor executor,
+    protected ExecutorFilter(Executor executor,
             IoEventType... eventTypes) {
         if (executor == null) {
             throw new NullPointerException("executor");
@@ -97,7 +116,9 @@
         return executor;
     }
 
-    protected abstract void fireEvent(IoFilterEvent event);
+    private void fireEvent(IoFilterEvent event) {
+        getExecutor().execute(event);
+    }
 
     @Override
     public void onPreAdd(IoFilterChain parent, String name,