org.atmosphere.cache
Class HeaderBroadcasterCache

java.lang.Object
  org.atmosphere.cache.BroadcasterCacheBase
      org.atmosphere.cache.HeaderBroadcasterCache

All Implemented Interfaces:

BroadcasterCache<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse>

public class HeaderBroadcasterCache
extends BroadcasterCacheBase

Simple header based BroadcasterCache. The returned header is "X-Cache-Date" and containg the time, in milliseconds, of the last broadcasted message.

Author:

Jeanfrancois Arcand

Nested Class Summary

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

BroadcasterCacheBase.CachedMessage

Field Summary

Fields inherited from class org.atmosphere.cache.BroadcasterCacheBase

maxCachedinMs, queue, reaper

Fields inherited from interface org.atmosphere.cpr.BroadcasterCache

BROADCASTER_CACHE_TRACKER

Constructor Summary

HeaderBroadcasterCache()

Method Summary

void	cache(AtmosphereResource<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse> r, BroadcasterCacheBase.CachedMessage cm) Cache the last message broadcasted.
BroadcasterCacheBase.CachedMessage	retrieveLastMessage(AtmosphereResource<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse> r) Return the last message broadcasted to the AtmosphereResource.
BroadcasterCacheBase.CachedMessage	retrieveUsingHeader(String dateString)

Methods inherited from class org.atmosphere.cache.BroadcasterCacheBase

addToCache, getMaxCachedinMs, retrieveFromCache, 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(AtmosphereResource<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse> r,
                  BroadcasterCacheBase.CachedMessage cm)

Cache the last message broadcasted.

Specified by:

cache in class BroadcasterCacheBase

Parameters:

r - AtmosphereResource.

cm - BroadcasterCacheBase.CachedMessage

retrieveLastMessage

public BroadcasterCacheBase.CachedMessage retrieveLastMessage(AtmosphereResource<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse> r)

Return the last message broadcasted to the AtmosphereResource.

Specified by:

retrieveLastMessage in class BroadcasterCacheBase

Parameters:

r - AtmosphereResource.

Returns:

a BroadcasterCacheBase.CachedMessage, or null if not matched.

retrieveUsingHeader

public BroadcasterCacheBase.CachedMessage retrieveUsingHeader(String dateString)