Package org.atmosphere.cpr

Class AtmosphereResourceEventImpl

java.lang.Object

org.atmosphere.cpr.AtmosphereResourceEventImpl

All Implemented Interfaces:

AtmosphereResourceEvent

Direct Known Subclasses:

HeartbeatAtmosphereResourceEvent

public class AtmosphereResourceEventImpl
extends Object
implements AtmosphereResourceEvent

AtmosphereResourceEvent implementation.

Field Summary

Fields

Modifier and Type	Field	Description
protected Object	message
protected AtmosphereResourceImpl	resource

Constructor Summary

Constructors

Constructor	Description
AtmosphereResourceEventImpl(AtmosphereResourceImpl resource)
AtmosphereResourceEventImpl(AtmosphereResourceImpl resource, boolean isCancelled, boolean isResumedOnTimeout)
AtmosphereResourceEventImpl(AtmosphereResourceImpl resource, boolean isCancelled, boolean isResumedOnTimeout, boolean isClosedByClient, Throwable throwable)
AtmosphereResourceEventImpl(AtmosphereResourceImpl resource, boolean isCancelled, boolean isResumedOnTimeout, Throwable throwable)

Method Summary

Modifier and Type	Method	Description
Broadcaster	broadcaster()	Return the broadcaster associated with the AtmosphereResource this object contains.
boolean	closedGoingAway()	Whether an HTTP transport's close message ended this event's resource with HeaderConfig.X_ATMOSPHERE_CLOSE_REASON going-away: the page that held the connection was hidden or unloaded (a reload, a navigation), which a WebSocket reports with a 1001 close.
AtmosphereResourceEventImpl	closedGoingAway(boolean goingAway)	Records that the close message ending this event's resource said its page is going away; set before the disconnect is dispatched.
AtmosphereResourceEvent	destroy()
void	disconnectDispatchDone()	The disconnect callback this caller claimed with getAndSetDisconnectDispatched() has returned or thrown; a close waiting to tear the resource down may proceed.
boolean	equals(Object o)
boolean	getAndSetDisconnectDispatched()	Claims the dispatch of the handler's disconnect callback (e.g.
Object	getMessage()	Return the object that was passed 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	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.
AtmosphereResourceEventImpl	isClosedByClient(boolean isClosedByClient)
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.
AtmosphereResourceEventImpl	setCancelled(boolean isCancelled)
AtmosphereResourceEventImpl	setCloseByApplication(boolean b)
protected AtmosphereResourceEventImpl	setIsResumedOnTimeout(boolean isResumedOnTimeout)
AtmosphereResourceEventImpl	setMessage(Object message)	Set an Object that can be retrieved with AtmosphereResourceEvent.getMessage().
AtmosphereResourceEvent	setThrowable(Throwable t)
Throwable	throwable()	Return a Throwable if an unexpected exception occured.
String	toString()
String	uuid()	The UUID of the AtmosphereResource this event was created for.
int	webSocketCloseCode()	The status code of the WebSocket close that ended this event's resource: 1000 for a client that closed on purpose, 1001 for a browser leaving or reloading the page, 1006 for a lost connection.
AtmosphereResourceEventImpl	webSocketCloseCode(int closeCode)	Records the status code of the WebSocket close that ends this event's resource; set before the disconnect is dispatched.

Methods inherited from class java.lang.Object

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

Field Details

message

protected volatile Object message

resource

protected volatile AtmosphereResourceImpl resource

Constructor Details

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)

AtmosphereResourceEventImpl

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

Method Details

uuid

public String uuid()

The UUID of the AtmosphereResource this event was created for. Captured at construction time, so it remains available after destroy() has stripped the resource reference — containers (Tomcat) can fire async error/cancel listeners with a recycled request, and disconnect-cleanup paths need the resource identity even then.

Returns:

the originating resource UUID; never null

getAndSetDisconnectDispatched

public boolean getAndSetDisconnectDispatched()

Claims the dispatch of the handler's disconnect callback (e.g. @Disconnect) for this event's resource. A close and an in-flight broadcast can both hand the handler a cancelled event: the close thread runs the disconnect, and a broadcast that passed the broadcaster's validity check just before the cancel delivers the same event again. Only the first caller may dispatch (Invariant #2). The claim survives destroy(). A caller that claimed it must call disconnectDispatchDone() once the callback returns: the resource is not torn down while it runs.

