mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 08:41:16 +00:00
188 lines
21 KiB
HTML
188 lines
21 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.18"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>FairMQ: fairmq/sdk/DDSSession.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.33</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.18 -->
|
|
<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_02bd51ad6cbd3c7b005f7a6d7cf0a7f8.html">sdk</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">DDSSession.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) 2019 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_SDK_DDSSESSION_H</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#define FAIR_MQ_SDK_DDSSESSION_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/sdk/DDSEnvironment.h></span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <fairmq/sdk/DDSInfo.h></span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <fairmq/sdk/DDSTask.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 <boost/filesystem.hpp></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 <cstdint></span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <istream></span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <memory></span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <ostream></span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <stdexcept></span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <string></span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <functional></span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <vector></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>fair::mq::sdk</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>  </div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">enum class</span> DDSRMSPlugin</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>  localhost,</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  ssh</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> };</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">auto</span> operator<<(std::ostream& os, DDSRMSPlugin plugin) -> std::ostream&;</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">auto</span> operator>>(std::istream& is, DDSRMSPlugin& plugin) -> std::istream&;</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  </div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">class </span>DDSTopology;</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">class </span>DDSAgent;</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  </div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="keyword">class </span>DDSChannel</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> {</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keyword">using</span> Id = std::uint64_t;</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> };</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  </div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="keyword">class </span>DDSSession</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> {</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">using</span> Id = std::string;</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">using</span> Quantity = std::uint32_t;</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">using</span> Path = boost::filesystem::path;</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1sdk_1_1DDSSession.html"> 61</a></span>  </div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">explicit</span> <a class="code" href="classfair_1_1mq_1_1sdk_1_1DDSSession.html">DDSSession</a>(<a class="code" href="classfair_1_1mq_1_1sdk_1_1DDSEnvironment.html">DDSEnvironment</a> env = <a class="code" href="classfair_1_1mq_1_1sdk_1_1DDSEnvironment.html">DDSEnvironment</a>());</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">explicit</span> <a class="code" href="classfair_1_1mq_1_1sdk_1_1DDSSession.html">DDSSession</a>(Id existing, <a class="code" href="classfair_1_1mq_1_1sdk_1_1DDSEnvironment.html">DDSEnvironment</a> env = <a class="code" href="classfair_1_1mq_1_1sdk_1_1DDSEnvironment.html">DDSEnvironment</a>());</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  </div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keyword">explicit</span> <a class="code" href="classfair_1_1mq_1_1sdk_1_1DDSSession.html">DDSSession</a>(std::shared_ptr<dds::tools_api::CSession> nativeSession, <a class="code" href="classfair_1_1mq_1_1sdk_1_1DDSEnvironment.html">DDSEnv</a> env = {});</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">auto</span> GetEnv() const -> <a class="code" href="classfair_1_1mq_1_1sdk_1_1DDSEnvironment.html">DDSEnvironment</a>;</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  auto GetId() const -> Id;</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  auto GetRMSPlugin() const -> DDSRMSPlugin;</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  auto SetRMSPlugin(DDSRMSPlugin) -> <span class="keywordtype">void</span>;</div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  auto GetRMSConfig() const -> Path;</div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  auto SetRMSConfig(Path) const -> <span class="keywordtype">void</span>;</div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  auto IsStoppedOnDestruction() const -> <span class="keywordtype">bool</span>;</div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  auto StopOnDestruction(<span class="keywordtype">bool</span> stop = true) -> <span class="keywordtype">void</span>;</div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  auto IsRunning() const -> <span class="keywordtype">bool</span>;</div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  auto SubmitAgents(Quantity agents) -> <span class="keywordtype">void</span>;</div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  struct AgentCount {</div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  Quantity idle = 0;</div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  Quantity active = 0;</div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  Quantity executing = 0;</div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  };</div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">auto</span> RequestAgentCount() -> AgentCount;</div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="structfair_1_1mq_1_1sdk_1_1DDSSession_1_1AgentCount.html"> 86</a></span>  <span class="keyword">auto</span> RequestAgentInfo() -> std::vector<DDSAgent>;</div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keyword">auto</span> RequestTaskInfo() -> std::vector<DDSTask>;</div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keyword">struct </span><a class="code" href="structfair_1_1mq_1_1sdk_1_1DDSSession_1_1CommanderInfo.html">CommanderInfo</a> {</div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordtype">int</span> pid = -1;</div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  std::string activeTopologyName;</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">auto</span> RequestCommanderInfo() -> <a class="code" href="structfair_1_1mq_1_1sdk_1_1DDSSession_1_1CommanderInfo.html">CommanderInfo</a>;</div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keyword">auto</span> WaitForIdleAgents(Quantity) -> void;</div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="structfair_1_1mq_1_1sdk_1_1DDSSession_1_1CommanderInfo.html"> 94</a></span>  <span class="keyword">auto</span> WaitForOnlyIdleAgents() -> void;</div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keyword">auto</span> WaitForExecutingAgents(Quantity) -> void;</div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keyword">auto</span> ActivateTopology(<span class="keyword">const</span> Path& topoFile) -> void;</div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keyword">auto</span> ActivateTopology(<a class="code" href="classfair_1_1mq_1_1sdk_1_1DDSTopology.html">DDSTopology</a>) -> void;</div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keyword">auto</span> Stop() -> void;</div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  </div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keywordtype">void</span> StartDDSService();</div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordtype">void</span> SubscribeToCommands(std::function<<span class="keywordtype">void</span>(<span class="keyword">const</span> std::string& msg, <span class="keyword">const</span> std::string& condition, uint64_t senderId)>);</div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keywordtype">void</span> UnsubscribeFromCommands();</div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keywordtype">void</span> SendCommand(<span class="keyword">const</span> std::string&, <span class="keyword">const</span> std::string& = <span class="stringliteral">""</span>);</div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keywordtype">void</span> SendCommand(<span class="keyword">const</span> std::string&, DDSChannel::Id);</div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keyword">auto</span> GetTaskId(DDSChannel::Id) <span class="keyword">const</span> -> DDSTask::Id;</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>  <span class="keyword">friend</span> <span class="keyword">auto</span> operator<<(std::ostream& os, <span class="keyword">const</span> <a class="code" href="classfair_1_1mq_1_1sdk_1_1DDSSession.html">DDSSession</a>& session) -> std::ostream&;</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>  <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  <span class="keyword">struct </span><a class="code" href="structfair_1_1mq_1_1sdk_1_1DDSSession_1_1Impl.html">Impl</a>;</div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  std::shared_ptr<Impl> fImpl;</div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> };</div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  </div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="keyword">auto</span> getMostRecentRunningDDSSession(<a class="code" href="classfair_1_1mq_1_1sdk_1_1DDSEnvironment.html">DDSEnv</a> env = {}) -> <a class="code" href="classfair_1_1mq_1_1sdk_1_1DDSSession.html">DDSSession</a>;</div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  </div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> } <span class="comment">// namespace fair::mq::sdk</span></div>
|
|
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  </div>
|
|
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="preprocessor">#endif </span><span class="comment">/* FAIR_MQ_SDK_DDSSESSION_H */</span><span class="preprocessor"></span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1sdk_1_1DDSEnvironment_html"><div class="ttname"><a href="classfair_1_1mq_1_1sdk_1_1DDSEnvironment.html">fair::mq::sdk::DDSEnvironment</a></div><div class="ttdoc">Sets up the DDS environment (object helper)</div><div class="ttdef"><b>Definition:</b> DDSEnvironment.h:30</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1sdk_1_1DDSSession_html"><div class="ttname"><a href="classfair_1_1mq_1_1sdk_1_1DDSSession.html">fair::mq::sdk::DDSSession</a></div><div class="ttdoc">Represents a DDS session.</div><div class="ttdef"><b>Definition:</b> DDSSession.h:62</div></div>
|
|
<div class="ttc" id="astructfair_1_1mq_1_1sdk_1_1DDSSession_1_1Impl_html"><div class="ttname"><a href="structfair_1_1mq_1_1sdk_1_1DDSSession_1_1Impl.html">fair::mq::sdk::DDSSession::Impl</a></div><div class="ttdef"><b>Definition:</b> DDSSession.cxx:65</div></div>
|
|
<div class="ttc" id="astructfair_1_1mq_1_1sdk_1_1DDSSession_1_1CommanderInfo_html"><div class="ttname"><a href="structfair_1_1mq_1_1sdk_1_1DDSSession_1_1CommanderInfo.html">fair::mq::sdk::DDSSession::CommanderInfo</a></div><div class="ttdef"><b>Definition:</b> DDSSession.h:94</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1sdk_1_1DDSTopology_html"><div class="ttname"><a href="classfair_1_1mq_1_1sdk_1_1DDSTopology.html">fair::mq::sdk::DDSTopology</a></div><div class="ttdoc">Represents a DDS topology.</div><div class="ttdef"><b>Definition:</b> DDSTopology.h:35</div></div>
|
|
<p style="margin: 0 12px 10px 12px;"><a href="https://help.github.com/articles/github-privacy-statement/">privacy</a></p>
|