svn commit: r706712 - in /httpcomponents/httpcore/trunk/module-nio/src/main/java/org/apache/http/nio/entity: ConsumingNHttpEntity.java ProducingNHttpEntity.java

[ol...@apache.org]

Author: olegk
Date: Tue Oct 21 11:38:50 2008
New Revision: 706712

URL: http://svn.apache.org/viewvc?rev=706712&view=rev
Log:
Javadoc improvements

Modified:
    httpcomponents/httpcore/trunk/module-nio/src/main/java/org/apache/http/nio/entity/ConsumingNHttpEntity.java
    httpcomponents/httpcore/trunk/module-nio/src/main/java/org/apache/http/nio/entity/ProducingNHttpEntity.java

Modified: httpcomponents/httpcore/trunk/module-nio/src/main/java/org/apache/http/nio/entity/ConsumingNHttpEntity.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-nio/src/main/java/org/apache/http/nio/entity/ConsumingNHttpEntity.java?rev=706712&r1=706711&r2=706712&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-nio/src/main/java/org/apache/http/nio/entity/ConsumingNHttpEntity.java (original)
+++ httpcomponents/httpcore/trunk/module-nio/src/main/java/org/apache/http/nio/entity/ConsumingNHttpEntity.java Tue Oct 21 11:38:50 2008
@@ -38,7 +38,8 @@
 import org.apache.http.nio.IOControl;
 
 /**
- * A non-blocking entity that allows content to be consumed from a decoder.
+ * A non-blocking {@link HttpEntity} that allows content to be consumed from a 
+ * {@link ContentDecoder}.
  *
  * @author <a href="mailto:sberlin at gmail.com">Sam Berlin</a>
  */
@@ -46,6 +47,9 @@
 
     /**
      * Notification that content is available to be read from the decoder.
+     * {@link IOControl} instance passed as a parameter to the method can be 
+     * used to suspend input events if the entity is temporarily unable to 
+     * allocate more storage to accommodate all incoming content. 
      */
     void consumeContent(ContentDecoder decoder, IOControl ioctrl) throws IOException;
 

Modified: httpcomponents/httpcore/trunk/module-nio/src/main/java/org/apache/http/nio/entity/ProducingNHttpEntity.java
URL: http://svn.apache.org/viewvc/httpcomponents/httpcore/trunk/module-nio/src/main/java/org/apache/http/nio/entity/ProducingNHttpEntity.java?rev=706712&r1=706711&r2=706712&view=diff
==============================================================================
--- httpcomponents/httpcore/trunk/module-nio/src/main/java/org/apache/http/nio/entity/ProducingNHttpEntity.java (original)
+++ httpcomponents/httpcore/trunk/module-nio/src/main/java/org/apache/http/nio/entity/ProducingNHttpEntity.java Tue Oct 21 11:38:50 2008
@@ -45,7 +45,11 @@
 public interface ProducingNHttpEntity extends HttpEntity {
 
     /**
-     * Notification that content should be written to the encoder.
+     * Notification that content should be written to the encoder. 
+     * {@link IOControl} instance passed as a parameter to the method can be 
+     * used to suspend output events if the entity is temporarily unable to 
+     * produce more content.
+     * <b/>
      * When all content is finished, this <b>MUST</b> call {@link ContentEncoder#complete()}.
      * Failure to do so could result in the entity never being written.
      */