org.atmosphere.cpr
Class AtmosphereResourceEventImpl

java.lang.Object
  org.atmosphere.cpr.AtmosphereResourceEventImpl

All Implemented Interfaces:

AtmosphereResourceEvent<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse>

public class AtmosphereResourceEventImpl
extends Object
implements AtmosphereResourceEvent<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse>

AtmosphereResourceEvent implementation for Servlet Container.

Author:

Jeanfrancois Arcand

Field Summary

protected Object	message
protected AtmosphereResourceImpl	resource

Constructor Summary

AtmosphereResourceEventImpl(AtmosphereResourceImpl resource)

AtmosphereResourceEventImpl(AtmosphereResourceImpl resource, boolean isCancelled, boolean isResumedOnTimeout)

AtmosphereResourceEventImpl(AtmosphereResourceImpl resource, boolean isCancelled, boolean isResumedOnTimeout, Throwable throwable)

Method Summary

void	destroy()
boolean	equals(Object o)
Object	getMessage() Return the object that were pass to Broadcaster.broadcast(java.lang.Object)
AtmosphereResource<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse>	getResource() Return the AtmosphereResource associated with this event
int	hashCode()
boolean	isCancelled() Return true when the remote client close the connection.
boolean	isResumedOnTimeout() Return true is the response gets resumed after a timeout.
boolean	isResuming() Return true if that AtmosphereResource.resume() has been invoked
boolean	isSuspended() Return true if that AtmosphereResource.suspend() has been invoked and set to true
protected void	setCancelled(boolean isCancelled)
protected void	setIsResumedOnTimeout(boolean isResumedOnTimeout)
void	setMessage(Object message) Set the message broadcasted using Broadcaster.broadcast(java.lang.Object)
void	setThrowable(Throwable t)
Throwable	throwable() Return a Throwable if an unexpected exception occured.
String	toString()
void	write(OutputStream os, Object o) Write the Object using the OutputStream by invoking the current Serializer.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

message

protected Object message

resource

protected AtmosphereResourceImpl resource

Constructor Detail

AtmosphereResourceEventImpl

public AtmosphereResourceEventImpl(AtmosphereResourceImpl resource)

AtmosphereResourceEventImpl

public AtmosphereResourceEventImpl(AtmosphereResourceImpl resource,
                                   boolean isCancelled,
                                   boolean isResumedOnTimeout)

AtmosphereResourceEventImpl

public AtmosphereResourceEventImpl(AtmosphereResourceImpl resource,
                                   boolean isCancelled,
                                   boolean isResumedOnTimeout,
                                   Throwable throwable)

Method Detail

isResuming

public boolean isResuming()

Return true if that AtmosphereResource.resume() has been invoked

Specified by:

isResuming in interface AtmosphereResourceEvent<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse>

Returns:

true if that AtmosphereResource.resume() has been invoked and set to true

isSuspended

public boolean isSuspended()

Return true if that AtmosphereResource.suspend() has been invoked and set to true

Specified by:

isSuspended in interface AtmosphereResourceEvent<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse>

Returns:

true if that AtmosphereResource.suspend() has been invoked and set to true

getMessage

public Object getMessage()

Return the object that were pass to Broadcaster.broadcast(java.lang.Object)

Specified by:

getMessage in interface AtmosphereResourceEvent<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse>

Returns:

the object that were pass to Broadcaster.broadcast(java.lang.Object)

setMessage

public void setMessage(Object message)

Set the message broadcasted using Broadcaster.broadcast(java.lang.Object)

Specified by:

setMessage in interface AtmosphereResourceEvent<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse>

Parameters:

message - The message broadcasted using Broadcaster.broadcast(java.lang.Object)

isResumedOnTimeout

public boolean isResumedOnTimeout()

Return true is the response gets resumed after a timeout.

Specified by:

isResumedOnTimeout in interface AtmosphereResourceEvent<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse>

Returns:

true is the response gets resumed after a timeout.

isCancelled

public boolean isCancelled()

Return true when the remote client close the connection.

Specified by:

isCancelled in interface AtmosphereResourceEvent<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse>

Returns:

true when the remote client close the connection.

setCancelled

protected void setCancelled(boolean isCancelled)

setIsResumedOnTimeout

protected void setIsResumedOnTimeout(boolean isResumedOnTimeout)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

throwable

public Throwable throwable()

Return a Throwable if an unexpected exception occured.

Specified by:

throwable in interface AtmosphereResourceEvent<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse>

Returns:

Throwable if an unexpected exception occured.

getResource

public AtmosphereResource<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse> getResource()

Return the AtmosphereResource associated with this event

Specified by:

getResource in interface AtmosphereResourceEvent<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse>

Returns:

AtmosphereResource

write

public void write(OutputStream os,
                  Object o)
           throws IOException

Write the Object using the OutputStream by invoking the current Serializer. If Serializer is null, the Object will be directly written using the {

Specified by:

write in interface AtmosphereResourceEvent<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse>

Parameters:

os - OutputStream

o - Object

Throws:

IOException

setThrowable

public void setThrowable(Throwable t)

destroy

public void destroy()

toString

public String toString()

Overrides:

toString in class Object