svn commit: r591311 - /mina/trunk/core/src/main/java/org/apache/mina/filter/traffic/WriteThrottlePolicy.java

[tr...@apache.org]

Author: trustin
Date: Fri Nov  2 05:04:47 2007
New Revision: 591311

URL: http://svn.apache.org/viewvc?rev=591311&view=rev
Log:
Related issue: DIRMINA-302 (Unbounded nature of writeRequestQueue can cause OutOfMemoryException)
* More JavaDoc for WriteThrottlePolicy

Modified:
    mina/trunk/core/src/main/java/org/apache/mina/filter/traffic/WriteThrottlePolicy.java

Modified: mina/trunk/core/src/main/java/org/apache/mina/filter/traffic/WriteThrottlePolicy.java
URL: http://svn.apache.org/viewvc/mina/trunk/core/src/main/java/org/apache/mina/filter/traffic/WriteThrottlePolicy.java?rev=591311&r1=591310&r2=591311&view=diff
==============================================================================
--- mina/trunk/core/src/main/java/org/apache/mina/filter/traffic/WriteThrottlePolicy.java (original)
+++ mina/trunk/core/src/main/java/org/apache/mina/filter/traffic/WriteThrottlePolicy.java Fri Nov  2 05:04:47 2007
@@ -19,6 +19,8 @@
  */
 package org.apache.mina.filter.traffic;
 
+import org.apache.mina.common.WriteFuture;
+
 /**
  * Tells {@link WriteThrottleFilter} what to do when there are too many
  * scheduled write requests in the session buffer.
@@ -47,7 +49,12 @@
      */
     LOG_AND_BLOCK,
     /**
-     * Raise a {@link TooManyScheduledWritesException}.
+     * Raise a {@link TooManyScheduledWritesException}.  Please note that
+     * the exception is <strong>not</strong> thrown back directly to the
+     * caller.  Instead, the {@link WriteFuture#getException() exception}
+     * property of the returned {@link WriteFuture} will return the exception.
+     * The exception will also be notified as an <tt>exceptionCaught</tt>
+     * event.
      */
     EXCEPTION,
 }