mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 08:41:16 +00:00
76 lines
22 KiB
HTML
76 lines
22 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.13"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>FairMQ: fairmq/EventManager.h Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">FairMQ
|
|
 <span id="projectnumber">1.4.14</span>
|
|
</div>
|
|
<div id="projectbrief">C++ Message Queuing Library and Framework</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_d6b28f7731906a8cbc4171450df4b180.html">fairmq</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">EventManager.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/********************************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (C) 2014-2017 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH *</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * *</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * This software is distributed under the terms of the *</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * GNU Lesser General Public Licence (LGPL) version 3, *</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * copied verbatim in the file "LICENSE" *</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> ********************************************************************************/</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> </div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#ifndef FAIR_MQ_EVENTMANAGER_H</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#define FAIR_MQ_EVENTMANAGER_H</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> </div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <mutex></span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <typeindex></span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <unordered_map></span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <utility></span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include <functional></span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <boost/any.hpp></span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <boost/functional/hash.hpp></span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <boost/signals2.hpp></span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">namespace </span><a class="code" href="namespacefair.html">fair</a></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> {</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">namespace </span>mq</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> {</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">// Inherit from this base event type to create custom event types</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">template</span><<span class="keyword">typename</span> K></div><div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="structfair_1_1mq_1_1Event.html"> 31</a></span> <span class="keyword">struct </span><a class="code" href="structfair_1_1mq_1_1Event.html">Event</a></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keyword">using</span> KeyType = K;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> };</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> </div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1EventManager.html"> 51</a></span> <span class="keyword">class </span><a class="code" href="classfair_1_1mq_1_1EventManager.html">EventManager</a></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> {</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="comment">// Clang 3.4-3.8 has a bug and cannot properly deal with the following template alias.</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="comment">// Therefore, we leave them here commented out for now.</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="comment">// template<typename E, typename ...Args></span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="comment">// using Callback = std::function<void(typename E::KeyType, Args...)>;</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">template</span><<span class="keyword">typename</span> E, <span class="keyword">typename</span> ...Args></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">using</span> Signal = boost::signals2::signal<void(<span class="keyword">typename</span> E::KeyType, Args...)>;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">template</span><<span class="keyword">typename</span> E, <span class="keyword">typename</span> ...Args></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">auto</span> Subscribe(<span class="keyword">const</span> std::string& subscriber, std::function<<span class="keywordtype">void</span>(<span class="keyword">typename</span> E::KeyType, Args...)> callback) -> <span class="keywordtype">void</span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  {</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">const</span> std::type_index event_type_index{<span class="keyword">typeid</span>(E)};</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keyword">const</span> std::type_index callback_type_index{<span class="keyword">typeid</span>(std::function<void(<span class="keyword">typename</span> E::KeyType, Args...)>)};</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keyword">const</span> <span class="keyword">auto</span> signalsKey = std::make_pair(event_type_index, callback_type_index);</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keyword">const</span> <span class="keyword">auto</span> connectionsKey = std::make_pair(subscriber, signalsKey);</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">const</span> <span class="keyword">auto</span> connection = GetSignal<E, Args...>(signalsKey)->connect(callback);</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  {</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  std::lock_guard<std::mutex> lock{fMutex};</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordflow">if</span> (fConnections.find(connectionsKey) != fConnections.end())</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  {</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  fConnections.at(connectionsKey).disconnect();</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  fConnections.erase(connectionsKey);</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  }</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  fConnections.insert({connectionsKey, connection});</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  }</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  }</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keyword">template</span><<span class="keyword">typename</span> E, <span class="keyword">typename</span> ...Args></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">auto</span> Unsubscribe(<span class="keyword">const</span> std::string& subscriber) -> <span class="keywordtype">void</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  {</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keyword">const</span> std::type_index event_type_index{<span class="keyword">typeid</span>(E)};</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keyword">const</span> std::type_index callback_type_index{<span class="keyword">typeid</span>(std::function<void(<span class="keyword">typename</span> E::KeyType, Args...)>)};</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keyword">const</span> <span class="keyword">auto</span> signalsKey = std::make_pair(event_type_index, callback_type_index);</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keyword">const</span> <span class="keyword">auto</span> connectionsKey = std::make_pair(subscriber, signalsKey);</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  std::lock_guard<std::mutex> lock{fMutex};</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  fConnections.at(connectionsKey).disconnect();</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  fConnections.erase(connectionsKey);</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  }</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keyword">template</span><<span class="keyword">typename</span> E, <span class="keyword">typename</span> ...Args></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keyword">auto</span> Emit(<span class="keyword">typename</span> E::KeyType key, Args... args) <span class="keyword">const</span> -> <span class="keywordtype">void</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  {</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keyword">const</span> std::type_index event_type_index{<span class="keyword">typeid</span>(E)};</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keyword">const</span> std::type_index callback_type_index{<span class="keyword">typeid</span>(std::function<void(<span class="keyword">typename</span> E::KeyType, Args...)>)};</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keyword">const</span> <span class="keyword">auto</span> signalsKey = std::make_pair(event_type_index, callback_type_index);</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  (*GetSignal<E, Args...>(signalsKey))(key, std::forward<Args>(args)...);</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  }</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> </div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keyword">using</span> SignalsKey = std::pair<std::type_index, std::type_index>;</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="comment">// event , callback</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keyword">using</span> SignalsValue = boost::any;</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  <span class="keyword">using</span> SignalsMap = std::unordered_map<SignalsKey, SignalsValue, boost::hash<SignalsKey>>;</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keyword">mutable</span> SignalsMap fSignals;</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> </div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  <span class="keyword">using</span> ConnectionsKey = std::pair<std::string, SignalsKey>;</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="comment">// subscriber , event/callback</span></div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keyword">using</span> ConnectionsValue = boost::signals2::connection;</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keyword">using</span> ConnectionsMap = std::unordered_map<ConnectionsKey, ConnectionsValue, boost::hash<ConnectionsKey>>;</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  ConnectionsMap fConnections;</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keyword">mutable</span> std::mutex fMutex;</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> </div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keyword">template</span><<span class="keyword">typename</span> E, <span class="keyword">typename</span> ...Args></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keyword">auto</span> GetSignal(<span class="keyword">const</span> SignalsKey& key) <span class="keyword">const</span> -> std::shared_ptr<Signal<E, Args...>></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  {</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  std::lock_guard<std::mutex> lock{fMutex};</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span> </div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keywordflow">if</span> (fSignals.find(key) == fSignals.end())</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  {</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  <span class="comment">// wrapper is needed because boost::signals2::signal is neither copyable nor movable</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  <span class="comment">// and I don't know how else to insert it into the map</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keyword">auto</span> signal = std::make_shared<Signal<E, Args...>>();</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  fSignals.insert(std::make_pair(key, signal));</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  }</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> </div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="keywordflow">return</span> boost::any_cast<std::shared_ptr<Signal<E, Args...>>>(fSignals.at(key));</div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  }</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> }; <span class="comment">/* class EventManager */</span></div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> </div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> } <span class="comment">/* namespace mq */</span></div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> } <span class="comment">/* namespace fair */</span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> </div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="preprocessor">#endif </span><span class="comment">/* FAIR_MQ_EVENTMANAGER_H */</span><span class="preprocessor"></span></div><div class="ttc" id="structfair_1_1mq_1_1Event_html"><div class="ttname"><a href="structfair_1_1mq_1_1Event.html">fair::mq::Event</a></div><div class="ttdef"><b>Definition:</b> EventManager.h:31</div></div>
|
|
<div class="ttc" id="classfair_1_1mq_1_1EventManager_html"><div class="ttname"><a href="classfair_1_1mq_1_1EventManager.html">fair::mq::EventManager</a></div><div class="ttdoc">Manages event callbacks from different subscribers. </div><div class="ttdef"><b>Definition:</b> EventManager.h:51</div></div>
|
|
<div class="ttc" id="namespacefair_html"><div class="ttname"><a href="namespacefair.html">fair</a></div><div class="ttdoc">Tools for interfacing containers to the transport via polymorphic allocators. </div><div class="ttdef"><b>Definition:</b> DeviceRunner.h:23</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<p style="margin: 0 12px 10px 12px;"><a href="https://help.github.com/articles/github-privacy-statement/">privacy</a></p>
|