org.atmosphere.cache

Class AbstractBroadcasterCache

java.lang.Object

org.atmosphere.cache.AbstractBroadcasterCache

All Implemented Interfaces:

CleanUpMemory, BroadcasterCache

Direct Known Subclasses:

HeaderBroadcasterCache, SessionBroadcasterCache

public abstract class AbstractBroadcasterCache
extends java.lang.Object
implements BroadcasterCache, CleanUpMemory

Abstract BroadcasterCache which is used to implement headers or query parameters or session based caching.

Author:

Jeanfrancois Arcand

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractBroadcasterCache.CachedMessage

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

BroadcasterCache.STRATEGY

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	logger
protected int	maxCachedinMs
protected java.util.List<AbstractBroadcasterCache.CachedMessage>	queue
protected java.util.concurrent.ScheduledExecutorService	reaper
protected java.util.concurrent.ScheduledFuture	scheduledFuture

Fields inherited from interface org.atmosphere.cpr.BroadcasterCache

BROADCASTER_CACHE_TRACKER

Constructor Summary

Constructors

Constructor and Description
AbstractBroadcasterCache()

Method Summary

Methods

Modifier and Type	Method and Description
void	addToCache(java.lang.String id, AtmosphereResource resource, java.lang.Object object) Start tracking messages associated with AtmosphereResource from the cache
abstract void	cache(java.lang.String id, AtmosphereResource r, AbstractBroadcasterCache.CachedMessage cm) Cache the last message broadcasted.
void	cleanup() Clean up the associated ScheduledFuture
int	getMaxCachedinMs() Get the maximum time a broadcasted message can stay cached.
int	getQueueDepth() Get the number of messages which are currently in the cache.
java.util.List<java.lang.Object>	retrieveFromCache(java.lang.String id, AtmosphereResource r) Retrieve messages associated with AtmosphereResource
abstract AbstractBroadcasterCache.CachedMessage	retrieveLastMessage(java.lang.String id, AtmosphereResource r) Return the last message broadcasted to the AtmosphereResource.
void	setExecutorService(java.util.concurrent.ScheduledExecutorService reaper) Set the associated ScheduledExecutorService
void	setMaxCachedinMs(int maxCachedinMs) Set the maximum time a broadcasted message can stay cached.
void	start() Start
void	stop() Stop

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.slf4j.Logger logger

queue

protected final java.util.List<AbstractBroadcasterCache.CachedMessage> queue

reaper

protected java.util.concurrent.ScheduledExecutorService reaper

maxCachedinMs

protected int maxCachedinMs

scheduledFuture

protected java.util.concurrent.ScheduledFuture scheduledFuture

Constructor Detail

AbstractBroadcasterCache

public AbstractBroadcasterCache()

Method Detail

start

public final void start()

Start

Specified by:

start in interface BroadcasterCache

setExecutorService

public void setExecutorService(java.util.concurrent.ScheduledExecutorService reaper)

Set the associated ScheduledExecutorService

Specified by:

setExecutorService in interface CleanUpMemory

stop

public final void stop()

Stop

Specified by:

stop in interface BroadcasterCache

cleanup

public void cleanup()

Description copied from interface: CleanUpMemory

Clean up the associated ScheduledFuture

Specified by:

cleanup in interface CleanUpMemory

addToCache

public final void addToCache(java.lang.String id,
              AtmosphereResource resource,
              java.lang.Object object)

Start tracking messages associated with AtmosphereResource from the cache

Specified by:

addToCache in interface BroadcasterCache

resource - AtmosphereResource

object - a broadcasted message.

cache

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

Cache the last message broadcasted.

Parameters:

r - AtmosphereResource.

cm - AbstractBroadcasterCache.CachedMessage

retrieveLastMessage

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

Return the last message broadcasted to the AtmosphereResource.

Parameters:

r - AtmosphereResource.

Returns:

a AbstractBroadcasterCache.CachedMessage, or null if not matched.

retrieveFromCache

public final java.util.List<java.lang.Object> retrieveFromCache(java.lang.String id,
                                                 AtmosphereResource r)

Retrieve messages associated with AtmosphereResource

Specified by:

retrieveFromCache in interface BroadcasterCache

r - AtmosphereResource

Returns:

a List of messages (String).

getQueueDepth

public int getQueueDepth()

Get the number of messages which are currently in the cache.

Returns:

the number of messages which are currently in the cache

getMaxCachedinMs

public int getMaxCachedinMs()

Get the maximum time a broadcasted message can stay cached.

Returns:

Get the maximum time a broadcasted message can stay cached.

setMaxCachedinMs

public void setMaxCachedinMs(int maxCachedinMs)

Set the maximum time a broadcasted message can stay cached.

Parameters:

maxCachedinMs - time in milliseconds