CometEngine (grizzly-all 2.3.36-MULE-021 API)

java.lang.Object
- org.glassfish.grizzly.comet.CometEngine

```
public class CometEngine
extends Object
```
Main class allowing Comet support on top of Grizzly Asynchronous Request Processing mechanism. This class is the entry point to any component interested to execute Comet request style. Components can be Servlets, JSP, JSF or pure Java class. A component interested to support Comet request must do:
```
 (1) First, register the topic on which Comet support will be applied:
     CometEngine cometEngine = CometEngine.getEngine()
     CometContext cometContext = cometEngine.register(topic)
 (2) Second, add an instance of CometHandler to the
     CometContext returned by the register method:
     CometContext.addCometHandler(org.glassfish.grizzly.comet.CometHandler<E>). Executing this operation
     will tells Grizzly to suspend the response.
 (3) Finally, you can CometContext.notify(E) other CometHandler
     to share information between CometHandler. When notified,
     CometHandler can decides to push back the data, resume the
     response, or simply ignore the content of the notification.
 
```
You can also select the stage where the suspension of the response happens when registering the CometContext's topic (see register(java.lang.String, int)), which can be before, during or after invoking a Servlet There is known limitation related to HTTP pipelining, it can't work properly when CometContext.isDetectClosedConnections() is enabled. So if you want to support HTTP pipelining, the closed connection detection mechanism should be disabled via CometContext.setDetectClosedConnections(boolean).
Author:

Jeanfrancois Arcand, Gustav Trede

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map<String,CometContext>`	`activeContexts` The current active `CometContext` keyed by context path.
`static int`	`AFTER_RESPONSE_PROCESSING` Deprecated.
`static int`	`AFTER_SERVLET_PROCESSING` Deprecated.
`static int`	`BEFORE_REQUEST_PROCESSING` Deprecated.
`static int`	`DISABLE_CLIENT_DISCONNECTION_DETECTION` Deprecated.
`static int`	`DISABLE_SUSPEND_TIMEOUT` Deprecated.
`protected static Logger`	`logger` Main logger
`protected ExecutorService`	`threadPool` The `ExecutorService` used to execute

Constructor Summary

Constructors
Modifier Constructor and Description

protected CometEngine()
Create a singleton and initialize all lists required.

Constructors
Modifier	Constructor and Description
`protected`	`CometEngine()` Create a singleton and initialize all lists required.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`CometContext`	`deregister(String topic)` Deregister the `CometHandler` to the list of the `CometContext`.
`<E> CometContext<E>`	`getCometContext(String topic)` Return the `CometContext` associated with the topic.
`static CometEngine`	`getEngine()` Return a singleton of this Class.
`protected boolean`	`interrupt(CometHandler handler, boolean finishExecution)` Deprecated. use the CometContext version
`protected void`	`interrupt0(CometHandler handler, boolean finishExecution)` Deprecated. use the CometContext version
`protected boolean`	`isCometEnabled()` Return true if comet is enabled.
`static Logger`	`logger()` Return the current logger.
`<E> CometContext<E>`	`register(String topic)` Register a context path with this `CometEngine`.
`<E> CometContext<E>`	`register(String topic, Class<? extends NotificationHandler> notificationClass)` Instantiate a new `CometContext`.
`<E> CometContext<E>`	`register(String topic, int type)` Deprecated. Use `register(String)` instead
`void`	`setCometSupported(boolean supported)`
`CometContext`	`unregister(String topic)` Deprecated.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DISABLE_SUSPEND_TIMEOUT
```
@Deprecated
public static final int DISABLE_SUSPEND_TIMEOUT
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - DISABLE_CLIENT_DISCONNECTION_DETECTION
```
@Deprecated
public static final int DISABLE_CLIENT_DISCONNECTION_DETECTION
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - BEFORE_REQUEST_PROCESSING
```
@Deprecated
public static final int BEFORE_REQUEST_PROCESSING
```
    Deprecated.
    
    The token used to support BEFORE_REQUEST_PROCESSING polling.
    
    See Also:
    
    Constant Field Values
  - AFTER_SERVLET_PROCESSING
```
@Deprecated
public static final int AFTER_SERVLET_PROCESSING
```
    Deprecated.
    
    The token used to support AFTER_SERVLET_PROCESSING polling.
    
    See Also:
    
    Constant Field Values
  - AFTER_RESPONSE_PROCESSING
```
@Deprecated
public static final int AFTER_RESPONSE_PROCESSING
```
    Deprecated.
    
    The token used to support BEFORE_RESPONSE_PROCESSING polling.
    
    See Also:
    
    Constant Field Values
  - logger
```
protected static final Logger logger
```
    Main logger
  - threadPool
```
protected ExecutorService threadPool
```
    The ExecutorService used to execute
  - activeContexts
```
protected final Map<String,CometContext> activeContexts
```
    The current active CometContext keyed by context path.
- Constructor Detail
  - CometEngine
```
protected CometEngine()
```
    Create a singleton and initialize all lists required.
- Method Detail
  - isCometEnabled
```
protected boolean isCometEnabled()
```
    Return true if comet is enabled.
  - setCometSupported
```
public void setCometSupported(boolean supported)
```
  - getEngine
```
public static CometEngine getEngine()
```
    Return a singleton of this Class.
    
    Returns:
    
    CometEngine the singleton.
  - unregister
```
@Deprecated
public CometContext unregister(String topic)
```
    Deprecated.
    
    Calls through to deregister(String).
  - deregister
```
public CometContext deregister(String topic)
```
    Deregister the CometHandler to the list of the CometContext. Invoking this method will invoke all CometHandler.onTerminate(CometEvent) before removing the associated CometContext. Invoking that method will also resume the underlying connection associated with the CometHandler, similar to what CometContext.resumeCometHandler(CometHandler) do.
  - register
```
public <E> CometContext<E> register(String topic,
                                    int type)
