org.atmosphere.cpr

Class AtmosphereResourceEventImpl

java.lang.Object

org.atmosphere.cpr.AtmosphereResourceEventImpl

All Implemented Interfaces:

AtmosphereResourceEvent

public class AtmosphereResourceEventImpl
extends java.lang.Object
implements AtmosphereResourceEvent

AtmosphereResourceEvent implementation for Servlet Container.

Author:

Jeanfrancois Arcand

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Object	message
protected AtmosphereResourceImpl	resource

Constructor Summary

Constructors

Constructor and Description
AtmosphereResourceEventImpl(AtmosphereResourceImpl resource)
AtmosphereResourceEventImpl(AtmosphereResourceImpl resource, boolean isCancelled, boolean isResumedOnTimeout)
AtmosphereResourceEventImpl(AtmosphereResourceImpl resource, boolean isCancelled, boolean isResumedOnTimeout, java.lang.Throwable throwable)

Method Summary

Methods

Modifier and Type	Method and Description
Broadcaster	broadcaster() Return the broadcaster associated with the AtmosphereResource this object contains.
AtmosphereResourceEvent	destroy()
boolean	equals(java.lang.Object o)
java.lang.Object	getMessage() Return the object that were pass to Broadcaster.broadcast(java.lang.Object)
AtmosphereResource	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 AtmosphereResourceEvent	setCancelled(boolean isCancelled)
protected AtmosphereResourceEvent	setIsResumedOnTimeout(boolean isResumedOnTimeout)
AtmosphereResourceEvent	setMessage(java.lang.Object message) Set the message broadcasted using Broadcaster.broadcast(java.lang.Object)
AtmosphereResourceEvent	setThrowable(java.lang.Throwable t)
java.lang.Throwable	throwable() Return a Throwable if an unexpected exception occured.
java.lang.String	toString()
AtmosphereResourceEvent	write(byte[] o) Write the byte using the underlying AtmosphereResponse.getOutputStream()
AtmosphereResourceEvent	write(java.io.OutputStream os, java.lang.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 java.lang.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,
                           java.lang.Throwable throwable)

Method Detail

isResuming

public boolean isResuming()

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

Specified by:

isResuming in interface AtmosphereResourceEvent

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

Returns:

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

getMessage

public java.lang.Object getMessage()

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

Specified by:

getMessage in interface AtmosphereResourceEvent

Returns:

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

setMessage

public AtmosphereResourceEvent setMessage(java.lang.Object message)

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

Specified by:

setMessage in interface AtmosphereResourceEvent

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

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

Returns:

true when the remote client close the connection.

setCancelled

protected AtmosphereResourceEvent setCancelled(boolean isCancelled)

setIsResumedOnTimeout

protected AtmosphereResourceEvent setIsResumedOnTimeout(boolean isResumedOnTimeout)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

throwable

public java.lang.Throwable throwable()

Return a Throwable if an unexpected exception occured.

Specified by:

throwable in interface AtmosphereResourceEvent

Returns:

Throwable if an unexpected exception occured.

write

public AtmosphereResourceEvent write(byte[] o)
                              throws java.io.IOException

Write the byte using the underlying AtmosphereResponse.getOutputStream()

Specified by:

write in interface AtmosphereResourceEvent

Parameters:

o - byte

Throws:

java.io.IOException

broadcaster

public Broadcaster broadcaster()

Return the broadcaster associated with the AtmosphereResource this object contains.

Specified by:

broadcaster in interface AtmosphereResourceEvent

getResource

public AtmosphereResource getResource()

Return the AtmosphereResource associated with this event

Specified by:

getResource in interface AtmosphereResourceEvent

Returns:

AtmosphereResource

write

public AtmosphereResourceEvent write(java.io.OutputStream os,
                            java.lang.Object o)
                              throws java.io.IOException

Write the Object using the OutputStream by invoking the current Serializer. If Serializer is null, the Object will be directly written using the AtmosphereResponse.getOutputStream()

Specified by:

write in interface AtmosphereResourceEvent

Parameters:

os - OutputStream

o - Object

Throws:

java.io.IOException

setThrowable

public AtmosphereResourceEvent setThrowable(java.lang.Throwable t)

destroy

public AtmosphereResourceEvent destroy()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object