org.atmosphere.cache

Class UUIDBroadcasterCache

java.lang.Object

org.atmosphere.cache.UUIDBroadcasterCache

All Implemented Interfaces:

CleanUpMemory, BroadcasterCache

public class UUIDBroadcasterCache
extends java.lang.Object
implements BroadcasterCache, CleanUpMemory

An improved BroadcasterCache implementation.

Author:

Paul Khodchenkov, Jeanfrancois Arcand

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UUIDBroadcasterCache.CacheMessage
static class	UUIDBroadcasterCache.ClientQueue

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

BroadcasterCache.STRATEGY

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.concurrent.ScheduledExecutorService	taskScheduler

Fields inherited from interface org.atmosphere.cpr.BroadcasterCache

BROADCASTER_CACHE_TRACKER

Constructor Summary

Constructors

Constructor and Description
UUIDBroadcasterCache()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Long>	activeClients()
UUIDBroadcasterCache.CacheMessage	addCacheCandidate(java.lang.String broadcasterId, AtmosphereResource r, java.lang.Object e) For backward compatibility with 1.0.9 and lower, use the method above.
void	addToCache(java.lang.String broadcasterId, AtmosphereResource r, java.lang.Object e) Start tracking messages associated with AtmosphereResource from the cache
void	cleanup() Clean up the associated ScheduledFuture
void	clearCache(java.lang.String broadcasterId, AtmosphereResourceImpl r, UUIDBroadcasterCache.CacheMessage message)
protected void	invalidateExpiredEntries()
java.util.Map<java.lang.String,UUIDBroadcasterCache.ClientQueue>	messages()
java.util.List<java.lang.Object>	retrieveFromCache(java.lang.String broadcasterId, AtmosphereResource r) Retrieve messages associated with AtmosphereResource
void	setClientIdleTime(long clientIdleTime)
void	setExecutorService(java.util.concurrent.ScheduledExecutorService reaper) Set the associated ScheduledExecutorService
void	setInvalidateCacheInterval(long invalidateCacheInterval)
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

taskScheduler

protected java.util.concurrent.ScheduledExecutorService taskScheduler

Constructor Detail

UUIDBroadcasterCache

public UUIDBroadcasterCache()

Method Detail

setInvalidateCacheInterval

public void setInvalidateCacheInterval(long invalidateCacheInterval)

setClientIdleTime

public void setClientIdleTime(long clientIdleTime)

setExecutorService

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

Set the associated ScheduledExecutorService

Specified by:

setExecutorService in interface CleanUpMemory

start

public void start()

Description copied from interface: BroadcasterCache

Start

Specified by:

start in interface BroadcasterCache

invalidateExpiredEntries

protected void invalidateExpiredEntries()

stop

public void stop()

Description copied from interface: BroadcasterCache

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 void addToCache(java.lang.String broadcasterId,
              AtmosphereResource r,
              java.lang.Object e)

Description copied from interface: BroadcasterCache

Start tracking messages associated with AtmosphereResource from the cache

Specified by:

addToCache in interface BroadcasterCache

r - AtmosphereResource

e - a broadcasted message.

addCacheCandidate

public UUIDBroadcasterCache.CacheMessage addCacheCandidate(java.lang.String broadcasterId,
                                                  AtmosphereResource r,
                                                  java.lang.Object e)

For backward compatibility with 1.0.9 and lower, use the method above.

Parameters:

broadcasterId -

r -

e -

Returns:

retrieveFromCache

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

Description copied from interface: BroadcasterCache

Retrieve messages associated with AtmosphereResource

Specified by:

retrieveFromCache in interface BroadcasterCache

r - AtmosphereResource

Returns:

a List of messages (String).

clearCache

public void clearCache(java.lang.String broadcasterId,
              AtmosphereResourceImpl r,
              UUIDBroadcasterCache.CacheMessage message)

messages

public java.util.Map<java.lang.String,UUIDBroadcasterCache.ClientQueue> messages()

activeClients

public java.util.Map<java.lang.String,java.lang.Long> activeClients()