```
    Deprecated. Use register(String) instead
    
    Register a context path with this CometEngine. The CometContext returned will be of type type.
    
    Parameters:
    
    topic - the context path used to create the CometContext
    
    type - when the request will be suspended
    
    Returns:
    
    CometContext a configured CometContext.
  - register
```
public <E> CometContext<E> register(String topic)
```
    Register a context path with this CometEngine. The CometContext returned will be of type AFTER_SERVLET_PROCESSING, which means the request target (most probably a Servlet) will be executed first and then polled.
    
    Parameters:
    
    topic - the context path used to create the CometContext
    
    Returns:
    
    CometContext a configured CometContext.
  - register
```
public <E> CometContext<E> register(String topic,
                                    Class<? extends NotificationHandler> notificationClass)
```
    Instantiate a new CometContext.
    
    Parameters:
    
    topic - the topic the new CometContext will represent.
    
    Returns:
    
    a new CometContext if not already created, or the existing one.
  - getCometContext
```
public <E> CometContext<E> getCometContext(String topic)
```
    Return the CometContext associated with the topic.
    
    Parameters:
    
    topic - the topic used to creates the CometContext
  - interrupt
```
protected boolean interrupt(CometHandler handler,
                            boolean finishExecution)
                     throws IOException
```
    Deprecated. use the CometContext version
    
    Interrupt a CometHandler by invoking CometHandler.onInterrupt(org.glassfish.grizzly.comet.CometEvent)
    
    Parameters:
    
    handler - The CometHandler encapsulating the suspended connection.
    
    finishExecution - Finish the current execution.
    
    Throws:
    
    IOException
    
    See Also:
    
    CometContext.interrupt(CometHandler, boolean)
  - interrupt0
```
protected void interrupt0(CometHandler handler,
                          boolean finishExecution)
                   throws IOException
```
    Deprecated. use the CometContext version
    
    Interrupt logic in its own method, so it can be executed either async or sync.
    cometHandler.onInterrupt is performed async due to its functionality is unknown, hence not safe to run in the performance critical selector thread.
    
    Parameters:
    
    handler - The CometHandler encapsulating the suspended connection.
    
    finishExecution - Finish the current execution.
    
    Throws:
    
    IOException
    
    See Also:
    
    CometContext.interrupt0(CometHandler, boolean)
  - logger
```
public static Logger logger()
```
    Return the current logger.

Class CometEngine

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DISABLE_SUSPEND_TIMEOUT

DISABLE_CLIENT_DISCONNECTION_DETECTION

BEFORE_REQUEST_PROCESSING

AFTER_SERVLET_PROCESSING

AFTER_RESPONSE_PROCESSING

logger

threadPool

activeContexts

Constructor Detail

CometEngine

Method Detail

isCometEnabled

setCometSupported

getEngine

unregister

deregister

register

register

register

getCometContext

interrupt

interrupt0

logger