public class DefaultBroadcasterCache extends Object implements BroadcasterCache
DEFAULT, NULL
Constructor and Description |
---|
DefaultBroadcasterCache() |
Modifier and Type | Method and Description |
---|---|
BroadcasterCache |
addBroadcasterCacheListener(BroadcasterCacheListener l)
Add a
BroadcasterCacheListener |
CacheMessage |
addToCache(String broadcasterId,
String uuid,
BroadcastMessage message)
Start tracking messages associated with
AtmosphereResource from the cache. |
BroadcasterCache |
cacheCandidate(String broadcasterId,
String uuid)
Add a
AtmosphereResource.uuid() to the list of active AtmosphereResource
Message will be cached for the resource associated with the uuid. |
void |
cleanup()
Clean resources associated with this instance.
|
BroadcasterCache |
clearCache(String broadcasterId,
String uuid,
CacheMessage cache)
Remove the previously cached message.
|
void |
configure(AtmosphereConfig config)
Configure an AtmosphereFramework object.
|
BroadcasterCache |
excludeFromCache(String broadcasterId,
AtmosphereResource r)
Allow an application to exclude, or block, an
AtmosphereResource to received cached message. |
BroadcasterCache |
inspector(BroadcasterCacheInspector interceptor)
Add a
BroadcasterCacheInspector that will be invoked before a message gets added to the cache. |
BroadcasterCache |
removeBroadcasterCacheListener(BroadcasterCacheListener l)
Remove a
BroadcasterCacheListener |
List<Object> |
retrieveFromCache(String id,
String uuid)
Retrieve messages associated with
AtmosphereResource . |
void |
start()
This method is invoked when the Broadcaster is started.
|
void |
stop()
This method is invoked when the Broadcaster is stopped.
|
public void start()
BroadcasterCache
start
in interface BroadcasterCache
public void stop()
BroadcasterCache
stop
in interface BroadcasterCache
public void cleanup()
BroadcasterCache
Broadcaster
gets destroyed.cleanup
in interface BroadcasterCache
public CacheMessage addToCache(String broadcasterId, String uuid, BroadcastMessage message)
BroadcasterCache
AtmosphereResource
from the cache.addToCache
in interface BroadcasterCache
broadcasterId
- The associated Broadcaster#addAtmosphereResource(AtmosphereResource).getID
uuid
- AtmosphereResource.uuid()
message
- BroadcastMessage
.CacheMessage
public List<Object> retrieveFromCache(String id, String uuid)
BroadcasterCache
AtmosphereResource
.retrieveFromCache
in interface BroadcasterCache
id
- The associated org.atmosphere.cpr.Broadcaster#addAtmosphereResource(org.atmosphere.cpr.AtmosphereResource).getID
uuid
- AtmosphereResource
List
of messages (String).public BroadcasterCache clearCache(String broadcasterId, String uuid, CacheMessage cache)
BroadcasterCache
clearCache
in interface BroadcasterCache
broadcasterId
- The Broadcaster.getID()
uuid
- an AtmosphereResource.uuid()
cache
- the CacheMessage
public BroadcasterCache excludeFromCache(String broadcasterId, AtmosphereResource r)
BroadcasterCache
AtmosphereResource
to received cached message.
No new message will get sent to this client except the ones already cached.excludeFromCache
in interface BroadcasterCache
broadcasterId
- The Broadcaster.getID()
r
- an AtmosphereResource
public BroadcasterCache cacheCandidate(String broadcasterId, String uuid)
BroadcasterCache
AtmosphereResource.uuid()
to the list of active AtmosphereResource
Message will be cached for the resource associated with the uuid.cacheCandidate
in interface BroadcasterCache
broadcasterId
- The Broadcaster.getID()
uuid
- an AtmosphereResource.uuid()
public BroadcasterCache inspector(BroadcasterCacheInspector interceptor)
BroadcasterCache
BroadcasterCacheInspector
that will be invoked before a message gets added to the cache.inspector
in interface BroadcasterCache
interceptor
- an instance of BroadcasterCacheInspector
public BroadcasterCache addBroadcasterCacheListener(BroadcasterCacheListener l)
BroadcasterCache
BroadcasterCacheListener
addBroadcasterCacheListener
in interface BroadcasterCache
l
- a BroadcasterCacheListener
public BroadcasterCache removeBroadcasterCacheListener(BroadcasterCacheListener l)
BroadcasterCache
BroadcasterCacheListener
removeBroadcasterCacheListener
in interface BroadcasterCache
l
- a BroadcasterCacheListener
public void configure(AtmosphereConfig config)
AtmosphereConfigAware
configure
in interface AtmosphereConfigAware
config
- AtmosphereConfig
Copyright © 2016. All rights reserved.