|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.red5.server.AttributeStore
org.red5.server.PersistableAttributeStore
org.red5.server.BasicScope
org.red5.server.stream.BroadcastScope
public class BroadcastScope
Scope type for publishing that deals with pipe connection events, like async message listening in JMS
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.red5.server.BasicScope |
---|
BasicScope.EmptyBasicScopeIterator |
Field Summary | |
---|---|
protected Lock |
lock
Lock for critical sections, to prevent concurrent modification. |
Fields inherited from class org.red5.server.BasicScope |
---|
keepDelay, keepOnDisconnect, listeners, parent, persistenceClass |
Fields inherited from class org.red5.server.PersistableAttributeStore |
---|
lastModified, name, path, persistent, store, type |
Fields inherited from class org.red5.server.AttributeStore |
---|
attributes |
Fields inherited from interface org.red5.server.stream.IBroadcastScope |
---|
STREAM_ATTRIBUTE, TYPE |
Fields inherited from interface org.red5.server.api.persistence.IPersistable |
---|
TRANSIENT_PREFIX |
Constructor Summary | |
---|---|
BroadcastScope(IScope parent,
String name)
Creates broadcast scope |
Method Summary | |
---|---|
void |
addPipeConnectionListener(IPipeConnectionListener listener)
Register pipe connection event listener with this scope's pipe. |
List<IConsumer> |
getConsumers()
Getter for pipe consumers |
List<IProvider> |
getProviders()
Getter for providers list |
void |
lock()
Lock handling - attempts to obtain a lock |
void |
onPipeConnectionEvent(PipeConnectionEvent event)
Pipe connection event handler |
IMessage |
pullMessage()
Pull message from pipe |
IMessage |
pullMessage(long wait)
Pull message with timeout |
void |
pushMessage(IMessage message)
Push a message to this output endpoint. |
void |
removePipeConnectionListener(IPipeConnectionListener listener)
Unregisters pipe connection event listener with this scope's pipe |
void |
sendOOBControlMessage(IConsumer consumer,
OOBControlMessage oobCtrlMsg)
Send out-of-band ("special") control message |
void |
sendOOBControlMessage(IProvider provider,
OOBControlMessage oobCtrlMsg)
Send out-of-band ("special") control message |
boolean |
subscribe(IConsumer consumer,
Map<String,Object> paramMap)
Connect scope's pipe to given consumer |
boolean |
subscribe(IProvider provider,
Map<String,Object> paramMap)
Connect scope's pipe with given provider |
void |
unlock()
Lock handling - attempts to unlock a lock |
boolean |
unsubscribe(IConsumer consumer)
Disconnects scope's pipe from given consumer |
boolean |
unsubscribe(IProvider provider)
Disconnects scope's pipe from given provider |
Methods inherited from class org.red5.server.BasicScope |
---|
addEventListener, dispatchEvent, getDepth, getEventListeners, getParent, getPath, handleEvent, hasEventListeners, hasParent, iterator, notifyEvent, removeEventListener, setKeepDelay |
Methods inherited from class org.red5.server.PersistableAttributeStore |
---|
deserialize, getAttribute, getLastModified, getName, getStore, getType, isPersistent, modified, removeAttribute, removeAttributes, serialize, setAttribute, setAttributes, setAttributes, setName, setPath, setPersistent, setStore |
Methods inherited from class org.red5.server.AttributeStore |
---|
filterNull, getAttribute, getAttributeNames, getAttributes, getBoolAttribute, getByteAttribute, getDoubleAttribute, getIntAttribute, getListAttribute, getLongAttribute, getMapAttribute, getSetAttribute, getShortAttribute, getStringAttribute, hasAttribute |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.red5.server.api.IBasicScope |
---|
getDepth, getName, getParent, getPath, getType, hasParent, setKeepDelay |
Methods inherited from interface org.red5.server.api.ICastingAttributeStore |
---|
getBoolAttribute, getByteAttribute, getDoubleAttribute, getIntAttribute, getListAttribute, getLongAttribute, getMapAttribute, getSetAttribute, getShortAttribute, getStringAttribute |
Methods inherited from interface org.red5.server.api.IAttributeStore |
---|
getAttribute, getAttribute, getAttributeNames, getAttributes, hasAttribute, removeAttribute, removeAttributes, setAttribute, setAttributes, setAttributes |
Methods inherited from interface org.red5.server.api.event.IEventDispatcher |
---|
dispatchEvent |
Methods inherited from interface org.red5.server.api.event.IEventHandler |
---|
handleEvent |
Methods inherited from interface org.red5.server.api.event.IEventListener |
---|
notifyEvent |
Methods inherited from interface org.red5.server.api.event.IEventObservable |
---|
addEventListener, getEventListeners, removeEventListener |
Methods inherited from interface java.lang.Iterable |
---|
iterator |
Methods inherited from interface org.red5.server.api.persistence.IPersistable |
---|
deserialize, getLastModified, getStore, isPersistent, serialize, setName, setPath, setPersistent, setStore |
Field Detail |
---|
protected Lock lock
Constructor Detail |
---|
public BroadcastScope(IScope parent, String name)
parent
- Parent scopename
- Scope nameMethod Detail |
---|
public void addPipeConnectionListener(IPipeConnectionListener listener)
addPipeConnectionListener
in interface IPipe
listener
- Pipe connection event listenerIPipeConnectionListener
public void removePipeConnectionListener(IPipeConnectionListener listener)
removePipeConnectionListener
in interface IPipe
listener
- Pipe connection event listenerIPipeConnectionListener
public IMessage pullMessage()
pullMessage
in interface IMessageInput
IMessage
public IMessage pullMessage(long wait)
pullMessage
in interface IMessageInput
wait
- Timeout
IMessage
public boolean subscribe(IConsumer consumer, Map<String,Object> paramMap)
subscribe
in interface IMessageInput
consumer
- ConsumerparamMap
- Parameters passed with connection
true
on success, false
otherwisepublic boolean unsubscribe(IConsumer consumer)
unsubscribe
in interface IMessageInput
consumer
- Consumer
true
on success, false
otherwisepublic List<IConsumer> getConsumers()
getConsumers
in interface IMessageInput
public void sendOOBControlMessage(IConsumer consumer, OOBControlMessage oobCtrlMsg)
sendOOBControlMessage
in interface IMessageInput
consumer
- Consumer, may be used in concrete implementationsoobCtrlMsg
- Out-of-band control messagepublic void pushMessage(IMessage message) throws IOException
pushMessage
in interface IMessageOutput
message
- Message to be pushed.
IOException
- If message could not be pushed.public boolean subscribe(IProvider provider, Map<String,Object> paramMap)
subscribe
in interface IMessageOutput
provider
- ProviderparamMap
- Parameters passed on connection
true
on success, false
otherwisepublic boolean unsubscribe(IProvider provider)
unsubscribe
in interface IMessageOutput
provider
- Provider
true
on success, false
otherwisepublic List<IProvider> getProviders()
getProviders
in interface IMessageOutput
public void sendOOBControlMessage(IProvider provider, OOBControlMessage oobCtrlMsg)
sendOOBControlMessage
in interface IMessageOutput
provider
- Provider, may be used in concrete implementationsoobCtrlMsg
- Out-of-band control messagepublic void onPipeConnectionEvent(PipeConnectionEvent event)
onPipeConnectionEvent
in interface IPipeConnectionListener
event
- Pipe connection eventpublic void lock()
IBasicScope
lock
in interface IBasicScope
public void unlock()
IBasicScope
unlock
in interface IBasicScope
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |