mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 08:41:16 +00:00
83 lines
23 KiB
HTML
83 lines
23 KiB
HTML
<!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">
|
|
<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.15"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>FairMQ: fairmq/plugins/DDS/DDS.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.3.9</span>
|
|
</div>
|
|
<div id="projectbrief">C++ Message Passing Framework</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.15 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</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><li class="navelem"><a class="el" href="dir_c2fe5dddc7ffa165dbdae926a051158e.html">plugins</a></li><li class="navelem"><a class="el" href="dir_971de67a0ea47ad3d0f84ca5c47a4a50.html">DDS</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">DDS.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_PLUGINS_DDS</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#define FAIR_MQ_PLUGINS_DDS</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/Plugin.h></span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> </div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <dds_intercom.h></span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <condition_variable></span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <mutex></span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include <string></span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <queue></span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <thread></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> <span class="preprocessor">#include <unordered_map></span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <set></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <chrono></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <functional></span></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> <span class="keyword">namespace </span><a class="code" href="namespacefair.html">fair</a></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="keyword">namespace </span>mq</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> {</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">namespace </span>plugins</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> </div><div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="structfair_1_1mq_1_1plugins_1_1DDSConfig.html"> 34</a></span> <span class="keyword">struct </span><a class="code" href="structfair_1_1mq_1_1plugins_1_1DDSConfig.html">DDSConfig</a></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> {</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <a class="code" href="structfair_1_1mq_1_1plugins_1_1DDSConfig.html">DDSConfig</a>()</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  : fSubChannelAddresses()</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  , fDDSValues()</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  {}</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="comment">// container of sub channel addresses</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  std::vector<std::string> fSubChannelAddresses;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="comment">// dds values for the channel</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  std::unordered_map<uint64_t, std::string> fDDSValues;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> };</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="structfair_1_1mq_1_1plugins_1_1IofN.html"> 47</a></span> <span class="keyword">struct </span><a class="code" href="structfair_1_1mq_1_1plugins_1_1IofN.html">IofN</a></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> {</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="structfair_1_1mq_1_1plugins_1_1IofN.html">IofN</a>(<span class="keywordtype">int</span> i, <span class="keywordtype">int</span> n)</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  : fI(i)</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  , fN(n)</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  , fEntries()</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  {}</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> fI;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> fN;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  std::vector<std::string> fEntries;</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> };</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1plugins_1_1DDS.html"> 61</a></span> <span class="keyword">class </span><a class="code" href="classfair_1_1mq_1_1plugins_1_1DDS.html">DDS</a> : <span class="keyword">public</span> <a class="code" href="classfair_1_1mq_1_1Plugin.html">Plugin</a></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> {</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <a class="code" href="classfair_1_1mq_1_1plugins_1_1DDS.html">DDS</a>(<span class="keyword">const</span> std::string& name, <span class="keyword">const</span> <a class="code" href="structfair_1_1mq_1_1tools_1_1Version.html">Plugin::Version</a> version, <span class="keyword">const</span> std::string& maintainer, <span class="keyword">const</span> std::string& homepage, <a class="code" href="classfair_1_1mq_1_1PluginServices.html">PluginServices</a>* pluginServices);</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  ~<a class="code" href="classfair_1_1mq_1_1plugins_1_1DDS.html">DDS</a>();</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">auto</span> HandleControl() -> void;</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">auto</span> WaitForNextState() -> DeviceState;</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>  <span class="keyword">auto</span> FillChannelContainers() -> void;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keyword">auto</span> SubscribeForConnectingChannels() -> void;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="keyword">auto</span> PublishBoundChannels() -> void;</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">auto</span> SubscribeForCustomCommands() -> void;</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>  <span class="keyword">auto</span> HeartbeatSender() -> void;</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  dds::intercom_api::CIntercomService fService;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  dds::intercom_api::CCustomCmd fDDSCustomCmd;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  dds::intercom_api::CKeyValue fDDSKeyValue;</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>  std::unordered_map<std::string, std::vector<std::string>> fBindingChans;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  std::unordered_map<std::string, DDSConfig> fConnectingChans;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  std::unordered_map<std::string, int> fI;</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  std::unordered_map<std::string, IofN> fIofN;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  std::mutex fStopMutex;</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  std::condition_variable fStopCondition;</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>  <span class="keyword">const</span> std::set<std::string> fCommands;</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>  std::thread fControllerThread;</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  std::queue<DeviceState> fEvents;</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  std::mutex fEventsMutex;</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  std::condition_variable fNewEvent;</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> </div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  std::atomic<bool> fDeviceTerminationRequested;</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>  std::set<uint64_t> fHeartbeatSubscribers;</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  std::mutex fHeartbeatSubscriberMutex;</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  std::set<uint64_t> fStateChangeSubscribers;</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  std::mutex fStateChangeSubscriberMutex;</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  std::thread fHeartbeatThread;</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  std::chrono::milliseconds fHeartbeatInterval;</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> };</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> Plugin::ProgOptions DDSProgramOptions()</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> {</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  boost::program_options::options_description options{<span class="stringliteral">"DDS Plugin"</span>};</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  options.add_options()</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  (<span class="stringliteral">"dds-i"</span>, boost::program_options::value<std::vector<std::string>>()->multitoken()->composing(), <span class="stringliteral">"Task index for chosing connection target (single channel n to m). When all values come via same update."</span>)</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  (<span class="stringliteral">"dds-i-n"</span>, boost::program_options::value<std::vector<std::string>>()->multitoken()->composing(), <span class="stringliteral">"Task index for chosing connection target (one out of n values to take). When values come as independent updates."</span>);</div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span> </div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  <span class="keywordflow">return</span> options;</div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> }</div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> </div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> REGISTER_FAIRMQ_PLUGIN(</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  DDS, <span class="comment">// Class name</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  dds, <span class="comment">// Plugin name (string, lower case chars only)</span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  (Plugin::Version{1,0,0}), <span class="comment">// Version</span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="stringliteral">"FairRootGroup <fairroot@gsi.de>"</span>, <span class="comment">// Maintainer</span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="stringliteral">"https://github.com/FairRootGroup/FairRoot"</span>, <span class="comment">// Homepage</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  DDSProgramOptions <span class="comment">// custom program options for the plugin</span></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> </div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> } <span class="comment">/* namespace plugins */</span></div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> } <span class="comment">/* namespace mq */</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> } <span class="comment">/* namespace fair */</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> </div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="preprocessor">#endif </span><span class="comment">/* FAIR_MQ_PLUGINS_DDS */</span><span class="preprocessor"></span></div><div class="ttc" id="classfair_1_1mq_1_1PluginServices_html"><div class="ttname"><a href="classfair_1_1mq_1_1PluginServices.html">fair::mq::PluginServices</a></div><div class="ttdoc">Facilitates communication between devices and plugins.</div><div class="ttdef"><b>Definition:</b> PluginServices.h:38</div></div>
|
|
<div class="ttc" id="classfair_1_1mq_1_1plugins_1_1DDS_html"><div class="ttname"><a href="classfair_1_1mq_1_1plugins_1_1DDS.html">fair::mq::plugins::DDS</a></div><div class="ttdef"><b>Definition:</b> DDS.h:61</div></div>
|
|
<div class="ttc" id="structfair_1_1mq_1_1plugins_1_1DDSConfig_html"><div class="ttname"><a href="structfair_1_1mq_1_1plugins_1_1DDSConfig.html">fair::mq::plugins::DDSConfig</a></div><div class="ttdef"><b>Definition:</b> DDS.h:34</div></div>
|
|
<div class="ttc" id="structfair_1_1mq_1_1plugins_1_1IofN_html"><div class="ttname"><a href="structfair_1_1mq_1_1plugins_1_1IofN.html">fair::mq::plugins::IofN</a></div><div class="ttdef"><b>Definition:</b> DDS.h:47</div></div>
|
|
<div class="ttc" id="classfair_1_1mq_1_1Plugin_html"><div class="ttname"><a href="classfair_1_1mq_1_1Plugin.html">fair::mq::Plugin</a></div><div class="ttdoc">Base class for FairMQ plugins.</div><div class="ttdef"><b>Definition:</b> Plugin.h:38</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 class="ttc" id="structfair_1_1mq_1_1tools_1_1Version_html"><div class="ttname"><a href="structfair_1_1mq_1_1tools_1_1Version.html">fair::mq::tools::Version</a></div><div class="ttdef"><b>Definition:</b> Version.h:22</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>
|