messageForwarder.h

Engine/source/util/messaging/messageForwarder.h

More...

Classes:

Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Copyright (c) 2012 GarageGames, LLC
 4//
 5// Permission is hereby granted, free of charge, to any person obtaining a copy
 6// of this software and associated documentation files (the "Software"), to
 7// deal in the Software without restriction, including without limitation the
 8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22//-----------------------------------------------------------------------------
23
24#include "console/simBase.h"
25#include "util/messaging/dispatcher.h"
26#include "util/messaging/scriptMsgListener.h"
27
28#ifndef _MESSAGEFORWARDER_H_
29#define _MESSAGEFORWARDER_H_
30
31/// @addtogroup msgsys Message System
32// @{
33
34//-----------------------------------------------------------------------------
35/// @brief Forward messages from one queue to another
36/// 
37/// MessageForwarder is a script class that can be used to forward messages
38/// from one queue to another.
39///
40/// <h2>Example</h2>
41///
42/// @code
43/// %fwd = new MessageForwarder()
44/// {
45///    toQueue = "QueueToSendTo";
46/// };
47///
48/// registerMessageListener("FromQueue", %fwd);
49/// @endcode
50///
51/// Where "QueueToSendTo" is the queue you want to forward to, and
52/// "FromQueue" is the queue you want to forward from.
53///
54//-----------------------------------------------------------------------------
55class MessageForwarder : public ScriptMsgListener
56{
57   typedef ScriptMsgListener Parent;
58
59protected:
60   StringTableEntry mToQueue;
61
62public:
63   MessageForwarder();
64   virtual ~MessageForwarder();
65   DECLARE_CONOBJECT(MessageForwarder);
66
67   static void initPersistFields();
68
69   virtual bool onMessageReceived(StringTableEntry queue, const char *event, const char *data);
70   virtual bool onMessageObjectReceived(StringTableEntry queue, Message *msg);
71};
72
73// @}
74
75#endif // _MESSAGEFORWARDER_H_
76