FairMQ/v1.4.33/FairMQSplitter_8h_source.html
2021-03-23 14:11:44 +01:00

145 lines
15 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/devices/FairMQSplitter.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
&#160;<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&amp;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&amp;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_b4ab45277bc4c2ae49385465b8ac74b3.html">devices</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">FairMQSplitter.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/********************************************************************************</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Copyright (C) 2014 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH *</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * *</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<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>&#160;<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>&#160;<span class="comment"> * copied verbatim in the file &quot;LICENSE&quot; *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> ********************************************************************************/</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#ifndef FAIRMQSPLITTER_H_</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#define FAIRMQSPLITTER_H_</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; </div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#include &quot;FairMQDevice.h&quot;</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
<div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="classFairMQSplitter.html"> 22</a></span>&#160;<span class="keyword">class </span><a class="code" href="classFairMQSplitter.html">FairMQSplitter</a> : <span class="keyword">public</span> <a class="code" href="classFairMQDevice.html">FairMQDevice</a></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;{</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <a class="code" href="classFairMQSplitter.html">FairMQSplitter</a>()</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; : fMultipart(<span class="keyword">true</span>)</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; , fNumOutputs(0)</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; , fDirection(0)</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; , fInChannelName()</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; , fOutChannelName()</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; {}</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; ~<a class="code" href="classFairMQSplitter.html">FairMQSplitter</a>() {}</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keywordtype">bool</span> fMultipart;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keywordtype">int</span> fNumOutputs;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keywordtype">int</span> fDirection;</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; std::string fInChannelName;</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; std::string fOutChannelName;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; </div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keywordtype">void</span> <a class="code" href="classFairMQSplitter.html#a2d6551c9e65460042b9fb45295ba1390">InitTask</a>()<span class="keyword"> override</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="keyword"> </span>{</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; fMultipart = <a class="code" href="classFairMQDevice.html#a3496403c6124440185111ba3b49fb80d">fConfig</a>-&gt;<a class="code" href="classfair_1_1mq_1_1ProgOptions.html#ab68955211261d786ddec42aa986484ac">GetProperty</a>&lt;<span class="keywordtype">bool</span>&gt;(<span class="stringliteral">&quot;multipart&quot;</span>);</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; fInChannelName = <a class="code" href="classFairMQDevice.html#a3496403c6124440185111ba3b49fb80d">fConfig</a>-&gt;<a class="code" href="classfair_1_1mq_1_1ProgOptions.html#ab68955211261d786ddec42aa986484ac">GetProperty</a>&lt;std::string&gt;(<span class="stringliteral">&quot;in-channel&quot;</span>);</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; fOutChannelName = <a class="code" href="classFairMQDevice.html#a3496403c6124440185111ba3b49fb80d">fConfig</a>-&gt;<a class="code" href="classfair_1_1mq_1_1ProgOptions.html#ab68955211261d786ddec42aa986484ac">GetProperty</a>&lt;std::string&gt;(<span class="stringliteral">&quot;out-channel&quot;</span>);</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; fNumOutputs = <a class="code" href="classFairMQDevice.html#ad6e090504ceef5799b6f85b136d1e547">fChannels</a>.at(fOutChannelName).size();</div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classFairMQSplitter.html#a2d6551c9e65460042b9fb45295ba1390"> 47</a></span>&#160; fDirection = 0;</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; </div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordflow">if</span> (fMultipart) {</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; OnData(fInChannelName, &amp;FairMQSplitter::HandleData&lt;FairMQParts&gt;);</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; } <span class="keywordflow">else</span> {</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; OnData(fInChannelName, &amp;FairMQSplitter::HandleData&lt;FairMQMessagePtr&gt;);</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; }</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; }</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keywordtype">bool</span> HandleData(T&amp; payload, <span class="keywordtype">int</span>)</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; {</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <a class="code" href="classFairMQDevice.html#ac9458e96239d625186c7e5f9163ae7e2">Send</a>(payload, fOutChannelName, fDirection);</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keywordflow">if</span> (++fDirection &gt;= fNumOutputs) {</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; fDirection = 0;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; }</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160; </div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; }</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160;};</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* FAIRMQSPLITTER_H_ */</span><span class="preprocessor"></span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclassFairMQDevice_html_ad6e090504ceef5799b6f85b136d1e547"><div class="ttname"><a href="classFairMQDevice.html#ad6e090504ceef5799b6f85b136d1e547">FairMQDevice::fChannels</a></div><div class="ttdeci">std::unordered_map&lt; std::string, std::vector&lt; FairMQChannel &gt; &gt; fChannels</div><div class="ttdoc">Device channels.</div><div class="ttdef"><b>Definition:</b> FairMQDevice.h:383</div></div>
<div class="ttc" id="aclassfair_1_1mq_1_1ProgOptions_html_ab68955211261d786ddec42aa986484ac"><div class="ttname"><a href="classfair_1_1mq_1_1ProgOptions.html#ab68955211261d786ddec42aa986484ac">fair::mq::ProgOptions::GetProperty</a></div><div class="ttdeci">T GetProperty(const std::string &amp;key) const</div><div class="ttdoc">Read config property, throw if no property with this key exists.</div><div class="ttdef"><b>Definition:</b> ProgOptions.h:69</div></div>
<div class="ttc" id="aclassFairMQSplitter_html"><div class="ttname"><a href="classFairMQSplitter.html">FairMQSplitter</a></div><div class="ttdef"><b>Definition:</b> FairMQSplitter.h:23</div></div>
<div class="ttc" id="aclassFairMQSplitter_html_a2d6551c9e65460042b9fb45295ba1390"><div class="ttname"><a href="classFairMQSplitter.html#a2d6551c9e65460042b9fb45295ba1390">FairMQSplitter::InitTask</a></div><div class="ttdeci">void InitTask() override</div><div class="ttdoc">Task initialization (can be overloaded in child classes)</div><div class="ttdef"><b>Definition:</b> FairMQSplitter.h:47</div></div>
<div class="ttc" id="aclassFairMQDevice_html_ac9458e96239d625186c7e5f9163ae7e2"><div class="ttname"><a href="classFairMQDevice.html#ac9458e96239d625186c7e5f9163ae7e2">FairMQDevice::Send</a></div><div class="ttdeci">int64_t Send(FairMQMessagePtr &amp;msg, const std::string &amp;channel, const int index=0, int sndTimeoutInMs=-1)</div><div class="ttdef"><b>Definition:</b> FairMQDevice.h:97</div></div>
<div class="ttc" id="aclassFairMQDevice_html_a3496403c6124440185111ba3b49fb80d"><div class="ttname"><a href="classFairMQDevice.html#a3496403c6124440185111ba3b49fb80d">FairMQDevice::fConfig</a></div><div class="ttdeci">fair::mq::ProgOptions * fConfig</div><div class="ttdoc">Pointer to config (internal or external)</div><div class="ttdef"><b>Definition:</b> FairMQDevice.h:385</div></div>
<div class="ttc" id="aclassFairMQDevice_html"><div class="ttname"><a href="classFairMQDevice.html">FairMQDevice</a></div><div class="ttdef"><b>Definition:</b> FairMQDevice.h:50</div></div>
<p style="margin: 0 12px 10px 12px;"><a href="https://help.github.com/articles/github-privacy-statement/">privacy</a></p>