org.mini2Dx.minibus.handler

Class MessageForwarder

java.lang.Object

org.mini2Dx.minibus.handler.MessageForwarder

All Implemented Interfaces:

MessageHandler

Direct Known Subclasses:

AllowAllMessageForwarder

public abstract class MessageForwarder
extends java.lang.Object
implements MessageHandler

Common class for implementing a MessageHandler that receives MessageDatas and forwards them to one or more MessageExchanges.

Constructor Summary

Constructors

Constructor and Description
MessageForwarder(MessageExchange... receivers) Constructor

Method Summary

Modifier and Type	Method and Description
abstract boolean	forward(MessageData messageData) Called when a MessageData is received
void	onMessageReceived(java.lang.String messageType, MessageExchange source, MessageExchange receiver, MessageData messageData) Called when a message is received

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageForwarder

public MessageForwarder(MessageExchange... receivers)

Constructor

Parameters:

receivers - The MessageExchanges to forward MessageDatas to

Method Detail

onMessageReceived

public void onMessageReceived(java.lang.String messageType,
                              MessageExchange source,
                              MessageExchange receiver,
                              MessageData messageData)

Description copied from interface: MessageHandler

Called when a message is received

Specified by:

onMessageReceived in interface MessageHandler

Parameters:

messageType - The string representing the message type

source - The MessageExchange that sent the message

receiver - The MessageExchange that received the message

messageData - The MessageData that was received if any (i.e. possibly null)

forward

public abstract boolean forward(MessageData messageData)

Called when a MessageData is received

Parameters:

messageData - The MessageData that was received

Returns:

True if the MessageData should be forwarded