FairMQ/v1.2.0/FairMQSuboptParser_8h_source.html
2018-05-03 19:53:50 +02:00

83 lines
14 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/options/FairMQSuboptParser.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.2.0</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_45e75480de90911e73132ad6d2c599a0.html">options</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">FairMQSuboptParser.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="FairMQSuboptParser_8h.html">Go to the documentation of this file.</a><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) 2017 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 License (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="l00008"></a><span class="lineno"> 8</span>&#160;</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#ifndef FAIRMQPARSER_SUBOPT_H</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#define FAIRMQPARSER_SUBOPT_H</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &quot;FairMQParser.h&quot;</span> <span class="comment">// for FairMQMap</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#include &lt;boost/program_options.hpp&gt;</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#include &lt;cstring&gt;</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceboost_1_1program__options.html">po</a> = <a class="code" href="namespaceboost_1_1program__options.html">boost::program_options</a>;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacefair.html">fair</a></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;{</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="keyword">namespace </span>mq</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;{</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">namespace </span>parser</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;{</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;</div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="structfair_1_1mq_1_1parser_1_1SUBOPT.html"> 48</a></span>&#160;<span class="keyword">struct </span><a class="code" href="structfair_1_1mq_1_1parser_1_1SUBOPT.html">SUBOPT</a></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;{</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keyword">enum</span> channelOptionKeyIds</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; {</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; NAME = 0, <span class="comment">// name of the channel</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; TYPE, <span class="comment">// push, pull, publish, subscribe, etc</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; METHOD, <span class="comment">// bind or connect</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; ADDRESS, <span class="comment">// host, protocol and port address</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; TRANSPORT, <span class="comment">//</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; SNDBUFSIZE, <span class="comment">// size of the send queue</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; RCVBUFSIZE, <span class="comment">// size of the receive queue</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; SNDKERNELSIZE,</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; RCVKERNELSIZE,</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; RATELOGGING, <span class="comment">// logging rate</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; NUMSOCKETS,</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; lastsocketkey</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;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; constexpr <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span> *channelOptionKeys[] = {</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="comment">/*[NAME] = */</span> <span class="stringliteral">&quot;name&quot;</span>,</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="comment">/*[TYPE] = */</span> <span class="stringliteral">&quot;type&quot;</span>,</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <span class="comment">/*[METHOD] = */</span> <span class="stringliteral">&quot;method&quot;</span>,</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="comment">/*[ADDRESS] = */</span> <span class="stringliteral">&quot;address&quot;</span>,</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; <span class="comment">/*[TRANSPORT] = */</span> <span class="stringliteral">&quot;transport&quot;</span>,</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="comment">/*[SNDBUFSIZE] = */</span> <span class="stringliteral">&quot;sndBufSize&quot;</span>,</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; <span class="comment">/*[RCVBUFSIZE] = */</span> <span class="stringliteral">&quot;rcvBufSize&quot;</span>,</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="comment">/*[SNDKERNELSIZE] = */</span> <span class="stringliteral">&quot;sndKernelSize&quot;</span>,</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; <span class="comment">/*[RCVKERNELSIZE] = */</span> <span class="stringliteral">&quot;rcvKernelSize&quot;</span>,</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; <span class="comment">/*[RATELOGGING] = */</span> <span class="stringliteral">&quot;rateLogging&quot;</span>,</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; <span class="comment">/*[NUMSOCKETS] = */</span> <span class="stringliteral">&quot;numSockets&quot;</span>,</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keyword">nullptr</span></div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; };</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; FairMQMap UserParser(<span class="keyword">const</span> std::vector&lt;std::string&gt;&amp; channelConfig, <span class="keyword">const</span> std::string&amp; deviceId, <span class="keyword">const</span> std::string&amp; rootNode = <span class="stringliteral">&quot;fairMQOptions&quot;</span>);</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;};</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;}</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;}</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160;}</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* FAIRMQPARSER_SUBOPT_H */</span><span class="preprocessor"></span></div><div class="ttc" id="structfair_1_1mq_1_1parser_1_1SUBOPT_html"><div class="ttname"><a href="structfair_1_1mq_1_1parser_1_1SUBOPT.html">fair::mq::parser::SUBOPT</a></div><div class="ttdef"><b>Definition:</b> FairMQSuboptParser.h:48</div></div>
<div class="ttc" id="namespaceboost_1_1program__options_html"><div class="ttname"><a href="namespaceboost_1_1program__options.html">program_options</a></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 &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>