public interface BroadcasterFactory
Broadcaster
used by Atmosphere when creating broadcasters.Modifier and Type | Interface and Description |
---|---|
static class |
BroadcasterFactory.BroadcasterCreationException |
Modifier and Type | Method and Description |
---|---|
boolean |
add(Broadcaster b,
Object id)
Add a
Broadcaster to the list. |
BroadcasterFactory |
addBroadcasterListener(BroadcasterListener b)
Add a
BroadcasterListener |
Collection<BroadcasterListener> |
broadcasterListeners()
Return all
BroadcasterListener |
void |
configure(Class<? extends Broadcaster> clazz,
String broadcasterLifeCyclePolicy,
AtmosphereConfig c)
Configure the factory
|
void |
destroy()
Shutdown all
Broadcaster s. |
Broadcaster |
get()
Return an instance of the default
Broadcaster . |
<T extends Broadcaster> |
get(Class<T> c,
Object id)
Create a new instance of
Broadcaster and store it for. |
Broadcaster |
get(Object id)
Create a new instance of
Broadcaster and store it for. |
<T extends Broadcaster> |
lookup(Class<T> c,
Object id)
Lookup a
Broadcaster instance using Broadcaster.getID() or ID |
<T extends Broadcaster> |
lookup(Class<T> c,
Object id,
boolean createIfNull)
Lookup a
Broadcaster instance using Broadcaster.getID() or ID |
<T extends Broadcaster> |
lookup(Object id)
Lookup a
Broadcaster instance using Broadcaster.getID() or ID |
<T extends Broadcaster> |
lookup(Object id,
boolean createIfNull)
Lookup a
Broadcaster instance using Broadcaster.getID() or ID |
Collection<Broadcaster> |
lookupAll()
Return an immutable Collection of
Broadcaster this factory contains. |
boolean |
remove(Broadcaster b,
Object id)
Remove a
Broadcaster from the list. |
boolean |
remove(Object id)
Remove the associated
Broadcaster . |
void |
removeAllAtmosphereResource(AtmosphereResource r)
Deprecated.
|
BroadcasterFactory |
removeBroadcasterListener(BroadcasterListener b)
Remove a
BroadcasterListener |
void configure(Class<? extends Broadcaster> clazz, String broadcasterLifeCyclePolicy, AtmosphereConfig c)
clazz
- Broadcaster
broadcasterLifeCyclePolicy
- BroadcasterLifeCyclePolicy
c
- AtmosphereConfig
Broadcaster get()
Broadcaster
.
The name of the Broadcaster will be randomly generated.Broadcaster
IllegalAccessException
InstantiationException
Broadcaster get(Object id)
Broadcaster
and store it for.id
- The unique ID used to retrieve Broadcaster
Broadcaster
<T extends Broadcaster> T get(Class<T> c, Object id)
Broadcaster
and store it for.c
- The Broadcaster
class instance.id
- The unique ID used to retrieve Broadcaster
Broadcaster
void destroy()
Broadcaster
s.boolean add(Broadcaster b, Object id)
Broadcaster
to the list.b
- a Broadcaster
Broadcaster
was already storedboolean remove(Broadcaster b, Object id)
Broadcaster
from the list.b
- a Broadcaster
id
- the ID
Broadcaster
<T extends Broadcaster> T lookup(Class<T> c, Object id)
Broadcaster
instance using Broadcaster.getID()
or IDc
- id
- The Broadcaster's unique ID, or name.<T extends Broadcaster> T lookup(Class<T> c, Object id, boolean createIfNull)
Broadcaster
instance using Broadcaster.getID()
or IDc
- id
- The Broadcaster's unique ID, or name.createIfNull
- If the broadcaster is not found, create it.<T extends Broadcaster> T lookup(Object id)
Broadcaster
instance using Broadcaster.getID()
or IDid
- The Broadcaster's unique ID, or name.<T extends Broadcaster> T lookup(Object id, boolean createIfNull)
Broadcaster
instance using Broadcaster.getID()
or IDid
- The Broadcaster's unique ID, or name.createIfNull
- If the broadcaster is not found, create it.@Deprecated void removeAllAtmosphereResource(AtmosphereResource r)
AtmosphereResource
from all registered Broadcaster
s.r
- an void AtmosphereResource
boolean remove(Object id)
Broadcaster
.Collection<Broadcaster> lookupAll()
Broadcaster
this factory contains.Broadcaster
this factory contains.BroadcasterFactory addBroadcasterListener(BroadcasterListener b)
BroadcasterListener
b
- a BroadcasterListener
BroadcasterFactory removeBroadcasterListener(BroadcasterListener b)
BroadcasterListener
b
- a BroadcasterListener
Collection<BroadcasterListener> broadcasterListeners()
BroadcasterListener
BroadcasterListener
Copyright © 2016. All rights reserved.