|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.red5.server.messaging.AbstractPipe
public abstract class AbstractPipe
Abstract pipe that books providers/consumers and listeners. Aim to ease the implementation of concrete pipes. For more information on what pipe is, see IPipe interface documentation.
IPipe| Field Summary | |
|---|---|
protected List<IConsumer> |
consumers
Pipe consumers list |
protected List<IPipeConnectionListener> |
listeners
Event listeners |
protected List<IProvider> |
providers
Pipe providers list |
| Constructor Summary | |
|---|---|
AbstractPipe()
|
|
| Method Summary | |
|---|---|
void |
addPipeConnectionListener(IPipeConnectionListener listener)
Registers pipe connect events listener |
protected void |
fireConsumerConnectionEvent(IConsumer consumer,
int type,
Map<?,?> paramMap)
Broadcast consumer connection event |
protected void |
firePipeConnectionEvent(PipeConnectionEvent event)
Fire any pipe connection event and run all it's tasks |
protected void |
fireProviderConnectionEvent(IProvider provider,
int type,
Map<?,?> paramMap)
Broadcast provider connection event |
List<IConsumer> |
getConsumers()
Getter for consumers |
List<IPipeConnectionListener> |
getListeners()
Getter for pipe connection events listeners |
List<IProvider> |
getProviders()
Getter for providers |
void |
removePipeConnectionListener(IPipeConnectionListener listener)
Removes pipe connection listener |
void |
sendOOBControlMessage(IConsumer consumer,
OOBControlMessage oobCtrlMsg)
Send out-of-band ("special") control message to all providers |
void |
sendOOBControlMessage(IProvider provider,
OOBControlMessage oobCtrlMsg)
Send out-of-band ("special") control message to all consumers |
void |
setListeners(List<IPipeConnectionListener> listeners)
Setter for pipe connection events listeners |
boolean |
subscribe(IConsumer consumer,
Map<?,?> paramMap)
Connect consumer to this pipe. |
boolean |
subscribe(IProvider provider,
Map<?,?> paramMap)
Connect provider to this pipe. |
boolean |
unsubscribe(IConsumer consumer)
Disconnects consumer from this pipe. |
boolean |
unsubscribe(IProvider provider)
Disconnects provider from this pipe. |
| 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.messaging.IMessageInput |
|---|
pullMessage, pullMessage |
| Methods inherited from interface org.red5.server.messaging.IMessageOutput |
|---|
pushMessage |
| Field Detail |
|---|
protected volatile List<IConsumer> consumers
protected volatile List<IProvider> providers
protected volatile List<IPipeConnectionListener> listeners
| Constructor Detail |
|---|
public AbstractPipe()
| Method Detail |
|---|
public boolean subscribe(IConsumer consumer,
Map<?,?> paramMap)
subscribe in interface IMessageInputconsumer - ConsumerparamMap - Parameters passed with connection, used in concrete pipe implementations
true if consumer was added, false otherwise
public boolean subscribe(IProvider provider,
Map<?,?> paramMap)
subscribe in interface IMessageOutputprovider - ProviderparamMap - Parameters passed with connection, used in concrete pipe implementations
true if provider was added, false otherwisepublic boolean unsubscribe(IProvider provider)
unsubscribe in interface IMessageOutputprovider - Provider that should be removed
true on success, false otherwisepublic boolean unsubscribe(IConsumer consumer)
unsubscribe in interface IMessageInputconsumer - Consumer that should be removed
true on success, false otherwisepublic void addPipeConnectionListener(IPipeConnectionListener listener)
addPipeConnectionListener in interface IPipelistener - Listenerpublic void removePipeConnectionListener(IPipeConnectionListener listener)
removePipeConnectionListener in interface IPipelistener - Listener
public void sendOOBControlMessage(IProvider provider,
OOBControlMessage oobCtrlMsg)
sendOOBControlMessage in interface IMessageOutputprovider - Provider, may be used in concrete implementationsoobCtrlMsg - Out-of-band control message
public void sendOOBControlMessage(IConsumer consumer,
OOBControlMessage oobCtrlMsg)
sendOOBControlMessage in interface IMessageInputconsumer - Consumer, may be used in concrete implementationsoobCtrlMsg - Out-of-band control messagepublic List<IPipeConnectionListener> getListeners()
public void setListeners(List<IPipeConnectionListener> listeners)
listeners - Listenerspublic List<IProvider> getProviders()
getProviders in interface IMessageOutputpublic List<IConsumer> getConsumers()
getConsumers in interface IMessageInput
protected void fireConsumerConnectionEvent(IConsumer consumer,
int type,
Map<?,?> paramMap)
consumer - Consumer that has connectedtype - Event typeparamMap - Parameters passed with connection
protected void fireProviderConnectionEvent(IProvider provider,
int type,
Map<?,?> paramMap)
provider - Provider that has connectedtype - Event typeparamMap - Parameters passed with connectionprotected void firePipeConnectionEvent(PipeConnectionEvent event)
event - Pipe connection event
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||