svn commit: r1152596 - /mina/branches/3.0/core/src/main/java/org/apache/mina/util/AbstractIoFuture.java

[ad...@apache.org]

Author: adc
Date: Sun Jul 31 17:10:56 2011
New Revision: 1152596

URL: http://svn.apache.org/viewvc?rev=1152596&view=rev
Log:
Nice documentation.

Modified:
    mina/branches/3.0/core/src/main/java/org/apache/mina/util/AbstractIoFuture.java

Modified: mina/branches/3.0/core/src/main/java/org/apache/mina/util/AbstractIoFuture.java
URL: http://svn.apache.org/viewvc/mina/branches/3.0/core/src/main/java/org/apache/mina/util/AbstractIoFuture.java?rev=1152596&r1=1152595&r2=1152596&view=diff
==============================================================================
--- mina/branches/3.0/core/src/main/java/org/apache/mina/util/AbstractIoFuture.java (original)
+++ mina/branches/3.0/core/src/main/java/org/apache/mina/util/AbstractIoFuture.java Sun Jul 31 17:10:56 2011
@@ -35,6 +35,17 @@ import org.apache.mina.api.IoFutureListe
 
 
 /**
+ * An abstract implementation of {@link IoFuture}.  Owners of this future
+ * should implement {@link #cancelOwner(boolean)} to receive notifications of
+ * when the future should be canceled.
+ * <p/>
+ * Concrete implementations of this abstract class should consider overriding
+ * the two methods {@link #scheduleResult(org.apache.mina.api.IoFutureListener, Object)}
+ * and {@link #scheduleException(org.apache.mina.api.IoFutureListener, Throwable)}
+ * so that listeners are called in a separate thread.  The default
+ * implementations may end up calling the listener in the same thread that is
+ * registering the listener, before the registration has completed.
+ *
  * @author <a href="http://mina.apache.org">Apache MINA Project</a>
  */
 public abstract class AbstractIoFuture<V> implements IoFuture<V> {