org.atmosphere.cpr

Interface AtmosphereResourceEvent

All Known Implementing Classes:

AtmosphereResourceEventImpl, HeartbeatAtmosphereResourceEvent

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 remotely closes the connection or when a suspended resource times out or gets resumed. When such events occur, 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

Modifier and Type	Method and Description
Broadcaster	broadcaster() Return the broadcaster associated with the AtmosphereResource this object contains.
java.lang.Object	getMessage() Return the object that was passed 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	isClosedByApplication() Return true if the application closed the connection using AtmosphereResource.close().
boolean	isClosedByClient() Return true if the client closed the connection and send the Atmosphere close message.
boolean	isResumedOnTimeout() Return true is the response gets resumed after a timeout.
boolean	isResuming() Return true if AtmosphereResource.resume() has been invoked.
boolean	isSuspended() Return true if AtmosphereResource.suspend() has been invoked and set to true.
AtmosphereResourceEvent	setMessage(java.lang.Object o) Set an Object that can be retrieved with getMessage().
java.lang.Throwable	throwable() Return a Throwable if an unexpected exception occured.

Method Detail

getMessage

java.lang.Object getMessage()

Return the object that was passed to Broadcaster.broadcast(java.lang.Object).

Returns:

the object that was passed to Broadcaster.broadcast(java.lang.Object)

setMessage

AtmosphereResourceEvent setMessage(java.lang.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 AtmosphereResource.suspend() has been invoked and set to true.

Returns:

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

isResuming

boolean isResuming()

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

Returns:

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

getResource

AtmosphereResource getResource()

Return the AtmosphereResource associated with this event.

Returns:

AtmosphereResource

isClosedByClient

boolean isClosedByClient()

Return true if the client closed the connection and send the Atmosphere close message. You must use the OnDisconnectInterceptor in order to receive the proper value, and atmosphereProtocol must be set to true on the client side (enabledProtocol is true by default).

Returns:

isClosedByApplication

boolean isClosedByApplication()

Return true if the application closed the connection using AtmosphereResource.close().

Returns:

if the application.

throwable

java.lang.Throwable throwable()

Return a Throwable if an unexpected exception occured.

Returns:

Throwable if an unexpected exception occured.

broadcaster

Broadcaster broadcaster()

Return the broadcaster associated with the AtmosphereResource this object contains.