org.atmosphere.util.gae
Class GAEDefaultBroadcaster

java.lang.Object
  org.atmosphere.cpr.DefaultBroadcaster
      org.atmosphere.util.gae.GAEDefaultBroadcaster

All Implemented Interfaces:

Broadcaster

public class GAEDefaultBroadcaster
extends DefaultBroadcaster

Broadcaster implementation.

This Broadcaster uses the calling thread to execute it's Broadcaster.broadcast(java.lang.Object) operations.

Author:

Jeanfrancois Arcand

Nested Class Summary

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

DefaultBroadcaster.Entry

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

Broadcaster.POLICY, Broadcaster.SCOPE

Field Summary

Fields inherited from class org.atmosphere.cpr.DefaultBroadcaster

bc, broadcasterCache, delayedBroadcast, destroyed, events, messages, name, scope, started

Constructor Summary

GAEDefaultBroadcaster()

GAEDefaultBroadcaster(String name)

Method Summary

Future<Object>	broadcast(Object msg) Broadcast the Object to all suspended response, e.g.
Future<Object>	broadcast(Object msg, AtmosphereResource r) Broadcast the Object to all suspended response, e.g.
Future<Object>	broadcast(Object msg, Set<AtmosphereResource<?,?>> subset) Broadcast the Object to all suspended response, e.g.
Future<Object>	delayBroadcast(Object o, long delay, TimeUnit t) Delay the broadcast operation.
Future<?>	scheduleFixedBroadcast(Object o, long period, TimeUnit t) Broadcast periodically.

Methods inherited from class org.atmosphere.cpr.DefaultBroadcaster

addAtmosphereResource, broadcast, checkCachedAndPush, delayBroadcast, destroy, filter, getAtmosphereResources, getBroadcasterConfig, getID, getScope, onException, push, push, removeAtmosphereResource, resumeAll, retrieveTrackedBroadcast, scheduleFixedBroadcast, setBroadcasterConfig, setID, setScope, setSuspendPolicy, start, toString, trackBroadcastMessage

Methods inherited from class java.lang.Object

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

Constructor Detail

GAEDefaultBroadcaster

public GAEDefaultBroadcaster()

GAEDefaultBroadcaster

public GAEDefaultBroadcaster(String name)

Method Detail

broadcast

public Future<Object> broadcast(Object msg)

Broadcast the Object to all suspended response, e.g. invoke AtmosphereHandler.onStateChange(org.atmosphere.cpr.AtmosphereResourceEvent).

Specified by:

broadcast in interface Broadcaster

Overrides:

broadcast in class DefaultBroadcaster

Parameters:

msg - and Object to be broadcasted.

Returns:

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

broadcast

public Future<Object> broadcast(Object msg,
                                AtmosphereResource r)

Broadcast the Object to all suspended response, e.g. 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 - and Object to be broadcasted.

r - an AtmosphereResource

Returns:

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

broadcast

public Future<Object> broadcast(Object msg,
                                Set<AtmosphereResource<?,?>> subset)

Broadcast the Object to all suspended response, e.g. 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 - and Object to be broadcasted.

subset - a Set of AtmosphereResource

Returns:

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

delayBroadcast

public Future<Object> delayBroadcast(Object o,
                                     long delay,
                                     TimeUnit t)

Delay the broadcast operation. The Object will be broadcasted once the specified delay expires or when the first Broadcaster.broadcast(java.lang.Object)

Specified by:

delayBroadcast in interface Broadcaster

Overrides:

delayBroadcast in class DefaultBroadcaster

Parameters:

o - and Object to be broadcasted.

delay - Amount of time to delay.

t - a TimeUnit of delay.

Returns:

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

scheduleFixedBroadcast

public Future<?> scheduleFixedBroadcast(Object o,
                                        long period,
                                        TimeUnit t)

Broadcast periodically. The Object will be broadcasted after every period specified time frame expires. If the TimeUnit is set null, the Object will be broadcasted when the first Broadcaster.broadcast(java.lang.Object) is invoked.

Specified by:

scheduleFixedBroadcast in interface Broadcaster

Overrides:

scheduleFixedBroadcast in class DefaultBroadcaster

Parameters:

o - and Object to be broadcasted.

period - Every so often broadcast.

t - a TimeUnit of period.

Returns:

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