Returns:

true if the disconnect was already dispatched, false if this call claimed it

disconnectDispatchDone

public void disconnectDispatchDone()

The disconnect callback this caller claimed with getAndSetDisconnectDispatched() has returned or thrown; a close waiting to tear the resource down may proceed.

isResuming

public boolean isResuming()

Description copied from interface: AtmosphereResourceEvent

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

Specified by:

isResuming in interface AtmosphereResourceEvent

Returns:

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

isSuspended

public boolean isSuspended()

Description copied from interface: AtmosphereResourceEvent

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

Specified by:

isSuspended in interface AtmosphereResourceEvent

Returns:

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

isClosedByClient

public boolean isClosedByClient()

Description copied from interface: AtmosphereResourceEvent

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).

Specified by:

isClosedByClient in interface AtmosphereResourceEvent

Returns:

isClosedByApplication

public boolean isClosedByApplication()

Description copied from interface: AtmosphereResourceEvent

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

Specified by:

isClosedByApplication in interface AtmosphereResourceEvent

Returns:

if the application.

setCloseByApplication

public AtmosphereResourceEventImpl setCloseByApplication(boolean b)

getMessage

public Object getMessage()

Description copied from interface: AtmosphereResourceEvent

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

Specified by:

getMessage in interface AtmosphereResourceEvent

Returns:

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

setMessage

public AtmosphereResourceEventImpl setMessage(Object message)

Description copied from interface: AtmosphereResourceEvent

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

Specified by:

setMessage in interface AtmosphereResourceEvent

Parameters:

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

isClosedByClient

public AtmosphereResourceEventImpl isClosedByClient(boolean isClosedByClient)

webSocketCloseCode

public int webSocketCloseCode()

The status code of the WebSocket close that ended this event's resource: 1000 for a client that closed on purpose, 1001 for a browser leaving or reloading the page, 1006 for a lost connection. Both 1000 and 1001 report isClosedByClient(); the code is what tells a client that left from one that may come back.

Returns:

the close code, or -1 when no WebSocket close ended the resource (an HTTP transport, or a resource still open)

webSocketCloseCode

public AtmosphereResourceEventImpl webSocketCloseCode(int closeCode)

Records the status code of the WebSocket close that ends this event's resource; set before the disconnect is dispatched.

Parameters:

closeCode - the WebSocket close status code

Returns:

this

closedGoingAway

public boolean closedGoingAway()

Whether an HTTP transport's close message ended this event's resource with HeaderConfig.X_ATMOSPHERE_CLOSE_REASON going-away: the page that held the connection was hidden or unloaded (a reload, a navigation), which a WebSocket reports with a 1001 close. Such a resource also reports isClosedByClient(); a close message without the reason is a client that left on purpose.

Returns:

true when the close message said the page is going away

closedGoingAway

public AtmosphereResourceEventImpl closedGoingAway(boolean goingAway)

Records that the close message ending this event's resource said its page is going away; set before the disconnect is dispatched.

Parameters:

goingAway - whether the page is going away

Returns:

this

isResumedOnTimeout

public boolean isResumedOnTimeout()

Description copied from interface: AtmosphereResourceEvent

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()

Description copied from interface: AtmosphereResourceEvent

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

public AtmosphereResourceEventImpl setCancelled(boolean isCancelled)

setIsResumedOnTimeout

protected AtmosphereResourceEventImpl 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()

Description copied from interface: AtmosphereResourceEvent

Return a Throwable if an unexpected exception occured.

Specified by:

throwable in interface AtmosphereResourceEvent

Returns:

Throwable if an unexpected exception occured.

broadcaster

public Broadcaster broadcaster()

Description copied from interface: AtmosphereResourceEvent

Return the broadcaster associated with the AtmosphereResource this object contains.

Specified by:

broadcaster in interface AtmosphereResourceEvent

getResource

public AtmosphereResource getResource()

Description copied from interface: AtmosphereResourceEvent

Return the AtmosphereResource associated with this event.

Specified by:

getResource in interface AtmosphereResourceEvent

Returns:

AtmosphereResource

setThrowable

public AtmosphereResourceEvent setThrowable(Throwable t)

destroy

public AtmosphereResourceEvent destroy()

toString

public String toString()

Overrides:

toString in class Object