org.atmosphere.cpr
Interface AtmosphereResourceEvent

All Known Implementing Classes:

AtmosphereResourceEventImpl

public interface AtmosphereResourceEvent

An AtmosphereResourceEvent is created every time an event occurs like when a Broadcaster.broadcast(java.lang.Object) is executed, when a Browser close remotely close the connection or when a suspended times out or gets resumed. When such events occurs, an instance of that class will be created and its associated AtmosphereHandler.onStateChange(org.atmosphere.cpr.AtmosphereResourceEvent) will be invoked.

Author:

Jeanfrancois Arcand

Method Summary

Broadcaster	broadcaster() Return the broadcaster associated with the AtmosphereResource this object contains.
Object	getMessage() Return the object that were pass to Broadcaster.broadcast(java.lang.Object)
AtmosphereResource	getResource() Return the AtmosphereResource associated with this event
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
AtmosphereResourceEvent	setMessage(Object o) Set an Object that can be retrieved with getMessage().
Throwable	throwable() Return a Throwable if an unexpected exception occured.
AtmosphereResourceEvent	write(byte[] o) Write the byte using the underlying AtmosphereResponse.getOutputStream()
AtmosphereResourceEvent	write(OutputStream os, Object o) Write the Object using the OutputStream by invoking the current Serializer.

Method Detail

getMessage

Object getMessage()

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

Returns:

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

setMessage

AtmosphereResourceEvent setMessage(Object o)

Set an Object that can be retrieved with getMessage(). Note that the value may be overridden when Broadcaster.broadcast(java.lang.Object) gets invoked.

Parameters:

o - an Object that can be retrieved with getMessage().

isResumedOnTimeout

boolean isResumedOnTimeout()

Return true is the response gets resumed after a timeout.

Returns:

true is the response gets resumed after a timeout.

isCancelled

boolean isCancelled()

Return true when the remote client close the connection.

Returns:

true when the remote client close the connection.

isSuspended

boolean isSuspended()

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

Returns:

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

isResuming

boolean isResuming()

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

Returns:

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

getResource

AtmosphereResource getResource()

Return the AtmosphereResource associated with this event

Returns:

AtmosphereResource

write

AtmosphereResourceEvent 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 AtmosphereResponse.getOutputStream()

Parameters:

os - OutputStream

o - Object

Throws:

IOException

throwable

Throwable throwable()

Return a Throwable if an unexpected exception occured.

Returns:

Throwable if an unexpected exception occured.

write

AtmosphereResourceEvent write(byte[] o)
                              throws IOException

Write the byte using the underlying AtmosphereResponse.getOutputStream()

Parameters:

o - byte

Throws:

IOException

broadcaster

Broadcaster broadcaster()

Return the broadcaster associated with the AtmosphereResource this object contains.