mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 08:41:16 +00:00
82 lines
20 KiB
HTML
82 lines
20 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/devices/FairMQSink.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.7</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><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">FairMQSink.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) 2014 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="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#ifndef FAIRMQSINK_H_</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#define FAIRMQSINK_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 <string></span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <chrono></span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include "../FairMQDevice.h"</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include "../FairMQLogger.h"</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "../options/FairMQProgOptions.h"</span></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="comment">// template<typename OutputPolicy></span></div><div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="classFairMQSink.html"> 26</a></span> <span class="keyword">class </span><a class="code" href="classFairMQSink.html">FairMQSink</a> : <span class="keyword">public</span> <a class="code" href="classFairMQDevice.html">FairMQDevice</a><span class="comment">//, public OutputPolicy</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> {</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  <a class="code" href="classFairMQSink.html">FairMQSink</a>()</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  : fMultipart(<span class="keyword">false</span>)</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  , fMaxIterations(0)</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  , fNumIterations(0)</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  , fInChannelName()</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  {}</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>  <span class="keyword">virtual</span> ~<a class="code" href="classFairMQSink.html">FairMQSink</a>()</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  {}</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">protected</span>:</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordtype">bool</span> fMultipart;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  uint64_t fMaxIterations;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  uint64_t fNumIterations;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  std::string fInChannelName;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classFairMQSink.html#a09c757beb340b7c5576d310f393362b1"> 45</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classFairMQSink.html#a09c757beb340b7c5576d310f393362b1">InitTask</a>()</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>  fMultipart = <a class="code" href="classFairMQDevice.html#a01a7d955417385b42fdbf8b263e055b7">fConfig</a>->GetValue<<span class="keywordtype">bool</span>>(<span class="stringliteral">"multipart"</span>);</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  fMaxIterations = <a class="code" href="classFairMQDevice.html#a01a7d955417385b42fdbf8b263e055b7">fConfig</a>->GetValue<uint64_t>(<span class="stringliteral">"max-iterations"</span>);</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  fInChannelName = <a class="code" href="classFairMQDevice.html#a01a7d955417385b42fdbf8b263e055b7">fConfig</a>->GetValue<std::string>(<span class="stringliteral">"in-channel"</span>);</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  }</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="classFairMQSink.html#a8ecd8e802f44935424b7becb04e2ccf5"> 52</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classFairMQSink.html#a8ecd8e802f44935424b7becb04e2ccf5">Run</a>()</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>  <span class="comment">// store the channel reference to avoid traversing the map on every loop iteration</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <a class="code" href="classFairMQChannel.html">FairMQChannel</a>& dataInChannel = <a class="code" href="classFairMQDevice.html#ad6e090504ceef5799b6f85b136d1e547">fChannels</a>.at(fInChannelName).at(0);</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>  LOG(info) << <span class="stringliteral">"Starting the benchmark and expecting to receive "</span> << fMaxIterations << <span class="stringliteral">" messages."</span>;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">auto</span> tStart = std::chrono::high_resolution_clock::now();</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>  <span class="keywordflow">while</span> (CheckCurrentState(RUNNING))</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  {</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordflow">if</span> (fMultipart)</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>  <a class="code" href="classFairMQParts.html">FairMQParts</a> parts;</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>  <span class="keywordflow">if</span> (dataInChannel.<a class="code" href="classFairMQChannel.html#aed602093bfb5637bc7aff1545757b9b4">Receive</a>(parts) >= 0)</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="keywordflow">if</span> (fMaxIterations > 0)</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="keywordflow">if</span> (fNumIterations >= fMaxIterations)</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>  LOG(info) << <span class="stringliteral">"Configured maximum number of iterations reached."</span>;</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordflow">break</span>;</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  }</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  }</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  fNumIterations++;</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  }</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>  <span class="keywordflow">else</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>  FairMQMessagePtr msg(dataInChannel.NewMessage());</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>  <span class="keywordflow">if</span> (dataInChannel.<a class="code" href="classFairMQChannel.html#aed602093bfb5637bc7aff1545757b9b4">Receive</a>(msg) >= 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="keywordflow">if</span> (fMaxIterations > 0)</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  {</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordflow">if</span> (fNumIterations >= fMaxIterations)</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>  LOG(info) << <span class="stringliteral">"Configured maximum number of iterations reached."</span>;</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordflow">break</span>;</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>  }</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  fNumIterations++;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  }</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  }</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  }</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keyword">auto</span> tEnd = std::chrono::high_resolution_clock::now();</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>  LOG(info) << <span class="stringliteral">"Leaving RUNNING state. Received "</span> << fNumIterations << <span class="stringliteral">" messages in "</span> << std::chrono::duration<double, std::milli>(tEnd - tStart).count() << <span class="stringliteral">"ms."</span>;</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  }</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> };</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> </div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="preprocessor">#endif </span><span class="comment">/* FAIRMQSINK_H_ */</span><span class="preprocessor"></span></div><div class="ttc" id="classFairMQSink_html_a09c757beb340b7c5576d310f393362b1"><div class="ttname"><a href="classFairMQSink.html#a09c757beb340b7c5576d310f393362b1">FairMQSink::InitTask</a></div><div class="ttdeci">virtual void InitTask()</div><div class="ttdoc">Task initialization (can be overloaded in child classes) </div><div class="ttdef"><b>Definition:</b> FairMQSink.h:45</div></div>
|
|
<div class="ttc" id="classFairMQChannel_html_aed602093bfb5637bc7aff1545757b9b4"><div class="ttname"><a href="classFairMQChannel.html#aed602093bfb5637bc7aff1545757b9b4">FairMQChannel::Receive</a></div><div class="ttdeci">int Receive(FairMQMessagePtr &msg, int rcvTimeoutInMs=-1)</div><div class="ttdef"><b>Definition:</b> FairMQChannel.h:244</div></div>
|
|
<div class="ttc" id="classFairMQDevice_html_a01a7d955417385b42fdbf8b263e055b7"><div class="ttname"><a href="classFairMQDevice.html#a01a7d955417385b42fdbf8b263e055b7">FairMQDevice::fConfig</a></div><div class="ttdeci">FairMQProgOptions * fConfig</div><div class="ttdoc">Pointer to config (internal or external) </div><div class="ttdef"><b>Definition:</b> FairMQDevice.h:413</div></div>
|
|
<div class="ttc" id="classFairMQChannel_html"><div class="ttname"><a href="classFairMQChannel.html">FairMQChannel</a></div><div class="ttdef"><b>Definition:</b> FairMQChannel.h:27</div></div>
|
|
<div class="ttc" id="classFairMQSink_html"><div class="ttname"><a href="classFairMQSink.html">FairMQSink</a></div><div class="ttdef"><b>Definition:</b> FairMQSink.h:26</div></div>
|
|
<div class="ttc" id="classFairMQDevice_html_ad6e090504ceef5799b6f85b136d1e547"><div class="ttname"><a href="classFairMQDevice.html#ad6e090504ceef5799b6f85b136d1e547">FairMQDevice::fChannels</a></div><div class="ttdeci">std::unordered_map< std::string, std::vector< FairMQChannel > > fChannels</div><div class="ttdoc">Device channels. </div><div class="ttdef"><b>Definition:</b> FairMQDevice.h:411</div></div>
|
|
<div class="ttc" id="classFairMQParts_html"><div class="ttname"><a href="classFairMQParts.html">FairMQParts</a></div><div class="ttdoc">FairMQParts is a lightweight convenience wrapper around a vector of unique pointers to FairMQMessage...</div><div class="ttdef"><b>Definition:</b> FairMQParts.h:20</div></div>
|
|
<div class="ttc" id="classFairMQDevice_html"><div class="ttname"><a href="classFairMQDevice.html">FairMQDevice</a></div><div class="ttdef"><b>Definition:</b> FairMQDevice.h:46</div></div>
|
|
<div class="ttc" id="classFairMQSink_html_a8ecd8e802f44935424b7becb04e2ccf5"><div class="ttname"><a href="classFairMQSink.html#a8ecd8e802f44935424b7becb04e2ccf5">FairMQSink::Run</a></div><div class="ttdeci">virtual void Run()</div><div class="ttdoc">Runs the device (to be overloaded in child classes) </div><div class="ttdef"><b>Definition:</b> FairMQSink.h:52</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>
|