mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-15 17:41:45 +00:00
Add API docs for 1.3.8
This commit is contained in:
Dennis Klein
152
v1.3.8/structfair_1_1mq_1_1parser_1_1SUBOPT.html
Normal file
152
v1.3.8/structfair_1_1mq_1_1parser_1_1SUBOPT.html
Normal file
@@ -0,0 +1,152 @@
|
||||
<!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.14"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>FairMQ: fair::mq::parser::SUBOPT Struct Reference</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.8</span>
|
||||
</div>
|
||||
<div id="projectbrief">C++ Message Passing Framework</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.14 -->
|
||||
<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="namespacefair.html">fair</a></li><li class="navelem"><b>mq</b></li><li class="navelem"><b>parser</b></li><li class="navelem"><a class="el" href="structfair_1_1mq_1_1parser_1_1SUBOPT.html">SUBOPT</a></li> </ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div class="header">
|
||||
<div class="summary">
|
||||
<a href="#pub-types">Public Types</a> |
|
||||
<a href="#pub-methods">Public Member Functions</a> |
|
||||
<a href="#pub-static-attribs">Static Public Attributes</a> |
|
||||
<a href="structfair_1_1mq_1_1parser_1_1SUBOPT-members.html">List of all members</a> </div>
|
||||
<div class="headertitle">
|
||||
<div class="title">fair::mq::parser::SUBOPT Struct Reference</div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
|
||||
<p><code>#include <<a class="el" href="FairMQSuboptParser_8h_source.html">FairMQSuboptParser.h</a>></code></p>
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
|
||||
Public Types</h2></td></tr>
|
||||
<tr class="memitem:a8ec52ea646e905e214ae038f4d6e7a3d"><td class="memItemLeft" align="right" valign="top"><a id="a8ec52ea646e905e214ae038f4d6e7a3d"></a>enum  </td><td class="memItemRight" valign="bottom"><b>channelOptionKeyIds</b> { <br />
|
||||
  <b>NAME</b> = 0,
|
||||
<b>TYPE</b>,
|
||||
<b>METHOD</b>,
|
||||
<b>ADDRESS</b>,
|
||||
<br />
|
||||
  <b>TRANSPORT</b>,
|
||||
<b>SNDBUFSIZE</b>,
|
||||
<b>RCVBUFSIZE</b>,
|
||||
<b>SNDKERNELSIZE</b>,
|
||||
<br />
|
||||
  <b>RCVKERNELSIZE</b>,
|
||||
<b>LINGER</b>,
|
||||
<b>RATELOGGING</b>,
|
||||
<b>PORTRANGEMIN</b>,
|
||||
<br />
|
||||
  <b>PORTRANGEMAX</b>,
|
||||
<b>AUTOBIND</b>,
|
||||
<b>NUMSOCKETS</b>,
|
||||
<b>lastsocketkey</b>
|
||||
<br />
|
||||
}</td></tr>
|
||||
<tr class="separator:a8ec52ea646e905e214ae038f4d6e7a3d"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table><table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
||||
Public Member Functions</h2></td></tr>
|
||||
<tr class="memitem:ac3185fde4dd014ec1e653db79a33cee2"><td class="memItemLeft" align="right" valign="top"><a id="ac3185fde4dd014ec1e653db79a33cee2"></a>
|
||||
FairMQChannelMap </td><td class="memItemRight" valign="bottom"><b>UserParser</b> (const std::vector< std::string > &channelConfig, const std::string &deviceId, const std::string &rootNode="fairMQOptions")</td></tr>
|
||||
<tr class="separator:ac3185fde4dd014ec1e653db79a33cee2"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table><table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
|
||||
Static Public Attributes</h2></td></tr>
|
||||
<tr class="memitem:a2a40e763d9a4bb260440f63c01db0523"><td class="memItemLeft" align="right" valign="top">static constexpr const char * </td><td class="memItemRight" valign="bottom"><b>channelOptionKeys</b> []</td></tr>
|
||||
<tr class="separator:a2a40e763d9a4bb260440f63c01db0523"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p>A parser implementation for FairMQ channel properties. The parser handles a comma separated key=value list format by using the getsubopt function of the standard library.</p>
|
||||
<p>The option key '–channel-config' can be used with the list of key/value pairs like e.g. </p><pre>
|
||||
--channel-config name=output,type=push,method=bind
|
||||
</pre><p>The FairMQ option parser defines a 'UserParser' function for different formats. Currently it is strictly parsing channel options, but in general the concept is extensible by renaming UserParser to ChannelPropertyParser and introducing additional parser functions. </p>
|
||||
</div><h2 class="groupheader">Member Data Documentation</h2>
|
||||
<a id="a2a40e763d9a4bb260440f63c01db0523"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#a2a40e763d9a4bb260440f63c01db0523">◆ </a></span>channelOptionKeys</h2>
|
||||
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="mlabels">
|
||||
<tr>
|
||||
<td class="mlabels-left">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">constexpr const char * fair::mq::parser::SUBOPT::channelOptionKeys</td>
|
||||
</tr>
|
||||
</table>
|
||||
</td>
|
||||
<td class="mlabels-right">
|
||||
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||||
</tr>
|
||||
</table>
|
||||
</div><div class="memdoc">
|
||||
<b>Initial value:</b><div class="fragment"><div class="line">= {</div><div class="line"> <span class="stringliteral">"name"</span>,</div><div class="line"> <span class="stringliteral">"type"</span>,</div><div class="line"> <span class="stringliteral">"method"</span>,</div><div class="line"> <span class="stringliteral">"address"</span>,</div><div class="line"> <span class="stringliteral">"transport"</span>,</div><div class="line"> <span class="stringliteral">"sndBufSize"</span>,</div><div class="line"> <span class="stringliteral">"rcvBufSize"</span>,</div><div class="line"> <span class="stringliteral">"sndKernelSize"</span>,</div><div class="line"> <span class="stringliteral">"rcvKernelSize"</span>,</div><div class="line"> <span class="stringliteral">"linger"</span>,</div><div class="line"> <span class="stringliteral">"rateLogging"</span>,</div><div class="line"> <span class="stringliteral">"portRangeMin"</span>,</div><div class="line"> <span class="stringliteral">"portRangeMax"</span>,</div><div class="line"> <span class="stringliteral">"autoBind"</span>,</div><div class="line"> <span class="stringliteral">"numSockets"</span>,</div><div class="line"> <span class="keyword">nullptr</span></div><div class="line"> }</div></div><!-- fragment -->
|
||||
</div>
|
||||
</div>
|
||||
<hr/>The documentation for this struct was generated from the following files:<ul>
|
||||
<li>fairmq/options/<a class="el" href="FairMQSuboptParser_8h_source.html">FairMQSuboptParser.h</a></li>
|
||||
<li>fairmq/options/<a class="el" href="FairMQSuboptParser_8cxx.html">FairMQSuboptParser.cxx</a></li>
|
||||
</ul>
|
||||
</div><!-- contents -->
|
||||
<p style="margin: 0 12px 10px 12px;"><a href="https://help.github.com/articles/github-privacy-statement/">privacy</a></p>
|
||||
Reference in New Issue
Block a user