Package org.atmosphere.util

Class ExcludeSessionBroadcaster

java.lang.Object

org.atmosphere.cpr.DefaultBroadcaster

org.atmosphere.util.ExcludeSessionBroadcaster

All Implemented Interfaces:

Broadcaster

public class ExcludeSessionBroadcaster
extends DefaultBroadcaster

An implementation of DefaultBroadcaster that exclude one or more AtmosphereResource

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
ExcludeSessionBroadcaster()

Method Summary

Modifier and Type	Method	Description
java.util.concurrent.Future<java.lang.Object>	broadcast(java.lang.Object msg, jakarta.servlet.http.HttpSession s)	session will be exclude for this broadcast
java.util.concurrent.Future<java.lang.Object>	broadcast(java.lang.Object msg, java.util.List<jakarta.servlet.http.HttpSession> sessions)	a list of sessions will be exclude for this broadcast
java.util.concurrent.Future<java.lang.Object>	broadcast(java.lang.Object msg, java.util.Set<AtmosphereResource> subset)	the AtmosphereResources subset will be exclude for this broadcast
java.util.concurrent.Future<java.lang.Object>	broadcast(java.lang.Object msg, AtmosphereResource r)	the AtmosphereResource r will be exclude for this broadcast
Broadcaster	initialize(java.lang.String id, AtmosphereConfig config)

Methods inherited from class org.atmosphere.cpr.DefaultBroadcaster

addAtmosphereResource, addBroadcasterLifeCyclePolicyListener, addBroadcasterListener, awaitAndBroadcast, broadcast, 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, getBroadcastHandler, getID, getScope, initialize, invokeOnStateChange, 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

ExcludeSessionBroadcaster

public ExcludeSessionBroadcaster()

Method Detail

initialize

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

Overrides:

initialize in class DefaultBroadcaster

broadcast

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

the AtmosphereResource r will be exclude for this broadcast

Specified by:

broadcast in interface Broadcaster

Overrides:

broadcast in class DefaultBroadcaster

Parameters:

msg -

r -

Returns:

broadcast

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

the AtmosphereResources subset will be exclude for this broadcast

Specified by:

broadcast in interface Broadcaster

Overrides:

broadcast in class DefaultBroadcaster

Parameters:

msg -

subset -

Returns:

broadcast

public java.util.concurrent.Future<java.lang.Object> broadcast(java.lang.Object msg,
                                                               java.util.List<jakarta.servlet.http.HttpSession> sessions)

a list of sessions will be exclude for this broadcast

Parameters:

msg -

sessions -

Returns:

broadcast

public java.util.concurrent.Future<java.lang.Object> broadcast(java.lang.Object msg,
                                                               jakarta.servlet.http.HttpSession s)

session will be exclude for this broadcast

Parameters:

msg -

s -

Returns: