- Small javadoc update.

git-svn-id: https://svn.apache.org/repos/asf/tomcat/tc6.0.x/trunk@535324 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/java/org/apache/catalina/CometEvent.java b/java/org/apache/catalina/CometEvent.java
index 0996698..acaff98 100644 (file)
--- a/java/org/apache/catalina/CometEvent.java
+++ b/java/org/apache/catalina/CometEvent.java
@@ -47,10 +47,10 @@ public interface CometEvent {
      * READ - This indicates that input data is available, and that one read can be made
      *  without blocking. The available and ready methods of the InputStream or
      *  Reader may be used to determine if there is a risk of blocking: the servlet
-     *  should read while data is reported available, and can make one additional read
-     *  without blocking. When encountering a read error, the servlet should
-     *  report it by propagating the exception properly. Throwing an exception will 
-     *  cause the error event to be invoked, and the connection will be closed. 
+     *  should read while data is reported available. When encountering a read error, 
+     *  the servlet should report it by propagating the exception properly. Throwing 
+     *  an exception will cause the error event to be invoked, and the connection 
+     *  will be closed. 
      *  Alternately, it is also possible to catch any exception, perform clean up
      *  on any data structure the servlet may be using, and using the close method
      *  of the event. It is not allowed to attempt reading data from the request 
@@ -58,7 +58,9 @@ public interface CometEvent {
      * END - End may be called to end the processing of the request. Fields that have
      *  been initialized in the begin method should be reset. After this event has
      *  been processed, the request and response objects, as well as all their dependent
-     *  objects will be recycled and used to process other requests.
+     *  objects will be recycled and used to process other requests. End will also be 
+     *  called when data is available and the end of file is reached on the request input
+     *  (this usually indicates the client has pipelined a request).
      * ERROR - Error will be called by the container in the case where an IO exception
      *  or a similar unrecoverable error occurs on the connection. Fields that have
      *  been initialized in the begin method should be reset. After this event has