ug4
Loading...
Searching...
No Matches
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// #include <boost/bind.hpp> // for boost::bind
37
38namespace ug
39{
40
41
42template <class TMsg>
44register_function_callback(void (*callback)(const TMsg&),
45 bool autoFree)
46{
47 typedef void (*FuncCallback)(const IMessage&);
48
49 return register_callback_impl<TMsg>((FuncCallback)callback, autoFree);
50}
51
52
53template <class TMsg, class TClass>
55register_class_callback(TClass* cls,
56 void (TClass::*callback)(const TMsg&),
57 bool autoFree)
58{
59 typedef void (TClass::*ClassCallback)(const IMessage&);
60
61 return register_callback_impl<TMsg>(
62 //boost::bind((ClassCallback)callback, cls, _1),
63 [callback, cls](const IMessage& msg) {
64 auto const& derived = static_cast<const TMsg&>(msg);
65 (cls->*callback)(derived);
66 },
67 autoFree);
68}
69
70
71template <class TMsg>
73post_message(const TMsg& msg)
74{
75
76 size_t id = GetUniqueTypeID<TMsg>();
77// call the callbacks
78 CallbackEntryList& callbacks = m_callbackMap[id];
79 for(CallbackEntryList::iterator iter = callbacks.begin();
80 iter != callbacks.end(); ++iter)
81 {
82 iter->m_callback(msg);
83 }
84}
85
86
87template <class TMsg>
89register_callback_impl(std::function<void (const IMessage&)> callback,
90 bool autoFree)
91{
92 size_t id = GetUniqueTypeID<TMsg>();
93 CallbackEntryList& callbacks = m_callbackMap[id];
94 CallbackEntryIterator cbIter = callbacks.insert(callbacks.end(),
95 CallbackEntry(callback, NULL));
96
97 CallbackId* cbId = new CallbackId(this, id, cbIter, autoFree);
98
99 cbIter->m_callbackId = cbId;
100
101 return SPCallbackId(cbId);
102}
103
104
105}// end of namespace
106
107#endif
The callback-id allows to deregister previously registered callbacks.
Definition message_hub.h:147
This is the base class of all messages, which may be passed to callbacks.
Definition message_hub.h:132
SPCallbackId register_callback_impl(std::function< void(const IMessage &)> callback, bool autoFree)
registers a callback given a message-id.
Definition message_hub_impl.hpp:89
CallbackEntryList::iterator CallbackEntryIterator
Definition message_hub.h:102
CallbackMap m_callbackMap
given a msg-type-id, this map returns a list of associated callbacks
Definition message_hub.h:245
std::list< CallbackEntry > CallbackEntryList
Definition message_hub.h:101
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:73
SmartPtr< CallbackId > SPCallbackId
Definition message_hub.h:165
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:55
SPCallbackId register_function_callback(void(*callback)(const TMsg &), bool autoFree=false)
registers a function callback given a message-type.
Definition message_hub_impl.hpp:44
the ug namespace
The CallbackEntry holds the actual callback and the associated callback-id.
Definition message_hub.h:95