org.atmosphere.cache

Class HeaderBroadcasterCache

java.lang.Object

org.atmosphere.cache.AbstractBroadcasterCache

org.atmosphere.cache.HeaderBroadcasterCache

All Implemented Interfaces:

CleanUpMemory, BroadcasterCache

public class HeaderBroadcasterCache
extends AbstractBroadcasterCache

Simple header based BroadcasterCache. The returned header is "X-Cache-Date" and containg the time, in milliseconds, of the last broadcasted message. By default, message will be cached for 5 minutes. You can change the value by calling AbstractBroadcasterCache.setMaxCachedinMs(int)

Author:

Jeanfrancois Arcand

Nested Class Summary

Nested classes/interfaces inherited from class org.atmosphere.cache.AbstractBroadcasterCache

AbstractBroadcasterCache.CachedMessage

Nested classes/interfaces inherited from interface org.atmosphere.cpr.BroadcasterCache

BroadcasterCache.STRATEGY

Field Summary

Fields inherited from class org.atmosphere.cache.AbstractBroadcasterCache

logger, maxCachedinMs, queue, reaper, scheduledFuture

Fields inherited from interface org.atmosphere.cpr.BroadcasterCache

BROADCASTER_CACHE_TRACKER

Constructor Summary

Constructors

Constructor and Description
HeaderBroadcasterCache()

Method Summary

Methods

Modifier and Type	Method and Description
void	cache(java.lang.String id, AtmosphereResource ar, AbstractBroadcasterCache.CachedMessage cm) Cache the last message broadcasted.
AbstractBroadcasterCache.CachedMessage	retrieveLastMessage(java.lang.String id, AtmosphereResource ar) Return the last message broadcasted to the AtmosphereResource.
AbstractBroadcasterCache.CachedMessage	retrieveUsingHeader(java.lang.String dateString)

Methods inherited from class org.atmosphere.cache.AbstractBroadcasterCache

addToCache, cleanup, getMaxCachedinMs, getQueueDepth, retrieveFromCache, setExecutorService, setMaxCachedinMs, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

HeaderBroadcasterCache

public HeaderBroadcasterCache()

Method Detail

cache

public void cache(java.lang.String id,
         AtmosphereResource ar,
         AbstractBroadcasterCache.CachedMessage cm)

Cache the last message broadcasted.

Specified by:

cache in class AbstractBroadcasterCache

ar - AtmosphereResource.

cm - AbstractBroadcasterCache.CachedMessage

retrieveLastMessage

public AbstractBroadcasterCache.CachedMessage retrieveLastMessage(java.lang.String id,
                                                         AtmosphereResource ar)

Return the last message broadcasted to the AtmosphereResource.

Specified by:

retrieveLastMessage in class AbstractBroadcasterCache

ar - AtmosphereResource.

Returns:

a AbstractBroadcasterCache.CachedMessage, or null if not matched.

retrieveUsingHeader

public AbstractBroadcasterCache.CachedMessage retrieveUsingHeader(java.lang.String dateString)