Files
rtabmap/preview/pr-1492/api/latest/UEventsManager_8h_source.html
T

311 lines
40 KiB
HTML

<!-- HTML header for doxygen 1.9.8-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>RTAB-Map: utilite/include/rtabmap/utilite/UEventsManager.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" />
<script type="text/javascript">window.RTABMAP_DOC_ROOT="";</script>
<script type="text/javascript" src="../versions.js"></script>
<script type="text/javascript" src="version-switcher.js"></script>
</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 id="projectrow">
<td id="projectalign">
<div id="projectname">RTAB-Map<span id="projectnumber">&#160;0.23.10</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_7c77c469ef71e5893c1567cf621a9d83.html">utilite</a></li><li class="navelem"><a class="el" href="dir_5807fd1f37f21884b665e4f5337b2441.html">include</a></li><li class="navelem"><a class="el" href="dir_d5b9494e18cb3ada3ef427a965bb34ab.html">rtabmap</a></li><li class="navelem"><a class="el" href="dir_85e098119c0e838040cd00f42e29c3c2.html">utilite</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">UEventsManager.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">* utilite is a cross-platform library with</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">* useful utilities for fast and small developing.</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment">* Copyright (C) 2010 Mathieu Labbe</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment">*</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment">* utilite is free library: you can redistribute it and/or modify</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment">* it under the terms of the GNU Lesser General Public License as published by</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment">* the Free Software Foundation, either version 3 of the License, or</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment">* (at your option) any later version.</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment">*</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment">* utilite is distributed in the hope that it will be useful,</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment">* but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment">* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment">* GNU Lesser General Public License for more details.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment">*</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment">* You should have received a copy of the GNU Lesser General Public License</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">* along with this program. If not, see &lt;http://www.gnu.org/licenses/&gt;.</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">*/</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#ifndef UEVENTSMANAGER_H</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#define UEVENTSMANAGER_H</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include &quot;rtabmap/utilite/utilite_export.h&quot;</span> <span class="comment">// DLL export/import defines</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include &quot;rtabmap/utilite/UEventsHandler.h&quot;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include &quot;rtabmap/utilite/UThreadNode.h&quot;</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include &quot;<a class="code" href="ULogger_8h.html">rtabmap/utilite/ULogger.h</a>&quot;</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include &quot;rtabmap/utilite/UDestroyer.h&quot;</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#include &lt;list&gt;</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="preprocessor">#include &lt;map&gt;</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="comment">// TODO Not implemented... for multithreading event handling</span></div>
<div class="foldopen" id="foldopen00034" data-start="{" data-end="};">
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="classUEventDispatcher.html"> 34</a></span><span class="keyword">class </span><a class="code hl_class" href="classUEventDispatcher.html">UEventDispatcher</a> : <span class="keyword">public</span> <a class="code hl_class" href="classUThread.html">UThread</a></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span>{</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">virtual</span> <a class="code hl_class" href="classUEventDispatcher.html">~UEventDispatcher</a>();</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="keyword">protected</span>:</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code hl_class" href="classUEventsManager.html">UEventsManager</a>;</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <a class="code hl_class" href="classUEventDispatcher.html">UEventDispatcher</a>();</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="classUEventDispatcher.html#ad1aa4dc2ee29a9bfe5ee0422ad1c97f0"> 42</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classUEventDispatcher.html#ad1aa4dc2ee29a9bfe5ee0422ad1c97f0">mainLoop</a>();</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> killCleanup();</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <a class="code hl_class" href="classUEvent.html">UEvent</a> * _event;</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> std::vector&lt;UEventsHandler*&gt; _handlers;</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span>};</div>
</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="foldopen" id="foldopen00078" data-start="{" data-end="};">
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"><a class="line" href="classUEventsManager.html"> 78</a></span><span class="keyword">class </span>UTILITE_EXPORT <a class="code hl_class" href="classUEventsManager.html">UEventsManager</a> : <span class="keyword">public</span> <a class="code hl_class" href="classUThread.html">UThread</a>{</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> </div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> </div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"><a class="line" href="classUEventsManager.html#a3bb033062e4a0eb59efdf5f84d170388"> 88</a></span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classUEventsManager.html#a3bb033062e4a0eb59efdf5f84d170388">addHandler</a>(<a class="code hl_class" href="classUEventsHandler.html">UEventsHandler</a>* handler);</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> </div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"><a class="line" href="classUEventsManager.html#a10d4b359f630aa9387e77f8baefcc07c"> 96</a></span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classUEventsManager.html#a10d4b359f630aa9387e77f8baefcc07c">removeHandler</a>(<a class="code hl_class" href="classUEventsHandler.html">UEventsHandler</a>* handler);</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> </div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"><a class="line" href="classUEventsManager.html#a956353a8006abe2edb0be2e1fc1846cb"> 110</a></span> <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classUEventsManager.html#a956353a8006abe2edb0be2e1fc1846cb">post</a>(<a class="code hl_class" href="classUEvent.html">UEvent</a> * event, <span class="keywordtype">bool</span> async = <span class="keyword">true</span>, <span class="keyword">const</span> <a class="code hl_class" href="classUEventsSender.html">UEventsSender</a> * sender = 0);</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> </div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> <span class="keyword">static</span> <span class="keywordtype">void</span> createPipe(</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> <span class="keyword">const</span> <a class="code hl_class" href="classUEventsSender.html">UEventsSender</a> * sender,</div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> <span class="keyword">const</span> <a class="code hl_class" href="classUEventsHandler.html">UEventsHandler</a> * receiver,</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> <span class="keyword">const</span> std::string &amp; eventName);</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> </div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> <span class="keyword">static</span> <span class="keywordtype">void</span> removePipe(</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> <span class="keyword">const</span> <a class="code hl_class" href="classUEventsSender.html">UEventsSender</a> * sender,</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> <span class="keyword">const</span> <a class="code hl_class" href="classUEventsHandler.html">UEventsHandler</a> * receiver,</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> <span class="keyword">const</span> std::string &amp; eventName);</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> </div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> <span class="keyword">static</span> <span class="keywordtype">void</span> removeAllPipes(<span class="keyword">const</span> <a class="code hl_class" href="classUEventsSender.html">UEventsSender</a> * sender);</div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> <span class="keyword">static</span> <span class="keywordtype">void</span> removeNullPipes(<span class="keyword">const</span> <a class="code hl_class" href="classUEventsSender.html">UEventsSender</a> * sender);</div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> </div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span><span class="keyword">protected</span>:</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> </div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> <span class="comment">/*</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span><span class="comment"> * This method is used to have a reference on the </span></div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span><span class="comment"> * EventsManager. When no EventsManager exists, one is </span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span><span class="comment"> * created. There is only one instance in the application.</span></div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span><span class="comment"> * See the Singleton pattern further explanation.</span></div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span><span class="comment"> *</span></div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span><span class="comment"> * @return the reference on the EventsManager</span></div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span><span class="comment"> */</span></div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> <span class="keyword">static</span> <a class="code hl_class" href="classUEventsManager.html">UEventsManager</a>* getInstance();</div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> </div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> <span class="comment">/*</span></div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span><span class="comment"> * Called only once in getInstance(). It can&#39;t be instantiated</span></div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span><span class="comment"> * by the user.</span></div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span><span class="comment"> *</span></div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span><span class="comment"> */</span></div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span> <a class="code hl_class" href="classUEventsManager.html">UEventsManager</a>();</div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span> </div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span> <span class="comment">/*</span></div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span><span class="comment"> * Only called by a Destroyer.</span></div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span><span class="comment"> */</span></div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span> <span class="keyword">virtual</span> <a class="code hl_class" href="classUEventsManager.html">~UEventsManager</a>();</div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span> </div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span> <span class="comment">/*</span></div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span><span class="comment"> * A Destroyer is used to remove a dynamically created</span></div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span><span class="comment"> * Singleton. It is friend here to have access to the </span></div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span><span class="comment"> * destructor.</span></div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span><span class="comment"> *</span></div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span><span class="comment"> */</span></div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code hl_class" href="classUDestroyer.html">UDestroyer</a>&lt;<a class="code hl_class" href="classUEventsManager.html">UEventsManager</a>&gt;;</div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"> 156</span> </div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno"><a class="line" href="classUEventsManager.html#a7eec8b7a675e7093064f147a9f62bfb9"> 160</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classUEventsManager.html#a7eec8b7a675e7093064f147a9f62bfb9">mainLoop</a>();</div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno"> 161</span> </div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno"> 162</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno"> 163</span> </div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno"> 167</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> mainLoopKill();</div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno"> 168</span> </div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno"> 169</span> <span class="comment">/*</span></div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno"> 170</span><span class="comment"> * This method dispatches asynchronized events to all handlers.</span></div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno"> 171</span><span class="comment"> * FIFO (first in first out) dispatching is used.</span></div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno"> 172</span><span class="comment"> */</span></div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno"> 173</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> dispatchEvents();</div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno"> 174</span> </div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno"> 175</span> <span class="comment">/*</span></div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno"> 176</span><span class="comment"> * This method dispatches an event to all handlers.</span></div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno"> 177</span><span class="comment"> */</span></div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno"> 178</span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> dispatchEvent(<a class="code hl_class" href="classUEvent.html">UEvent</a> * event, <span class="keyword">const</span> <a class="code hl_class" href="classUEventsSender.html">UEventsSender</a> * sender);</div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno"> 179</span> </div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno"> 180</span> <span class="comment">/*</span></div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno"> 181</span><span class="comment"> * This method is used to add an events </span></div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno"> 182</span><span class="comment"> * handler to the list of handlers.</span></div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno"> 183</span><span class="comment"> *</span></div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno"> 184</span><span class="comment"> * @param handler the handler to be added.</span></div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno"> 185</span><span class="comment"> */</span></div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno"> 186</span> <span class="keywordtype">void</span> _addHandler(<a class="code hl_class" href="classUEventsHandler.html">UEventsHandler</a>* handler);</div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno"> 187</span> </div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno"> 188</span> <span class="comment">/*</span></div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno"> 189</span><span class="comment"> * This method is used to remove an events </span></div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno"> 190</span><span class="comment"> * handler from the list of handlers.</span></div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno"> 191</span><span class="comment"> *</span></div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno"> 192</span><span class="comment"> * @param handler the handler to be removed.</span></div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno"> 193</span><span class="comment"> */</span></div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno"> 194</span> <span class="keywordtype">void</span> _removeHandler(<a class="code hl_class" href="classUEventsHandler.html">UEventsHandler</a>* handler);</div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno"> 195</span> </div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno"> 196</span> <span class="comment">/*</span></div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno"> 197</span><span class="comment"> * This method is used to post an event to</span></div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno"> 198</span><span class="comment"> * handlers.</span></div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno"> 199</span><span class="comment"> *</span></div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno"> 200</span><span class="comment"> * Event can be posted asynchronously or not. In the first case,</span></div>
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno"> 201</span><span class="comment"> * the event is dispatched by the UEventsManager&#39;s thread. In the</span></div>
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno"> 202</span><span class="comment"> * second case, the event is handled immediately by event&#39;s</span></div>
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno"> 203</span><span class="comment"> * receivers, thus in the sender thread.</span></div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno"> 204</span><span class="comment"> *</span></div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno"> 205</span><span class="comment"> * @param event the event to be posted.</span></div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno"> 206</span><span class="comment"> * @param async if true, the event is dispatched by the UEventsManager thread, otherwise it&#39;s in the caller thread (synchronous).</span></div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno"> 207</span><span class="comment"> */</span></div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno"> 208</span> <span class="keywordtype">void</span> _postEvent(<a class="code hl_class" href="classUEvent.html">UEvent</a> * event, <span class="keywordtype">bool</span> async = <span class="keyword">true</span>, <span class="keyword">const</span> <a class="code hl_class" href="classUEventsSender.html">UEventsSender</a> * sender = 0);</div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno"> 209</span> </div>
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno"> 210</span> std::list&lt;UEventsHandler*&gt; getPipes(</div>
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno"> 211</span> <span class="keyword">const</span> <a class="code hl_class" href="classUEventsSender.html">UEventsSender</a> * sender,</div>
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno"> 212</span> <span class="keyword">const</span> std::string &amp; eventName);</div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno"> 213</span> </div>
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno"> 214</span> <span class="keywordtype">void</span> _createPipe(</div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno"> 215</span> <span class="keyword">const</span> <a class="code hl_class" href="classUEventsSender.html">UEventsSender</a> * sender,</div>
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno"> 216</span> <span class="keyword">const</span> <a class="code hl_class" href="classUEventsHandler.html">UEventsHandler</a> * receiver,</div>
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno"> 217</span> <span class="keyword">const</span> std::string &amp; eventName);</div>
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno"> 218</span> </div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno"> 219</span> <span class="keywordtype">void</span> _removePipe(</div>
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno"> 220</span> <span class="keyword">const</span> <a class="code hl_class" href="classUEventsSender.html">UEventsSender</a> * sender,</div>
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno"> 221</span> <span class="keyword">const</span> <a class="code hl_class" href="classUEventsHandler.html">UEventsHandler</a> * receiver,</div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno"> 222</span> <span class="keyword">const</span> std::string &amp; eventName);</div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno"> 223</span> </div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno"> 224</span> <span class="keywordtype">void</span> _removeAllPipes(<span class="keyword">const</span> <a class="code hl_class" href="classUEventsSender.html">UEventsSender</a> * sender);</div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno"> 225</span> <span class="keywordtype">void</span> _removeNullPipes(<span class="keyword">const</span> <a class="code hl_class" href="classUEventsSender.html">UEventsSender</a> * sender);</div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno"> 226</span> </div>
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno"> 227</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno"> 228</span> </div>
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno"> 229</span> <span class="keyword">class </span>Pipe</div>
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno"> 230</span> {</div>
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno"> 231</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno"> 232</span> Pipe(<span class="keyword">const</span> <a class="code hl_class" href="classUEventsSender.html">UEventsSender</a> * sender, <span class="keyword">const</span> <a class="code hl_class" href="classUEventsHandler.html">UEventsHandler</a> * receiver, <span class="keyword">const</span> std::string &amp; eventName) :</div>
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno"> 233</span> sender_(sender),</div>
<div class="line"><a id="l00234" name="l00234"></a><span class="lineno"> 234</span> receiver_(receiver),</div>
<div class="line"><a id="l00235" name="l00235"></a><span class="lineno"> 235</span> eventName_(eventName)</div>
<div class="line"><a id="l00236" name="l00236"></a><span class="lineno"> 236</span> {}</div>
<div class="line"><a id="l00237" name="l00237"></a><span class="lineno"> 237</span> <span class="keyword">const</span> <a class="code hl_class" href="classUEventsSender.html">UEventsSender</a> * sender_;</div>
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno"> 238</span> <span class="keyword">const</span> <a class="code hl_class" href="classUEventsHandler.html">UEventsHandler</a> * receiver_;</div>
<div class="line"><a id="l00239" name="l00239"></a><span class="lineno"> 239</span> <span class="keyword">const</span> std::string eventName_;</div>
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno"> 240</span> };</div>
<div class="line"><a id="l00241" name="l00241"></a><span class="lineno"> 241</span> </div>
<div class="line"><a id="l00242" name="l00242"></a><span class="lineno"> 242</span> <span class="keyword">static</span> <a class="code hl_class" href="classUEventsManager.html">UEventsManager</a>* instance_; <span class="comment">/* The EventsManager instance pointer. */</span></div>
<div class="line"><a id="l00243" name="l00243"></a><span class="lineno"> 243</span> <span class="keyword">static</span> <a class="code hl_class" href="classUDestroyer.html">UDestroyer&lt;UEventsManager&gt;</a> destroyer_; <span class="comment">/* The EventsManager&#39;s destroyer. */</span></div>
<div class="line"><a id="l00244" name="l00244"></a><span class="lineno"> 244</span> std::list&lt;std::pair&lt;UEvent*, const UEventsSender * &gt; &gt; events_; <span class="comment">/* The events list. */</span></div>
<div class="line"><a id="l00245" name="l00245"></a><span class="lineno"> 245</span> std::list&lt;UEventsHandler*&gt; handlers_; <span class="comment">/* The handlers list. */</span></div>
<div class="line"><a id="l00246" name="l00246"></a><span class="lineno"> 246</span> <a class="code hl_class" href="classUMutex.html">UMutex</a> eventsMutex_; <span class="comment">/* The mutex of the events list, */</span></div>
<div class="line"><a id="l00247" name="l00247"></a><span class="lineno"> 247</span> <a class="code hl_class" href="classUMutex.html">UMutex</a> handlersMutex_; <span class="comment">/* The mutex of the handlers list. */</span></div>
<div class="line"><a id="l00248" name="l00248"></a><span class="lineno"> 248</span> <a class="code hl_class" href="classUSemaphore.html">USemaphore</a> postEventSem_; <span class="comment">/* Semaphore used to signal when an events is posted. */</span></div>
<div class="line"><a id="l00249" name="l00249"></a><span class="lineno"> 249</span> std::list&lt;Pipe&gt; pipes_;</div>
<div class="line"><a id="l00250" name="l00250"></a><span class="lineno"> 250</span> <a class="code hl_class" href="classUMutex.html">UMutex</a> pipesMutex_;</div>
<div class="line"><a id="l00251" name="l00251"></a><span class="lineno"> 251</span>};</div>
</div>
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno"> 252</span> </div>
<div class="line"><a id="l00253" name="l00253"></a><span class="lineno"> 253</span><span class="preprocessor">#endif </span><span class="comment">// UEVENTSMANAGER_H</span></div>
<div class="ttc" id="aULogger_8h_html"><div class="ttname"><a href="ULogger_8h.html">ULogger.h</a></div><div class="ttdoc">ULogger class and convenient macros.</div></div>
<div class="ttc" id="aclassUDestroyer_html"><div class="ttname"><a href="classUDestroyer.html">UDestroyer</a></div><div class="ttdef"><b>Definition</b> <a href="UDestroyer_8h_source.html#l00032">UDestroyer.h:33</a></div></div>
<div class="ttc" id="aclassUEventDispatcher_html"><div class="ttname"><a href="classUEventDispatcher.html">UEventDispatcher</a></div><div class="ttdef"><b>Definition</b> <a href="UEventsManager_8h_source.html#l00034">UEventsManager.h:35</a></div></div>
<div class="ttc" id="aclassUEventDispatcher_html_ad1aa4dc2ee29a9bfe5ee0422ad1c97f0"><div class="ttname"><a href="classUEventDispatcher.html#ad1aa4dc2ee29a9bfe5ee0422ad1c97f0">UEventDispatcher::mainLoop</a></div><div class="ttdeci">virtual void mainLoop()</div></div>
<div class="ttc" id="aclassUEvent_html"><div class="ttname"><a href="classUEvent.html">UEvent</a></div><div class="ttdef"><b>Definition</b> <a href="UEvent_8h_source.html#l00057">UEvent.h:57</a></div></div>
<div class="ttc" id="aclassUEventsHandler_html"><div class="ttname"><a href="classUEventsHandler.html">UEventsHandler</a></div><div class="ttdef"><b>Definition</b> <a href="UEventsHandler_8h_source.html#l00128">UEventsHandler.h:128</a></div></div>
<div class="ttc" id="aclassUEventsManager_html"><div class="ttname"><a href="classUEventsManager.html">UEventsManager</a></div><div class="ttdef"><b>Definition</b> <a href="UEventsManager_8h_source.html#l00078">UEventsManager.h:78</a></div></div>
<div class="ttc" id="aclassUEventsManager_html_a10d4b359f630aa9387e77f8baefcc07c"><div class="ttname"><a href="classUEventsManager.html#a10d4b359f630aa9387e77f8baefcc07c">UEventsManager::removeHandler</a></div><div class="ttdeci">static void removeHandler(UEventsHandler *handler)</div></div>
<div class="ttc" id="aclassUEventsManager_html_a3bb033062e4a0eb59efdf5f84d170388"><div class="ttname"><a href="classUEventsManager.html#a3bb033062e4a0eb59efdf5f84d170388">UEventsManager::addHandler</a></div><div class="ttdeci">static void addHandler(UEventsHandler *handler)</div></div>
<div class="ttc" id="aclassUEventsManager_html_a7eec8b7a675e7093064f147a9f62bfb9"><div class="ttname"><a href="classUEventsManager.html#a7eec8b7a675e7093064f147a9f62bfb9">UEventsManager::mainLoop</a></div><div class="ttdeci">virtual void mainLoop()</div></div>
<div class="ttc" id="aclassUEventsManager_html_a956353a8006abe2edb0be2e1fc1846cb"><div class="ttname"><a href="classUEventsManager.html#a956353a8006abe2edb0be2e1fc1846cb">UEventsManager::post</a></div><div class="ttdeci">static void post(UEvent *event, bool async=true, const UEventsSender *sender=0)</div></div>
<div class="ttc" id="aclassUEventsSender_html"><div class="ttname"><a href="classUEventsSender.html">UEventsSender</a></div><div class="ttdef"><b>Definition</b> <a href="UEventsSender_8h_source.html#l00015">UEventsSender.h:16</a></div></div>
<div class="ttc" id="aclassUMutex_html"><div class="ttname"><a href="classUMutex.html">UMutex</a></div><div class="ttdef"><b>Definition</b> <a href="UMutex_8h_source.html#l00054">UMutex.h:55</a></div></div>
<div class="ttc" id="aclassUSemaphore_html"><div class="ttname"><a href="classUSemaphore.html">USemaphore</a></div><div class="ttdef"><b>Definition</b> <a href="USemaphore_8h_source.html#l00055">USemaphore.h:56</a></div></div>
<div class="ttc" id="aclassUThread_html"><div class="ttname"><a href="classUThread.html">UThread</a></div><div class="ttdef"><b>Definition</b> <a href="UThread_8h_source.html#l00086">UThread.h:87</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>