MessageForwarder Class Reference [Message System]

#include <messageForwarder.h>

Inheritance diagram for MessageForwarder:

Inheritance graph
[legend]
List of all members.

Detailed Description

Forward messages from one queue to another.

MessageForwarder is a script class that can be used to forward messages from one queue to another.

Example

 %fwd = new MessageForwarder()
 {
    toQueue = "QueueToSendTo";
 };

 registerMessageListener("FromQueue", %fwd);

Where "QueueToSendTo" is the queue you want to forward to, and "FromQueue" is the queue you want to forward from.


Public Member Functions

 MessageForwarder ()
virtual ~MessageForwarder ()
 DECLARE_CONOBJECT (MessageForwarder)
virtual bool onMessageReceived (StringTableEntry queue, const char *event, const char *data)
 Callback for when messages are received.
virtual bool onMessageObjectReceived (StringTableEntry queue, Message *msg)
 Callback for when message objects are received.

Static Public Member Functions

static void initPersistFields ()
 Register dynamic fields in a subclass of ConsoleObject.

Protected Attributes

StringTableEntry mToQueue

Private Types

typedef ScriptMsgListener Parent


Member Typedef Documentation

Reimplemented from ScriptMsgListener.


Constructor & Destructor Documentation

MessageForwarder::MessageForwarder (  ) 

virtual MessageForwarder::~MessageForwarder (  )  [virtual]


Member Function Documentation

MessageForwarder::DECLARE_CONOBJECT ( MessageForwarder   ) 

static void MessageForwarder::initPersistFields (  )  [static]

Register dynamic fields in a subclass of ConsoleObject.

See also:
addField(), addFieldV(), addDeprecatedField(), addGroup(), endGroup()

Reimplemented from SimObject.

virtual bool MessageForwarder::onMessageReceived ( StringTableEntry  queue,
const char *  event,
const char *  data 
) [virtual]

Callback for when messages are received.

Parameters:
queue The name of the queue the message was dispatched to
msg The type of message
data The data for the message
Returns:
false to prevent other listeners receiving this message, true otherwise
See also:
onMessageObjectReceived()

Reimplemented from ScriptMsgListener.

virtual bool MessageForwarder::onMessageObjectReceived ( StringTableEntry  queue,
Message msg 
) [virtual]

Callback for when message objects are received.

Parameters:
queue The name of the queue the message was dispatched to
msg The message object
Returns:
false to prevent other listeners receiving this message, true otherwise
See also:
onMessageReceived()

Reimplemented from ScriptMsgListener.


Member Data Documentation