org.atmosphere.util
Class ExcludeSessionBroadcaster

java.lang.Object
  org.atmosphere.cpr.DefaultBroadcaster
      org.atmosphere.util.ExcludeSessionBroadcaster

All Implemented Interfaces:

Broadcaster, Trackable

public class ExcludeSessionBroadcaster
extends DefaultBroadcaster

A example of how to extends/replace Broadcaster by defining the class value in META-INF/atmosphere.xml or by adding defining the org.atmosphere.cpr.broadcasterClass init-param in web.xml.

Author:

Jeanfrancois Arcand

Nested Class Summary

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

DefaultBroadcaster.AsyncWriteToken, 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

ASYNC_TOKEN, asyncWriteFuture, asyncWriteQueue, bc, broadcasterCache, broadcastOnResume, CACHED, cacheStrategy, config, delayedBroadcast, destroyed, lifeCycleListeners, messages, name, notifierFuture, resources, scope, started, uri

Constructor Summary

ExcludeSessionBroadcaster(String id, AtmosphereServlet.AtmosphereConfig config)

Method Summary

<T> Future<T>	broadcast(T msg, AtmosphereResource<?,?> r) the AtmosphereResource r will be exclude for this broadcast
<T> Future<T>	broadcast(T msg, javax.servlet.http.HttpSession s) session will be exclude for this broadcast
<T> Future<T>	broadcast(T msg, List<javax.servlet.http.HttpSession> sessions) a list of sessions will be exclude for this broadcast
<T> Future<T>	broadcast(T msg, Set<AtmosphereResource<?,?>> subset) the AtmosphereResources subset will be exclude for this broadcast

Methods inherited from class org.atmosphere.cpr.DefaultBroadcaster

addAtmosphereResource, addBroadcasterLifeCyclePolicyListener, awaitAndBroadcast, broadcast, broadcast, broadcastOnResume, broadcastOnResume, cacheLostMessage, cacheLostMessage, checkCachedAndPush, createBroadcasterConfig, delayBroadcast, delayBroadcast, destroy, executeAsyncWrite, filter, getAsyncWriteHandler, getAtmosphereResources, getBroadcasterConfig, getBroadcastHandler, getID, getScope, isDestroyed, onException, perRequestFilter, push, queueWriteIO, releaseExternalResources, removeAtmosphereResource, removeBroadcasterLifeCyclePolicyListener, resumeAll, retrieveTrackedBroadcast, scheduleFixedBroadcast, scheduleFixedBroadcast, setBroadcasterConfig, setBroadcasterLifeCyclePolicy, 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

ExcludeSessionBroadcaster

public ExcludeSessionBroadcaster(String id,
                                 AtmosphereServlet.AtmosphereConfig config)

Method Detail

broadcast

public <T> Future<T> broadcast(T msg,
                               AtmosphereResource<?,?> r)

the AtmosphereResource r will be exclude for this broadcast

Specified by:

broadcast in interface Broadcaster

Overrides:

broadcast in class DefaultBroadcaster

Type Parameters:

T -

Parameters:

msg -

r -

Returns:

broadcast

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

the AtmosphereResources subset will be exclude for this broadcast

Specified by:

broadcast in interface Broadcaster

Overrides:

broadcast in class DefaultBroadcaster

Type Parameters:

T -

Parameters:

msg -

subset -

Returns:

broadcast

public <T> Future<T> broadcast(T msg,
                               List<javax.servlet.http.HttpSession> sessions)

a list of sessions will be exclude for this broadcast

Type Parameters:

T -

Parameters:

msg -

sessions -

Returns:

broadcast

public <T> Future<T> broadcast(T msg,
                               javax.servlet.http.HttpSession s)

session will be exclude for this broadcast

Type Parameters:

T -

Parameters:

msg -

s -

Returns: