org.ocd.msgbus
Class MsgBusTopic

java.lang.Object
  |
  +--org.ocd.msgbus.MsgBusTopic

public class MsgBusTopic

extends java.lang.Object

MsgBusTopic Description:

Constructor Summary

MsgBusTopic(java.lang.String pFullName)

MsgBusTopic(java.lang.String pParentName, java.lang.String pName)

Method Summary

void	addListener(IMsgBusListener pListener)
boolean	containsListener(IMsgBusListener pListener) Return true if this Topic contains the specified Listener
MsgBusMessage	fire(MsgBusMessage pEvent, IMsgBusListener pResultListener, boolean pUniCast) Fires a Message to all of this Topics Listeners If the pResultListener is not null then it will have a result posted to it The source of the message will also have the result posted to it.
IMsgBusListener[]	getListeners() Returns a copy of the Listeners for this Topic
java.lang.String	getName()
void	removeListener(IMsgBusListener pListener)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MsgBusTopic

public MsgBusTopic(java.lang.String pFullName)

MsgBusTopic

public MsgBusTopic(java.lang.String pParentName,
                   java.lang.String pName)

Method Detail

addListener

public void addListener(IMsgBusListener pListener)

removeListener

public void removeListener(IMsgBusListener pListener)

containsListener

public boolean containsListener(IMsgBusListener pListener)

Return true if this Topic contains the specified Listener

getListeners

public IMsgBusListener[] getListeners()

Returns a copy of the Listeners for this Topic

Returns:

vector of listeners

getName

public java.lang.String getName()

fire

public MsgBusMessage fire(MsgBusMessage pEvent,
                          IMsgBusListener pResultListener,
                          boolean pUniCast)

Fires a Message to all of this Topics Listeners If the pResultListener is not null then it will have a result posted to it The source of the message will also have the result posted to it.

Parameters:

Message - to fire to listeners

Listener - to recieve the result from any listeners

pUniCast - is true if only first Listener should be notified.

Returns:

result for any calling methods that want a synchronize return.