org.atmosphere.cpr

Interface BroadcasterCache

All Known Implementing Classes:

AbstractBroadcasterCache, BroadcasterCacheBase, BroadcasterConfig.DefaultBroadcasterCache, HeaderBroadcasterCache, OnReconnectBroadcasterCache, SessionBroadcasterCache, UUIDBroadcasterCache

public interface BroadcasterCache

A BroadcasterCache is used to persist broadcasted Object Broadcaster.broadcast(Object). Disconnected clients can always retrieve message that were broadcasted during their "downtime". BroadcasterCache are useful when a the long polling technique is used and prevent application from loosing event between re-connection.

A BroadcasterCache can be configured by invoking BroadcasterConfig.setBroadcasterCache(BroadcasterCache) by defining it in your web/application.xml or by using the BroadcasterCacheService

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BroadcasterCache.STRATEGY

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BROADCASTER_CACHE_TRACKER

Method Summary

Methods

Modifier and Type	Method and Description
void	addToCache(java.lang.String id, AtmosphereResource r, java.lang.Object e) Start tracking messages associated with AtmosphereResource from the cache
java.util.List<java.lang.Object>	retrieveFromCache(java.lang.String id, AtmosphereResource r) Retrieve messages associated with AtmosphereResource
void	start() Start
void	stop() Stop

Field Detail

BROADCASTER_CACHE_TRACKER

static final java.lang.String BROADCASTER_CACHE_TRACKER

Method Detail

start

void start()

Start

stop

void stop()

Stop

addToCache

void addToCache(java.lang.String id,
              AtmosphereResource r,
              java.lang.Object e)

Start tracking messages associated with AtmosphereResource from the cache

Parameters:

r - AtmosphereResource

e - a broadcasted message.

retrieveFromCache

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

Retrieve messages associated with AtmosphereResource

Parameters:

r - AtmosphereResource

Returns:

a List of messages (String).