Package org.atmosphere.util

Class AbstractBroadcasterProxy

java.lang.Object

org.atmosphere.cpr.DefaultBroadcaster

org.atmosphere.util.AbstractBroadcasterProxy

All Implemented Interfaces:

Broadcaster

public abstract class AbstractBroadcasterProxy
extends DefaultBroadcaster

Abstract Broadcaster that delegates the internal processing to a proxy.

Author:

Jeanfrancois Arcand

Nested Class Summary

Nested classes/interfaces inherited from class org.atmosphere.cpr.DefaultBroadcaster

DefaultBroadcaster.AsyncWriteToken, DefaultBroadcaster.WriteQueue

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

Broadcaster.POLICY, Broadcaster.SCOPE

Field Summary

Fields inherited from class org.atmosphere.cpr.DefaultBroadcaster

asyncWriteFuture, bc, broadcasterListeners, broadcastOnResume, CACHED, candidateForPoolable, config, delayedBroadcast, destroyed, dispatchThread, initialized, lifeCycleListeners, messages, name, notifierFuture, POLLING_DEFAULT, resources, scope, sharedListeners, started, uniqueWriteQueue, uri, usingTokenIdForAttribute, waitTime, writeQueues, writeTimeoutInSecond

Fields inherited from interface org.atmosphere.cpr.Broadcaster

ROOT_MASTER

Constructor Summary

Constructors

Constructor	Description
AbstractBroadcasterProxy()

Method Summary

Modifier and Type	Method	Description
protected java.util.concurrent.Future<java.lang.Object>	b(java.lang.Object msg)
java.util.concurrent.Future<java.lang.Object>	broadcast(java.lang.Object msg)	Broadcast the Object to all suspended responses, eg.
java.util.concurrent.Future<java.lang.Object>	broadcast(java.lang.Object msg, java.util.Set<AtmosphereResource> subset)	Broadcast the Object to all suspended response, eg.
java.util.concurrent.Future<java.lang.Object>	broadcast(java.lang.Object msg, AtmosphereResource r)	Broadcast the Object to all suspended responses, eg.
protected void	broadcastReceivedMessage(java.lang.Object message)
protected java.lang.Runnable	getBroadcastHandler()
abstract void	incomingBroadcast()	Implement this method to broadcast message received from an external source like JGroups, Redis, etc.
Broadcaster	initialize(java.lang.String id, java.net.URI uri, AtmosphereConfig config)	Configure a Broadcaster.
protected void	invokeOnStateChange(AtmosphereResource r, AtmosphereResourceEvent e)
abstract void	outgoingBroadcast(java.lang.Object message)	Implement this method to broadcast message to external source like JGroups, Redis, etc.
protected void	reconfigure()

Methods inherited from class org.atmosphere.cpr.DefaultBroadcaster

addAtmosphereResource, addBroadcasterLifeCyclePolicyListener, addBroadcasterListener, awaitAndBroadcast, broadcasterListeners, broadcastOnResume, broadcastOnResume, cacheAndSuspend, cacheLostMessage, cacheLostMessage, cacheLostMessage, cacheMessageOnIOException, checkCachedAndPush, createBroadcasterConfig, currentLifecycleTask, currentLifecycleTask, delayBroadcast, delayBroadcast, deliverPush, destroy, dispatchMessages, endBroadcast, entryDone, executeAsyncWrite, executeBlockingWrite, filter, futureDone, getAsyncWriteHandler, getAtmosphereResources, getBroadcasterConfig, getBroadcasterLifeCyclePolicy, getID, getScope, initialize, isDestroyed, killReactiveThreads, lifecycleHandler, lifecycleHandler, lifeCycleListeners, lifeCyclePolicy, messages, notifyAndAdd, notifyBroadcastListener, notifyOnAddAtmosphereResourceListener, notifyOnMessage, notifyOnRemoveAtmosphereResourceListener, onException, onException, outOfOrderBroadcastSupported, perRequestFilter, policy, prepareInvokeOnStateChange, push, queueWriteIO, reactiveThreadsCount, recentActivity, releaseExternalResources, removeAtmosphereResource, removeAtmosphereResource, removeBroadcasterLifeCyclePolicyListener, removeBroadcasterListener, rename, resumeAll, retrieveTrackedBroadcast, scheduleFixedBroadcast, scheduleFixedBroadcast, setBroadcasterConfig, setBroadcasterLifeCyclePolicy, setID, setScope, setSuspendPolicy, spawnReactor, start, toString, writeQueues

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractBroadcasterProxy

