ug4
message_hub_impl.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2011-2015: G-CSC, Goethe University Frankfurt
3  * Author: Sebastian Reiter
4  *
5  * This file is part of UG4.
6  *
7  * UG4 is free software: you can redistribute it and/or modify it under the
8  * terms of the GNU Lesser General Public License version 3 (as published by the
9  * Free Software Foundation) with the following additional attribution
10  * requirements (according to LGPL/GPL v3 §7):
11  *
12  * (1) The following notice must be displayed in the Appropriate Legal Notices
13  * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
14  *
15  * (2) The following notice must be displayed at a prominent place in the
16  * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
17  *
18  * (3) The following bibliography is recommended for citation and must be
19  * preserved in all covered files:
20  * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
21  * parallel geometric multigrid solver on hierarchically distributed grids.
22  * Computing and visualization in science 16, 4 (2013), 151-164"
23  * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
24  * flexible software system for simulating pde based models on high performance
25  * computers. Computing and visualization in science 16, 4 (2013), 165-179"
26  *
27  * This program is distributed in the hope that it will be useful,
28  * but WITHOUT ANY WARRANTY; without even the implied warranty of
29  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
30  * GNU Lesser General Public License for more details.
31  */
32 
33 #ifndef __H__UG__message_hub_impl__
34 #define __H__UG__message_hub_impl__
35 
36 namespace ug
37 {
38 
39 
40 template <class TMsg>
42 register_function_callback(void (*callback)(const TMsg&),
43  bool autoFree)
44 {
45  typedef void (*FuncCallback)(const IMessage&);
46 
47  return register_callback_impl<TMsg>((FuncCallback)callback, autoFree);
48 }
49 
50 
51 template <class TMsg, class TClass>
53 register_class_callback(TClass* cls,
54  void (TClass::*callback)(const TMsg&),
55  bool autoFree)
56 {
57  typedef void (TClass::*ClassCallback)(const IMessage&);
58 
59  return register_callback_impl<TMsg>(
60  boost::bind((ClassCallback)callback, cls, _1),
61  autoFree);
62 }
63 
64 
65 template <class TMsg>
67 post_message(const TMsg& msg)
68 {
69 
70  size_t id = GetUniqueTypeID<TMsg>();
71 // call the callbacks
72  CallbackEntryList& callbacks = m_callbackMap[id];
73  for(CallbackEntryList::iterator iter = callbacks.begin();
74  iter != callbacks.end(); ++iter)
75  {
76  iter->m_callback(msg);
77  }
78 }
79 
80 
81 template <class TMsg>
83 register_callback_impl(boost::function<void (const IMessage&)> callback,
84  bool autoFree)
85 {
86  size_t id = GetUniqueTypeID<TMsg>();
87  CallbackEntryList& callbacks = m_callbackMap[id];
88  CallbackEntryIterator cbIter = callbacks.insert(callbacks.end(),
89  CallbackEntry(callback, NULL));
90 
91  CallbackId* cbId = new CallbackId(this, id, cbIter, autoFree);
92 
93  cbIter->m_callbackId = cbId;
94 
95  return SPCallbackId(cbId);
96 }
97 
98 
99 }// end of namespace
100 
101 #endif
The callback-id allows to deregister previously registered callbacks.
Definition: message_hub.h:148
This is the base class of all messages, which may be passed to callbacks.
Definition: message_hub.h:133
CallbackEntryList::iterator CallbackEntryIterator
Definition: message_hub.h:103
CallbackMap m_callbackMap
given a msg-type-id, this map returns a list of associated callbacks
Definition: message_hub.h:246
std::list< CallbackEntry > CallbackEntryList
Definition: message_hub.h:102
void post_message(const TMsg &msg)
Posts a message to all callbacks which are registered for the given message tpye.
Definition: message_hub_impl.hpp:67
SPCallbackId register_callback_impl(boost::function< void(const IMessage &)> callback, bool autoFree)
registers a callback given a message-id.
Definition: message_hub_impl.hpp:83
SmartPtr< CallbackId > SPCallbackId
Definition: message_hub.h:166
SPCallbackId register_class_callback(TClass *cls, void(TClass::*callback)(const TMsg &), bool autoFree=true)
registers a method callback given a message-type.
Definition: message_hub_impl.hpp:53
SPCallbackId register_function_callback(void(*callback)(const TMsg &), bool autoFree=false)
registers a function callback given a message-type.
Definition: message_hub_impl.hpp:42
the ug namespace
The CallbackEntry holds the actual callback and the associated callback-id.
Definition: message_hub.h:96