Author: remm
Date: Tue Jun 12 02:02:17 2007
New Revision: 546427
URL: http://svn.apache.org/viewvc?view=rev&rev=546427
Log:
- Update javadocs.
Modified:
tomcat/sandbox/comet/java/org/apache/catalina/CometEvent.java
Modified: tomcat/sandbox/comet/java/org/apache/catalina/CometEvent.java
URL:
http://svn.apache.org/viewvc/tomcat/sandbox/comet/java/org/apache/catalina/CometEvent.java?view=diff&rev=546427&r1=546426&r2=546427
==============================================================================
--- tomcat/sandbox/comet/java/org/apache/catalina/CometEvent.java (original)
+++ tomcat/sandbox/comet/java/org/apache/catalina/CometEvent.java Tue Jun 12
02:02:17 2007
@@ -131,15 +131,10 @@
public void close() throws IOException;
/**
- * Sets the timeout for this Comet connection. Please NOTE, that the
implementation
- * of a per connection timeout is OPTIONAL and MAY NOT be implemented.<br/>
* This method sets the timeout in milliseconds of idle time on the
connection.
* The timeout is reset every time data is received from the connection or
data is flushed
* using <code>response.flushBuffer()</code>. If a timeout occurs, the
- * <code>error(HttpServletRequest, HttpServletResponse)</code> method is
invoked. The
- * web application SHOULD NOT attempt to reuse the request and response
objects after a timeout
- * as the <code>error(HttpServletRequest, HttpServletResponse)</code>
method indicates.<br/>
- * This method should not be called asynchronously, as that will have no
effect.
+ * servlet will receive an ERROR/TIMEOUT event.
*
* @param timeout The timeout in milliseconds for this connection, must be
a positive value, larger than 0
*/
@@ -152,7 +147,11 @@
* an attempt to flush additional data to the client and data still cannot
be written immediately,
* an IOException will be thrown. If calling this method returns false, it
will also
* request notification when the connection becomes available for writing
again, and the
- * servlet will recieve a write event.
+ * servlet will recieve a write event.<br/>
+ *
+ * Note: If the servlet is not using isWriteable, and is writing its
output inside the
+ * container threads, it is not needed to call this method. Any incomplete
writes will be
+ * performed again in blocking mode.
*
* @return boolean true if you can write to the response
*/
@@ -175,7 +174,7 @@
public void callback();
/**
- * Delay processing of the connection until the configured timeout occurs,
or callback(true) is called.
+ * Delay processing of the connection until the configured timeout occurs,
or callback() is called.
*/
public void sleep();
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