public AbstractBroadcasterProxy()

Method Detail

initialize

public Broadcaster initialize(java.lang.String id,
                              java.net.URI uri,
                              AtmosphereConfig config)

Description copied from interface: Broadcaster

Configure a Broadcaster.

Specified by:

initialize in interface Broadcaster

Overrides:

initialize in class DefaultBroadcaster

config - an AtmosphereConfig

Returns:

a usable Broadcaster.

incomingBroadcast

public abstract void incomingBroadcast()

Implement this method to broadcast message received from an external source like JGroups, Redis, etc.

outgoingBroadcast

public abstract void outgoingBroadcast(java.lang.Object message)

Implement this method to broadcast message to external source like JGroups, Redis, etc.

Parameters:

message - outgoing message

getBroadcastHandler

protected java.lang.Runnable getBroadcastHandler()

Overrides:

getBroadcastHandler in class DefaultBroadcaster

reconfigure

protected void reconfigure()

invokeOnStateChange

protected void invokeOnStateChange(AtmosphereResource r,
                                   AtmosphereResourceEvent e)

Overrides:

invokeOnStateChange in class DefaultBroadcaster

broadcastReceivedMessage

protected void broadcastReceivedMessage(java.lang.Object message)

broadcast

public java.util.concurrent.Future<java.lang.Object> broadcast(java.lang.Object msg)

Description copied from interface: Broadcaster

Broadcast the Object to all suspended responses, eg. invoke AtmosphereHandler.onStateChange(org.atmosphere.cpr.AtmosphereResourceEvent).

Specified by:

broadcast in interface Broadcaster

Overrides:

broadcast in class DefaultBroadcaster

Parameters:

msg - the Object to be broadcasted

Returns:

a Future that can be used to synchronize using the Future.get()

b

protected java.util.concurrent.Future<java.lang.Object> b(java.lang.Object msg)

broadcast

public java.util.concurrent.Future<java.lang.Object> broadcast(java.lang.Object msg,
                                                               AtmosphereResource r)

Description copied from interface: Broadcaster

Broadcast the Object to all suspended responses, eg. invoke AtmosphereHandler.onStateChange(org.atmosphere.cpr.AtmosphereResourceEvent) with an instance of AtmosphereResource, representing a single suspended response.

Specified by:

broadcast in interface Broadcaster

Overrides:

broadcast in class DefaultBroadcaster

Parameters:

msg - the Object to be broadcasted

r - an AtmosphereResource

Returns:

a Future that can be used to synchronize using the Future.get()

broadcast

public java.util.concurrent.Future<java.lang.Object> broadcast(java.lang.Object msg,
                                                               java.util.Set<AtmosphereResource> subset)

Description copied from interface: Broadcaster

Broadcast the Object to all suspended response, eg. invoke AtmosphereHandler.onStateChange(org.atmosphere.cpr.AtmosphereResourceEvent) with a Set of AtmosphereResource, representing a set of AtmosphereHandler.

Specified by:

broadcast in interface Broadcaster

Overrides:

broadcast in class DefaultBroadcaster

Parameters:

msg - the Object to be broadcasted

subset - a Set of AtmosphereResource

Returns:

a Future that can be used to synchronize using the Future.get()