org.red5.server.scope
public class BroadcastScope extends BasicScope implements IBroadcastScope, IPipeConnectionListener
Modifier and Type | Field and Description |
---|---|
protected Lock |
lock
Lock for critical sections, to prevent concurrent modification.
|
keepDelay, keepOnDisconnect, listeners, name, parent, persistenceClass, persistent, store, type
Constructor and Description |
---|
BroadcastScope(IScope parent,
String name)
Creates broadcast scope
|
Modifier and Type | Method and Description |
---|---|
void |
addPipeConnectionListener(IPipeConnectionListener listener)
Register pipe connection event listener with this scope's pipe.
|
IClientBroadcastStream |
getClientBroadcastStream()
Returns the client broadcast stream
|
List<IConsumer> |
getConsumers()
Getter for pipe consumers
|
List<IProvider> |
getProviders()
Getter for providers list
|
void |
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
|
void |
setClientBroadcastStream(IClientBroadcastStream clientBroadcastStream)
Sets the client broadcast stream
|
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() |
boolean |
unsubscribe(IConsumer consumer)
Disconnects scope's pipe from given consumer
|
boolean |
unsubscribe(IProvider provider)
Disconnects scope's pipe from given provider
|
addEventListener, dispatchEvent, equals, getDepth, getEventListeners, getName, getParent, getPath, getStore, getType, handleEvent, hasEventListeners, hashCode, hasParent, isValid, notifyEvent, removeEventListener, setKeepDelay
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
getDepth, getName, getParent, getPath, getStore, getType, hasParent, isValid, setKeepDelay
dispatchEvent
handleEvent
notifyEvent
addEventListener, getEventListeners, removeEventListener
protected Lock lock
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
- TimeoutIMessage
public boolean subscribe(IConsumer consumer, Map<String,Object> paramMap)
subscribe
in interface IMessageInput
consumer
- ConsumerparamMap
- Parameters passed with connectiontrue
on success, false
otherwisepublic boolean unsubscribe(IConsumer consumer)
unsubscribe
in interface IMessageInput
consumer
- Consumertrue
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 connectiontrue
on success, false
otherwisepublic boolean unsubscribe(IProvider provider)
unsubscribe
in interface IMessageOutput
provider
- Providertrue
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()
public void unlock()
public IClientBroadcastStream getClientBroadcastStream()
getClientBroadcastStream
in interface IBroadcastScope
public void setClientBroadcastStream(IClientBroadcastStream clientBroadcastStream)
setClientBroadcastStream
in interface IBroadcastScope
clientBroadcastStream
- Copyright © 2006-2012 The Red5 Project