Package org.atmosphere.interceptor

Class OnDisconnectInterceptor

java.lang.Object

org.atmosphere.cpr.AtmosphereInterceptorAdapter

org.atmosphere.interceptor.OnDisconnectInterceptor

All Implemented Interfaces:

AtmosphereInterceptor, AtmosphereConfigAware, InvokationOrder

public class OnDisconnectInterceptor
extends AtmosphereInterceptorAdapter

When the browser close the connection, the atmosphere.js will send an unsubscribe message to tell framework the browser is disconnecting.

A close message carrying HeaderConfig.X_ATMOSPHERE_CLOSE_REASON going-away (atmosphere.js sends it from pagehide) marks the disconnect event AtmosphereResourceEventImpl.closedGoingAway(): the page is reloading or navigating, as a WebSocket closed with 1001. Without it, the client left on purpose.

Nested Class Summary

Nested classes/interfaces inherited from interface org.atmosphere.interceptor.InvokationOrder

InvokationOrder.PRIORITY

Field Summary

Fields inherited from interface org.atmosphere.interceptor.InvokationOrder

AFTER_DEFAULT, BEFORE_DEFAULT, FIRST_BEFORE_DEFAULT

Constructor Summary

Constructors

Constructor	Description
OnDisconnectInterceptor()

Method Summary

Modifier and Type	Method	Description
void	configure(AtmosphereConfig config)	Configure an AtmosphereFramework object.
Action	inspect(AtmosphereResource r)	Invoked before an AtmosphereResource gets dispatched to AtmosphereHandler.
String	toString()

Methods inherited from class org.atmosphere.cpr.AtmosphereInterceptorAdapter

destroy, postInspect, priority

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

OnDisconnectInterceptor

public OnDisconnectInterceptor()

Method Details

configure

public void configure(AtmosphereConfig config)

Description copied from interface: AtmosphereConfigAware

Configure an AtmosphereFramework object.

Specified by:

configure in interface AtmosphereConfigAware

Overrides:

configure in class AtmosphereInterceptorAdapter

Parameters:

config - AtmosphereConfig

inspect

public Action inspect(AtmosphereResource r)

Description copied from interface: AtmosphereInterceptor

Invoked before an AtmosphereResource gets dispatched to AtmosphereHandler.

Specified by:

inspect in interface AtmosphereInterceptor

Overrides:

inspect in class AtmosphereInterceptorAdapter

Parameters:

r - a AtmosphereResource

Returns:

Action.CONTINUE or Action.SUSPEND to dispatch the AtmosphereResource to other AtmosphereInterceptor or AtmosphereHandler. Return Action.TYPE.CANCELLED to stop the processing.

toString

public String toString()

Overrides:

toString in class AtmosphereInterceptorAdapter