org.atmosphere.interceptor

Class HeartbeatInterceptor

java.lang.Object

org.atmosphere.cpr.AtmosphereInterceptorAdapter

org.atmosphere.interceptor.HeartbeatInterceptor

All Implemented Interfaces:

AtmosphereInterceptor, InvokationOrder

public class HeartbeatInterceptor
extends AtmosphereInterceptorAdapter

An interceptor that send whitespace every 30 seconds.

Author:

Jeanfrancois Arcand

Nested Class Summary

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

InvokationOrder.PRIORITY

Field Summary

Fields

Modifier and Type	Field and Description
static String	HEARTBEAT_FUTURE
static String	HEARTBEAT_INTERVAL_IN_SECONDS
static String	INTERCEPTOR_ADDED

Fields inherited from interface org.atmosphere.interceptor.InvokationOrder

AFTER_DEFAULT, BEFORE_DEFAULT, FIRST_BEFORE_DEFAULT

Constructor Summary

Constructors

Constructor and Description
HeartbeatInterceptor()

Method Summary

Modifier and Type	Method and Description
HeartbeatInterceptor	clock(AtmosphereResource r, AtmosphereRequest request, AtmosphereResponse response)
void	configure(AtmosphereConfig config) Allow this object to configure its state when initialized.
HeartbeatInterceptor	heartbeatFrequencyInSeconds(int heartbeatFrequencyInSeconds)
Action	inspect(AtmosphereResource r) Invoked before an AtmosphereResource gets dispatched to AtmosphereHandler.
HeartbeatInterceptor	paddingText(byte[] paddingBytes)
String	toString()

Methods inherited from class org.atmosphere.cpr.AtmosphereInterceptorAdapter

postInspect, priority

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

INTERCEPTOR_ADDED

public static final String INTERCEPTOR_ADDED

HEARTBEAT_FUTURE

public static final String HEARTBEAT_FUTURE

See Also:

Constant Field Values

Constructor Detail

HeartbeatInterceptor

public HeartbeatInterceptor()

Method Detail

paddingText

public HeartbeatInterceptor paddingText(byte[] paddingBytes)

heartbeatFrequencyInSeconds

public HeartbeatInterceptor heartbeatFrequencyInSeconds(int heartbeatFrequencyInSeconds)

configure

public void configure(AtmosphereConfig config)

Description copied from interface: AtmosphereInterceptor

Allow this object to configure its 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.

clock

public HeartbeatInterceptor clock(AtmosphereResource r,
                                  AtmosphereRequest request,
                                  AtmosphereResponse response)

toString

public String toString()

Overrides:

toString in class AtmosphereInterceptorAdapter