message_hub.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011-2015:  G-CSC, Goethe University Frankfurt
 * Author: Sebastian Reiter
 * 
 * This file is part of UG4.
 * 
 * UG4 is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 3 (as published by the
 * Free Software Foundation) with the following additional attribution
 * requirements (according to LGPL/GPL v3 §7):
 * 
 * (1) The following notice must be displayed in the Appropriate Legal Notices
 * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (2) The following notice must be displayed at a prominent place in the
 * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (3) The following bibliography is recommended for citation and must be
 * preserved in all covered files:
 * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
 *   parallel geometric multigrid solver on hierarchically distributed grids.
 *   Computing and visualization in science 16, 4 (2013), 151-164"
 * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
 *   flexible software system for simulating pde based models on high performance
 *   computers. Computing and visualization in science 16, 4 (2013), 165-179"
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 */
 
#ifndef __H__UG__message_hub__
#define __H__UG__message_hub__
 
#include <vector>
#include <list>
#include <string>
#include <map>
#include <functional> // for std::function
 
#include "common/assert.h"
#include "common/util/smart_pointer.h"
#include "common/util/metaprogramming_util.h"
#include "common/error.h"
#include "common/log.h"
 
namespace ug
{
 
 
class MessageHub;
typedef SmartPtr<MessageHub> SPMessageHub;
 
 
class MessageHub
{
  public:
  //  predeclarations
    class IMessage;
    class CallbackId;
 
  private:
  //  private type definitions
    typedef std::function<void (const IMessage&)> Callback;
 
 
    struct CallbackEntry{
      CallbackEntry(const Callback& cb, CallbackId* cbId);
      Callback  m_callback;
      CallbackId* m_callbackId;
    };
 
    typedef std::list<CallbackEntry>  CallbackEntryList;
    typedef CallbackEntryList::iterator CallbackEntryIterator;
    typedef std::map<size_t, CallbackEntryList> CallbackMap;
 
  public:
    enum ErrorIds{
      MSG_HUB_UNKNOWN_ERROR,
      MSG_HUB_TYPE_MISMATCH,
      MSG_HUB_BAD_MESSAGE_ID,
      MSG_HUB_BAD_CALLBACK_ID
    };
 
 
    class Error : public UGError
    {
      public:
        Error(const char* msg, ErrorIds errorId) :
          UGError(msg), m_errorId(errorId) {}
 
        ErrorIds get_message_hub_error_id() {return m_errorId;}
 
      protected:
        ErrorIds m_errorId;
    };
 
    class IMessage{
      public:
        IMessage()  {}
        virtual ~IMessage() {}
    };
 
 
    class CallbackId{
      friend class MessageHub;
 
      public:
        ~CallbackId();
        void set_auto_free(bool autoFree) {m_autoFree = autoFree;}
 
      private:
        CallbackId(MessageHub* hub, size_t msgTypeId,
               CallbackEntryIterator callbackEntryIter, bool autoFree);
 
        MessageHub*       m_hub;
        size_t          m_msgTypeId;
        CallbackEntryIterator m_callbackEntryIter;
        bool          m_autoFree;
    };
 
    typedef SmartPtr<CallbackId>  SPCallbackId;
 
  public:
    MessageHub();
    ~MessageHub();
 
 
    template <class TMsg>
    SPCallbackId register_function_callback(void (*callback)(const TMsg&),
                         bool autoFree = false);
 
 
    template <class TMsg, class TClass>
    SPCallbackId register_class_callback(TClass* cls,
                       void (TClass::*callback)(const TMsg&),
                       bool autoFree = true);
 
 
    void unregister_callback(SPCallbackId cbId);
 
    template <class TMsg>
    void post_message(const TMsg& msg);
 
  private:
 
    template <class TMsg>
    SPCallbackId register_callback_impl(
                 std::function<void (const IMessage&)> callback,
                 bool autoFree);
 
    void unregister_callback_impl(CallbackId* cbId);
 
  private:
    CallbackMap m_callbackMap;
};
 
// end group ugbase_common_util
 
}// end of namespace
 
 
//  include implementation
#include "message_hub_impl.hpp"
 
#endif