| 
 | Apache Tomcat 6.0.53 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface CometEvent
The CometEvent interface.
| Nested Class Summary | |
|---|---|
| static class | CometEvent.EventSubTypeEvent details. | 
| static class | CometEvent.EventTypeEnumeration describing the major events that the container can invoke the CometProcessors event() method with. | 
| Method Summary | |
|---|---|
|  void | close()Ends the Comet session. | 
|  CometEvent.EventSubType | getEventSubType()Returns the sub type of this event. | 
|  CometEvent.EventType | getEventType()Returns the event type. | 
|  javax.servlet.http.HttpServletRequest | getHttpServletRequest()Returns the HttpServletRequest. | 
|  javax.servlet.http.HttpServletResponse | getHttpServletResponse()Returns the HttpServletResponse. | 
|  void | setTimeout(int timeout)Sets the timeout for this Comet connection. | 
| Method Detail | 
|---|
javax.servlet.http.HttpServletRequest getHttpServletRequest()
javax.servlet.http.HttpServletResponse getHttpServletResponse()
CometEvent.EventType getEventType()
CometEvent.EventSubType getEventSubType()
void close()
           throws java.io.IOException
java.io.IOException - if an IO exception occurs
void setTimeout(int timeout)
                throws java.io.IOException,
                       javax.servlet.ServletException,
                       java.lang.UnsupportedOperationException
response.flushBuffer(). If a timeout occurs, the 
 error(HttpServletRequest, HttpServletResponse) method is invoked. The 
 web application SHOULD NOT attempt to reuse the request and response objects after a timeout
 as the error(HttpServletRequest, HttpServletResponse) method indicates.
timeout - The timeout in milliseconds for this connection, must be a positive value, larger than 0
java.io.IOException - An IOException may be thrown to indicate an IO error, 
         or that the EOF has been reached on the connection
javax.servlet.ServletException - An exception has occurred, as specified by the root
         cause
java.lang.UnsupportedOperationException - if per connection timeout is not supported, either at all or at this phase
         of the invocation.| 
 | Apache Tomcat 6.0.53 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||