mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 16:46:47 +00:00
89 lines
15 KiB
HTML
89 lines
15 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/DeviceRunner.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.2.1</span>
|
|
</div>
|
|
<div id="projectbrief">C++ Message Passing 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">DeviceRunner.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) 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_DEVICERUNNER_H</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#define FAIR_MQ_DEVICERUNNER_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 <fairmq/EventManager.h></span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <fairmq/PluginManager.h></span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <FairMQDevice.h></span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <FairMQLogger.h></span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <options/FairMQProgOptions.h></span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</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> <span class="preprocessor">#include <memory></span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <vector></span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div><div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="namespacefair.html"> 23</a></span> <span class="keyword">namespace </span><a class="code" href="namespacefair.html">fair</a></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> {</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">namespace </span>mq</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> {</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1DeviceRunner.html"> 51</a></span> <span class="keyword">class </span><a class="code" href="classfair_1_1mq_1_1DeviceRunner.html">DeviceRunner</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>  <a class="code" href="classfair_1_1mq_1_1DeviceRunner.html">DeviceRunner</a>(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span>* <span class="keyword">const</span> argv[]);</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">auto</span> Run() -> int;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">auto</span> RunWithExceptionHandlers() -> int;</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> H></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">auto</span> AddHook(std::function<<span class="keywordtype">void</span>(<a class="code" href="classfair_1_1mq_1_1DeviceRunner.html">DeviceRunner</a>&)> hook) -> <span class="keywordtype">void</span> { fEvents.Subscribe<H>(<span class="stringliteral">"runner"</span>, hook); }</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">template</span><<span class="keyword">typename</span> H></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">auto</span> RemoveHook() -> <span class="keywordtype">void</span> { fEvents.Unsubscribe<H>(<span class="stringliteral">"runner"</span>); }</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  std::vector<std::string> fRawCmdLineArgs;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  std::shared_ptr<PluginManager> fPluginManager;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <a class="code" href="classFairMQProgOptions.html">FairMQProgOptions</a> fConfig;</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  std::shared_ptr<FairMQDevice> fDevice;</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <a class="code" href="classfair_1_1mq_1_1EventManager.html">EventManager</a> fEvents;</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> <span class="keyword">namespace </span>hooks</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> {</div><div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="structfair_1_1mq_1_1hooks_1_1LoadPlugins.html"> 75</a></span> <span class="keyword">struct </span><a class="code" href="structfair_1_1mq_1_1hooks_1_1LoadPlugins.html">LoadPlugins</a> : <a class="code" href="structfair_1_1mq_1_1Event.html">Event</a><DeviceRunner&> {};</div><div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="structfair_1_1mq_1_1hooks_1_1SetCustomCmdLineOptions.html"> 76</a></span> <span class="keyword">struct </span><a class="code" href="structfair_1_1mq_1_1hooks_1_1SetCustomCmdLineOptions.html">SetCustomCmdLineOptions</a> : <a class="code" href="structfair_1_1mq_1_1Event.html">Event</a><DeviceRunner&> {};</div><div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="structfair_1_1mq_1_1hooks_1_1ModifyRawCmdLineArgs.html"> 77</a></span> <span class="keyword">struct </span><a class="code" href="structfair_1_1mq_1_1hooks_1_1ModifyRawCmdLineArgs.html">ModifyRawCmdLineArgs</a> : <a class="code" href="structfair_1_1mq_1_1Event.html">Event</a><DeviceRunner&> {};</div><div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="structfair_1_1mq_1_1hooks_1_1InstantiateDevice.html"> 78</a></span> <span class="keyword">struct </span><a class="code" href="structfair_1_1mq_1_1hooks_1_1InstantiateDevice.html">InstantiateDevice</a> : <a class="code" href="structfair_1_1mq_1_1Event.html">Event</a><DeviceRunner&> {};</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> } <span class="comment">/* namespace hooks */</span></div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> } <span class="comment">/* namespace mq */</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> } <span class="comment">/* namespace fair */</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="preprocessor">#endif </span><span class="comment">/* FAIR_MQ_DEVICERUNNER_H */</span><span class="preprocessor"></span></div><div class="ttc" id="classfair_1_1mq_1_1DeviceRunner_html"><div class="ttname"><a href="classfair_1_1mq_1_1DeviceRunner.html">fair::mq::DeviceRunner</a></div><div class="ttdoc">Utility class to facilitate a convenient top-level device launch/shutdown. </div><div class="ttdef"><b>Definition:</b> DeviceRunner.h:51</div></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:33</div></div>
|
|
<div class="ttc" id="structfair_1_1mq_1_1hooks_1_1LoadPlugins_html"><div class="ttname"><a href="structfair_1_1mq_1_1hooks_1_1LoadPlugins.html">fair::mq::hooks::LoadPlugins</a></div><div class="ttdef"><b>Definition:</b> DeviceRunner.h:75</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:53</div></div>
|
|
<div class="ttc" id="classFairMQProgOptions_html"><div class="ttname"><a href="classFairMQProgOptions.html">FairMQProgOptions</a></div><div class="ttdef"><b>Definition:</b> FairMQProgOptions.h:41</div></div>
|
|
<div class="ttc" id="structfair_1_1mq_1_1hooks_1_1ModifyRawCmdLineArgs_html"><div class="ttname"><a href="structfair_1_1mq_1_1hooks_1_1ModifyRawCmdLineArgs.html">fair::mq::hooks::ModifyRawCmdLineArgs</a></div><div class="ttdef"><b>Definition:</b> DeviceRunner.h:77</div></div>
|
|
<div class="ttc" id="structfair_1_1mq_1_1hooks_1_1InstantiateDevice_html"><div class="ttname"><a href="structfair_1_1mq_1_1hooks_1_1InstantiateDevice.html">fair::mq::hooks::InstantiateDevice</a></div><div class="ttdef"><b>Definition:</b> DeviceRunner.h:78</div></div>
|
|
<div class="ttc" id="structfair_1_1mq_1_1hooks_1_1SetCustomCmdLineOptions_html"><div class="ttname"><a href="structfair_1_1mq_1_1hooks_1_1SetCustomCmdLineOptions.html">fair::mq::hooks::SetCustomCmdLineOptions</a></div><div class="ttdef"><b>Definition:</b> DeviceRunner.h:76</div></div>
|
|
<div class="ttc" id="namespacefair_html"><div class="ttname"><a href="namespacefair.html">fair</a></div><div class="ttdef"><b>Definition:</b> DeviceRunner.h:23</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</body>
|
|
</html>
|