net.sourceforge.mflow.api
Interface MsgSource

All Superinterfaces:

Configurable, Iconable, MsgFlowComponent

All Known Subinterfaces:

MsgFilter, SendFolder

All Known Implementing Classes:

AbstractMsgFilter, AbstractMsgSource

public interface MsgSource

extends MsgFlowComponent

Interface to represent an object that produces Msg's

Version:

$Revision: 1.3 $

Author:

David Carr

Method Summary

void	addReceiver(MsgReceiver receiver) Adds a MsgReceiver to receive any Msg's that this MsgSource produces
MsgReceiver[]	getReceivers() Accessor for all of the MsgReceivers currently receiving Msg's from this MsgSource
void	removeReceiver(MsgReceiver receiver) Removes a MsgReceiver from receiving Msg's from this MsgSource
void	send() Method to request that the MsgSource send any queued Msg's to its receivers.
void	setReceivers(MsgReceiver[] receivers) Mutator for all of the MsgReceivers to receive Msg's from this MsgSource

Methods inherited from interface net.sourceforge.mflow.api.MsgFlowComponent

getName, setName

Methods inherited from interface net.sourceforge.mflow.api.Configurable

configure

Methods inherited from interface net.sourceforge.mflow.api.Iconable

getIcon

Method Detail

addReceiver

void addReceiver(MsgReceiver receiver)

Adds a MsgReceiver to receive any Msg's that this MsgSource produces

Parameters:

receiver - the receiver to add

removeReceiver

void removeReceiver(MsgReceiver receiver)

Removes a MsgReceiver from receiving Msg's from this MsgSource

Parameters:

receiver - the receiver to remove

setReceivers

void setReceivers(MsgReceiver[] receivers)

Mutator for all of the MsgReceivers to receive Msg's from this MsgSource

Parameters:

receivers - the array of new MsgReceivers

getReceivers

MsgReceiver[] getReceivers()

Accessor for all of the MsgReceivers currently receiving Msg's from this MsgSource

Returns:

the array of MsgReceivers currently receiving Msg's from this MsgSource

send

void send()

Method to request that the MsgSource send any queued Msg's to its receivers. An MsgSource is not obligated to wait to send its Msg's; It is up to the MsgSource to determine whether to send them as soon as they are created or to wait for a send().