org.glassfish.grizzly.comet

Class DefaultCometHandler<E>

java.lang.Object

org.glassfish.grizzly.comet.DefaultCometHandler<E>

All Implemented Interfaces:

CometHandler<E>

public class DefaultCometHandler<E>
extends Object
implements CometHandler<E>

A basic default implementation of CometHandler to take care of tracking the Response and CometContext.

Constructor Summary

Constructors

Constructor and Description
DefaultCometHandler()
DefaultCometHandler(CometContext<E> cometContext, Response response)

Method Summary

Modifier and Type	Method and Description
CometContext<E>	getCometContext()
Response	getResponse()
void	onEvent(CometEvent event) Receive CometEvent notification.
void	onInitialize(CometEvent event) Receive CometEvent notification when Grizzly is about to suspend the connection.
void	onInterrupt(CometEvent event) Receive CometEvent notification when the underlying tcp communication is resumed by Grizzly.
void	onTerminate(CometEvent event) Receive CometEvent notification when the response is resumed by a CometHandler or by the CometContext
void	setCometContext(CometContext<E> cometContext)
void	setResponse(Response response)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultCometHandler

public DefaultCometHandler()

DefaultCometHandler

public DefaultCometHandler(CometContext<E> cometContext,
                           Response response)

Method Detail

getResponse

public Response getResponse()

Specified by:

getResponse in interface CometHandler<E>

Returns:

the response associated with the handler.

setResponse

public void setResponse(Response response)

Specified by:

setResponse in interface CometHandler<E>

getCometContext

public CometContext<E> getCometContext()

Specified by:

getCometContext in interface CometHandler<E>

setCometContext

public void setCometContext(CometContext<E> cometContext)

Specified by:

setCometContext in interface CometHandler<E>

onEvent

public void onEvent(CometEvent event)
             throws IOException

Description copied from interface: CometHandler

Receive CometEvent notification. This method will be invoked every time a CometContext.notify(E) is invoked. The CometEvent will contains the message that can be pushed back to the remote client, cached or ignored. This method can also be used to resume a connection once a notified by invoking CometContext.resumeCometHandler(org.glassfish.grizzly.comet.CometHandler).
its not optimal to flush outputstream in this method for long polling, flush is performed in each CometContext.resume call.
flushing multiple times can fragment the data into several tcp packets, that leads to extra IO and overhead in general due to client ack for each packet etc.

Specified by:

onEvent in interface CometHandler<E>

Throws:

IOException

onInitialize

public void onInitialize(CometEvent event)
                  throws IOException

Description copied from interface: CometHandler

Receive CometEvent notification when Grizzly is about to suspend the connection. This method is always invoked during the processing of CometContext.addCometHandler(org.glassfish.grizzly.comet.CometHandler<E>) operations.

Specified by:

onInitialize in interface CometHandler<E>

Throws:

IOException

onTerminate

public void onTerminate(CometEvent event)
                 throws IOException

Description copied from interface: CometHandler

Receive CometEvent notification when the response is resumed by a CometHandler or by the CometContext

Specified by:

onTerminate in interface CometHandler<E>

Throws:

IOException

onInterrupt

public void onInterrupt(CometEvent event)
                 throws IOException

Description copied from interface: CometHandler

Receive CometEvent notification when the underlying tcp communication is resumed by Grizzly. This happens when the CometContext.setExpirationDelay(long) expires or when the remote client close the connection.

Specified by:

onInterrupt in interface CometHandler<E>

Throws:

IOException