|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sun.grizzly.comet.CometEngine
com.sun.enterprise.web.connector.grizzly.comet.CometEngine
CometEngine
public class CometEngine
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 cometContext path on which Comet support will be applied:
CometEngine cometEngine = CometEngine.getEngine()
CometContext cometContext = cometEngine.register(contextPath)
(2) Second, add an instance of CometHandler
to the
CometContext
returned by the register method:
cometContext.addCometHandler(handler);
(3) Finally, you can invokeCometHandler other CometHandler
by doing:
cometContext.invokeCometHandler(Object)(handler);
You can also select the stage where the request polling happens when
registering the cometContext path (see register(String,int);
Field Summary | |
---|---|
protected static CometEngine |
cometEngine
Deprecated. |
Fields inherited from class com.sun.grizzly.comet.CometEngine |
---|
activeContexts, AFTER_RESPONSE_PROCESSING, AFTER_SERVLET_PROCESSING, BEFORE_REQUEST_PROCESSING, cometContextCache, DISABLE_CLIENT_DISCONNECTION_DETECTION, DISABLE_SUSPEND_TIMEOUT, logger, threadPool, updatedContexts |
Constructor Summary | |
---|---|
CometEngine()
Deprecated. |
Method Summary | |
---|---|
protected void |
flushPostExecute(CometTask task,
boolean finishExecution)
Deprecated. Ensures ProcessorTask is recycled and that SelectionKey is canceled when needed. |
CometContext |
getCometContext(String contextPath)
Deprecated. Return the CometContext associated with the topic. |
static CometEngine |
getEngine()
Deprecated. |
protected boolean |
interrupt(CometTask task,
boolean finishExecution)
Deprecated. Interrupt a CometHandler by invoking CometHandler.onInterrupt(com.sun.grizzly.comet.CometEvent) |
protected boolean |
interrupt(CometTask task,
boolean finishExecution)
Deprecated. Interrupt a CometHandler by invoking CometHandler.onInterrupt(com.sun.enterprise.web.connector.grizzly.comet.CometEvent) |
protected void |
interrupt0(CometTask task,
boolean finishExecution)
Deprecated. 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. |
CometContext |
register(String contextPath)
Deprecated. Register a context path with this CometEngine . |
CometContext |
register(String topic,
int type)
Deprecated. Register a context path with this CometEngine . |
Methods inherited from class com.sun.grizzly.comet.CometEngine |
---|
getThreadPool, handle, isCometEnabled, logger, register, setThreadPool, unregister |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static final CometEngine cometEngine
Constructor Detail |
---|
public CometEngine()
Method Detail |
---|
public static CometEngine getEngine()
public CometContext register(String contextPath)
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.
register
in class CometEngine
contextPath
- the context path used to create the
CometContext
CometContext
.public CometContext register(String topic, int type)
CometEngine
. The
CometContext
returned will be of type
type
.
register
in class CometEngine
topic
- the context path used to create the
CometContext
type
- when the request will be suspended, e.g. CometEngine.BEFORE_REQUEST_PROCESSING
,
CometEngine.AFTER_SERVLET_PROCESSING
or CometEngine.AFTER_RESPONSE_PROCESSING
CometContext
.public CometContext getCometContext(String contextPath)
CometContext
associated with the topic.
getCometContext
in class CometEngine
contextPath
- the topic used to creates the CometContext
protected boolean interrupt(CometTask task, boolean finishExecution)
CometEngine
CometHandler
by invoking CometHandler.onInterrupt(com.sun.grizzly.comet.CometEvent)
interrupt
in class CometEngine
task
- The CometTask
encapsulating the suspended connection.finishExecution
- Finish the current execution.protected void flushPostExecute(CometTask task, boolean finishExecution)
CometEngine
ProcessorTask
is recycled and that SelectionKey
is canceled when needed.
flushPostExecute
in class CometEngine
task
- aptflush
- cancelkey
- protected boolean interrupt(CometTask task, boolean finishExecution)
CometHandler
by invoking CometHandler.onInterrupt(com.sun.enterprise.web.connector.grizzly.comet.CometEvent)
protected void interrupt0(CometTask task, boolean finishExecution)
interrupt0
in class CometEngine
task
- The CometTask
encapsulating the suspended connection.finishExecution
- Finish the current execution.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |