org.atmosphere.interceptor
Class HeartbeatInterceptor

java.lang.Object
  org.atmosphere.cpr.AtmosphereInterceptorAdapter
      org.atmosphere.interceptor.HeartbeatInterceptor

All Implemented Interfaces:

AtmosphereInterceptor

public class HeartbeatInterceptor
extends AtmosphereInterceptorAdapter

An interceptor that send whitespace every 30 seconds

Author:

Jeanfrancois Arcand

Field Summary

static String

HEARTBEAT_INTERVAL_IN_SECONDS

Constructor Summary

HeartbeatInterceptor()

Method Summary

void	configure(AtmosphereConfig config) Allow this object to configure it's state when initialized
Action	inspect(AtmosphereResource r) Invoked before an AtmosphereResource gets dispatched to AtmosphereHandler
String	toString()

Methods inherited from class org.atmosphere.cpr.AtmosphereInterceptorAdapter

postInspect

Methods inherited from class java.lang.Object

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

Field Detail

HEARTBEAT_INTERVAL_IN_SECONDS

public static final String HEARTBEAT_INTERVAL_IN_SECONDS

Constructor Detail

HeartbeatInterceptor

public HeartbeatInterceptor()

Method Detail

configure

public void configure(AtmosphereConfig config)

Description copied from interface: AtmosphereInterceptor

Allow this object to configure it's state when initialized

Specified by:

configure in interface AtmosphereInterceptor

Overrides:

configure in class AtmosphereInterceptorAdapter

Parameters:

config - an 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 Object