Dogcows Code - chaz/yoink/blob - src/Moof/Dispatcher.hh

   1
   2 /*******************************************************************************
   3
   4  Copyright (c) 2009, Charles McGarvey
   5  All rights reserved.
   6
   7  Redistribution   and   use  in  source  and  binary  forms,  with  or  without
   8  modification, are permitted provided that the following conditions are met:
   9
  10    * Redistributions  of  source  code  must retain the above copyright notice,
  11      this list of conditions and the following disclaimer.
  12    * Redistributions  in binary form must reproduce the above copyright notice,
  13      this  list of conditions and the following disclaimer in the documentation
  14      and/or other materials provided with the distribution.
  15
  16  THIS  SOFTWARE  IS  PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  17  AND  ANY  EXPRESS  OR  IMPLIED  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  DISCLAIMED.  IN  NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  20  FOR  ANY  DIRECT,  INDIRECT,  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  DAMAGES  (INCLUDING,  BUT  NOT  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  22  SERVICES;  LOSS  OF  USE,  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  23  CAUSED  AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  24  OR  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  25  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26
  27 *******************************************************************************/
  28
  29 #ifndef _MOOF_DISPATCHER_HH_
  30 #define _MOOF_DISPATCHER_HH_
  31
  32 #include <string>
  33
  34 #include <boost/function.hpp>
  35 #include <boost/shared_ptr.hpp>
  36
  37
  38 namespace Mf {
  39
  40
  41 /**
  42  * Interface for a notification class.
  43  */
  44
  45 class Notification
  46 {
  47 public:
  48         virtual ~Notification();
  49 };
  50
  51
  52 /**
  53  * Dispatcher of notifications to interested parties.
  54  */
  55
  56 class Dispatcher
  57 {
  58         class Impl;
  59         boost::shared_ptr<Impl> impl_;
  60
  61 public:
  62
  63         typedef void* Handler;
  64         typedef boost::function<void(const Notification*)> Function;
  65
  66         Dispatcher();
  67         ~Dispatcher();
  68
  69         // get global instance
  70         static Dispatcher& getInstance();
  71
  72         Handler addHandler(const std::string& message, const Function& callback);
  73         Handler addHandler(const std::string& message, const Function& callback,
  74                         Handler id);
  75
  76         void removeHandler(Handler id);
  77
  78         void dispatch(const std::string& message, const Notification* param = 0);
  79 };
  80
  81
  82 namespace dispatcher {
  83
  84 inline Dispatcher::Handler addHandler(const std::string& message,
  85                 const Dispatcher::Function& callback)
  86 {
  87         return Dispatcher::getInstance().addHandler(message, callback);
  88 }
  89
  90 inline Dispatcher::Handler addHandler(const std::string& message,
  91                 const Dispatcher::Function& callback, Dispatcher::Handler id)
  92 {
  93         return Dispatcher::getInstance().addHandler(message, callback, id);
  94 }
  95
  96 inline void removeHandler(Dispatcher::Handler id)
  97 {
  98         Dispatcher::getInstance().removeHandler(id);
  99 }
 100
 101 inline void dispatch(const std::string& message, const Notification* param = 0)
 102 {
 103         Dispatcher::getInstance().dispatch(message, param);
 104 }
 105
 106 } // namespace dispatch
 107
 108 } // namespace Mf
 109
 110 #endif // _MOOF_DISPATCHER_HH_
 111
 112 /** vim: set ts=4 sw=4 tw=80: *************************************************/
 113