mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 08:41:16 +00:00
1254 lines
80 KiB
HTML
1254 lines
80 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: FairMQDevice Class 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.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><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
|
<a href="#pro-attribs">Protected Attributes</a> |
|
|
<a href="#friends">Friends</a> |
|
|
<a href="classFairMQDevice-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">FairMQDevice Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="dynheader">
|
|
Inheritance diagram for FairMQDevice:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classFairMQDevice__inherit__graph.png" border="0" usemap="#FairMQDevice_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="FairMQDevice_inherit__map" id="FairMQDevice_inherit__map">
|
|
<area shape="rect" id="node4" href="classFairMQBenchmarkSampler.html" title="FairMQBenchmarkSampler" alt="" coords="607,5,802,32"/>
|
|
<area shape="rect" id="node5" href="classFairMQMerger.html" title="FairMQMerger" alt="" coords="649,56,760,83"/>
|
|
<area shape="rect" id="node6" href="classFairMQMultiplier.html" title="FairMQMultiplier" alt="" coords="641,107,768,133"/>
|
|
<area shape="rect" id="node7" href="classFairMQProxy.html" title="FairMQProxy" alt="" coords="653,157,756,184"/>
|
|
<area shape="rect" id="node8" href="classFairMQShmPrototypeSampler.html" title="FairMQShmPrototypeSampler" alt="" coords="599,208,811,235"/>
|
|
<area shape="rect" id="node9" href="classFairMQShmPrototypeSink.html" title="FairMQShmPrototypeSink" alt="" coords="611,259,798,285"/>
|
|
<area shape="rect" id="node10" href="classFairMQSink.html" title="FairMQSink" alt="" coords="657,309,752,336"/>
|
|
<area shape="rect" id="node11" href="classFairMQSplitter.html" title="FairMQSplitter" alt="" coords="648,360,761,387"/>
|
|
<area shape="rect" id="node12" href="classMyDevice.html" title="MyDevice" alt="" coords="661,411,748,437"/>
|
|
<area shape="rect" id="node2" href="classFairMQStateMachine.html" title="FairMQStateMachine" alt="" coords="237,208,392,235"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for FairMQDevice:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classFairMQDevice__coll__graph.png" border="0" usemap="#FairMQDevice_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="FairMQDevice_coll__map" id="FairMQDevice_coll__map">
|
|
<area shape="rect" id="node2" href="classFairMQStateMachine.html" title="FairMQStateMachine" alt="" coords="21,111,176,137"/>
|
|
<area shape="rect" id="node4" href="classFairMQProgOptions.html" title="FairMQProgOptions" alt="" coords="202,111,347,137"/>
|
|
<area shape="rect" id="node5" href="classFairProgOptions.html" title="FairProgOptions" alt="" coords="214,20,338,47"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<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:a735b2684d4678eb959302911f12223eb"><td class="memItemLeft" align="right" valign="top"><a id="a735b2684d4678eb959302911f12223eb"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a735b2684d4678eb959302911f12223eb">FairMQDevice</a> ()</td></tr>
|
|
<tr class="memdesc:a735b2684d4678eb959302911f12223eb"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
|
|
<tr class="separator:a735b2684d4678eb959302911f12223eb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a45356d796b842dd000067ad5cf7a63f5"><td class="memItemLeft" align="right" valign="top"><a id="a45356d796b842dd000067ad5cf7a63f5"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a45356d796b842dd000067ad5cf7a63f5">FairMQDevice</a> (const <a class="el" href="structfair_1_1mq_1_1tools_1_1Version.html">fair::mq::tools::Version</a> version)</td></tr>
|
|
<tr class="memdesc:a45356d796b842dd000067ad5cf7a63f5"><td class="mdescLeft"> </td><td class="mdescRight">Constructor that sets the version. <br /></td></tr>
|
|
<tr class="separator:a45356d796b842dd000067ad5cf7a63f5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a806cf5c241bf95571654cd327d6e76fe"><td class="memItemLeft" align="right" valign="top"><a id="a806cf5c241bf95571654cd327d6e76fe"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a806cf5c241bf95571654cd327d6e76fe">FairMQDevice</a> (const <a class="el" href="classFairMQDevice.html">FairMQDevice</a> &)=delete</td></tr>
|
|
<tr class="memdesc:a806cf5c241bf95571654cd327d6e76fe"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor (disabled) <br /></td></tr>
|
|
<tr class="separator:a806cf5c241bf95571654cd327d6e76fe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa4e0098922aaf987c2a27c10f4e04fbd"><td class="memItemLeft" align="right" valign="top"><a id="aa4e0098922aaf987c2a27c10f4e04fbd"></a>
|
|
<a class="el" href="classFairMQDevice.html">FairMQDevice</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#aa4e0098922aaf987c2a27c10f4e04fbd">operator=</a> (const <a class="el" href="classFairMQDevice.html">FairMQDevice</a> &)=delete</td></tr>
|
|
<tr class="memdesc:aa4e0098922aaf987c2a27c10f4e04fbd"><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator (disabled) <br /></td></tr>
|
|
<tr class="separator:aa4e0098922aaf987c2a27c10f4e04fbd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a09389ba6934645ca406a963ab5a60e1a"><td class="memItemLeft" align="right" valign="top"><a id="a09389ba6934645ca406a963ab5a60e1a"></a>
|
|
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a09389ba6934645ca406a963ab5a60e1a">~FairMQDevice</a> ()</td></tr>
|
|
<tr class="memdesc:a09389ba6934645ca406a963ab5a60e1a"><td class="mdescLeft"> </td><td class="mdescRight">Default destructor. <br /></td></tr>
|
|
<tr class="separator:a09389ba6934645ca406a963ab5a60e1a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a12172d5f69916346c3a5dc10eae6e535"><td class="memItemLeft" align="right" valign="top"><a id="a12172d5f69916346c3a5dc10eae6e535"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a12172d5f69916346c3a5dc10eae6e535">CatchSignals</a> ()</td></tr>
|
|
<tr class="memdesc:a12172d5f69916346c3a5dc10eae6e535"><td class="mdescLeft"> </td><td class="mdescRight">Catches interrupt signals (SIGINT, SIGTERM) <br /></td></tr>
|
|
<tr class="separator:a12172d5f69916346c3a5dc10eae6e535"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a93c839b68f007bef8e66115efeed9d41"><td class="memItemLeft" align="right" valign="top"><a id="a93c839b68f007bef8e66115efeed9d41"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a93c839b68f007bef8e66115efeed9d41">LogSocketRates</a> ()</td></tr>
|
|
<tr class="memdesc:a93c839b68f007bef8e66115efeed9d41"><td class="mdescLeft"> </td><td class="mdescRight">Outputs the socket transfer rates. <br /></td></tr>
|
|
<tr class="separator:a93c839b68f007bef8e66115efeed9d41"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abae08c3f66ce0b36cbc7d688aad753cf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#abae08c3f66ce0b36cbc7d688aad753cf">SortChannel</a> (const std::string &name, const bool reindex=true)</td></tr>
|
|
<tr class="separator:abae08c3f66ce0b36cbc7d688aad753cf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4baa8f7c74791284cd46f0db3cc91efa"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a4baa8f7c74791284cd46f0db3cc91efa">PrintChannel</a> (const std::string &name)</td></tr>
|
|
<tr class="separator:a4baa8f7c74791284cd46f0db3cc91efa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a00ba7ec2625e0ce7d1bca9b602920d5b"><td class="memTemplParams" colspan="2"><a id="a00ba7ec2625e0ce7d1bca9b602920d5b"></a>
|
|
template<typename Serializer , typename DataType , typename... Args> </td></tr>
|
|
<tr class="memitem:a00ba7ec2625e0ce7d1bca9b602920d5b"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><b>Serialize</b> (<a class="el" href="classFairMQMessage.html">FairMQMessage</a> &msg, DataType &&data, Args &&... args) const</td></tr>
|
|
<tr class="separator:a00ba7ec2625e0ce7d1bca9b602920d5b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a262cb8fbbf7d828a4c076779e7566fed"><td class="memTemplParams" colspan="2"><a id="a262cb8fbbf7d828a4c076779e7566fed"></a>
|
|
template<typename Deserializer , typename DataType , typename... Args> </td></tr>
|
|
<tr class="memitem:a262cb8fbbf7d828a4c076779e7566fed"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><b>Deserialize</b> (<a class="el" href="classFairMQMessage.html">FairMQMessage</a> &msg, DataType &&data, Args &&... args) const</td></tr>
|
|
<tr class="separator:a262cb8fbbf7d828a4c076779e7566fed"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aebf22da96b350052fc9e75d08f946084"><td class="memItemLeft" align="right" valign="top"><a id="aebf22da96b350052fc9e75d08f946084"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>Send</b> (FairMQMessagePtr &msg, const std::string &chan, const int i=0) const</td></tr>
|
|
<tr class="separator:aebf22da96b350052fc9e75d08f946084"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad9668d3a7cd488f311d6b9a01df30f41"><td class="memItemLeft" align="right" valign="top"><a id="ad9668d3a7cd488f311d6b9a01df30f41"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>Receive</b> (FairMQMessagePtr &msg, const std::string &chan, const int i=0) const</td></tr>
|
|
<tr class="separator:ad9668d3a7cd488f311d6b9a01df30f41"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae0da59d660e7a7b93432e8c868e557a9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#ae0da59d660e7a7b93432e8c868e557a9">Send</a> (FairMQMessagePtr &msg, const std::string &chan, const int i, int sndTimeoutInMs) const</td></tr>
|
|
<tr class="separator:ae0da59d660e7a7b93432e8c868e557a9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7a975061e30b96b799564b2408e48c8e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a7a975061e30b96b799564b2408e48c8e">Receive</a> (FairMQMessagePtr &msg, const std::string &chan, const int i, int rcvTimeoutInMs) const</td></tr>
|
|
<tr class="separator:a7a975061e30b96b799564b2408e48c8e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1141a37ca7303a8da704a7c05c4cfb50"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a1141a37ca7303a8da704a7c05c4cfb50">SendAsync</a> (FairMQMessagePtr &msg, const std::string &chan, const int i=0) const</td></tr>
|
|
<tr class="separator:a1141a37ca7303a8da704a7c05c4cfb50"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5bfc5e8a75d4e2dc214ee10259041dfc"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a5bfc5e8a75d4e2dc214ee10259041dfc">ReceiveAsync</a> (FairMQMessagePtr &msg, const std::string &chan, const int i=0) const</td></tr>
|
|
<tr class="separator:a5bfc5e8a75d4e2dc214ee10259041dfc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac2ee72eb2e19966108b8eecb0d239180"><td class="memItemLeft" align="right" valign="top"><a id="ac2ee72eb2e19966108b8eecb0d239180"></a>
|
|
int64_t </td><td class="memItemRight" valign="bottom"><b>Send</b> (<a class="el" href="classFairMQParts.html">FairMQParts</a> &parts, const std::string &chan, const int i=0) const</td></tr>
|
|
<tr class="separator:ac2ee72eb2e19966108b8eecb0d239180"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3a58cec82ed9ccba87a10ea180fb475f"><td class="memItemLeft" align="right" valign="top"><a id="a3a58cec82ed9ccba87a10ea180fb475f"></a>
|
|
int64_t </td><td class="memItemRight" valign="bottom"><b>Receive</b> (<a class="el" href="classFairMQParts.html">FairMQParts</a> &parts, const std::string &chan, const int i=0) const</td></tr>
|
|
<tr class="separator:a3a58cec82ed9ccba87a10ea180fb475f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a354fca6325d0ea05d08cf672d138e698"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a354fca6325d0ea05d08cf672d138e698">Send</a> (<a class="el" href="classFairMQParts.html">FairMQParts</a> &parts, const std::string &chan, const int i, int sndTimeoutInMs) const</td></tr>
|
|
<tr class="separator:a354fca6325d0ea05d08cf672d138e698"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6d63916e2a5924d82e4380f500d5edfe"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a6d63916e2a5924d82e4380f500d5edfe">Receive</a> (<a class="el" href="classFairMQParts.html">FairMQParts</a> &parts, const std::string &chan, const int i, int rcvTimeoutInMs) const</td></tr>
|
|
<tr class="separator:a6d63916e2a5924d82e4380f500d5edfe"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3c2060363bfd91feb89eaca0dd1c3e99"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a3c2060363bfd91feb89eaca0dd1c3e99">SendAsync</a> (<a class="el" href="classFairMQParts.html">FairMQParts</a> &parts, const std::string &chan, const int i=0) const</td></tr>
|
|
<tr class="separator:a3c2060363bfd91feb89eaca0dd1c3e99"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8c7e504cf91fa786641014171b1e79c4"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a8c7e504cf91fa786641014171b1e79c4">ReceiveAsync</a> (<a class="el" href="classFairMQParts.html">FairMQParts</a> &parts, const std::string &chan, const int i=0) const</td></tr>
|
|
<tr class="separator:a8c7e504cf91fa786641014171b1e79c4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a930d9cf7f6be40c992c7e76e6609be74"><td class="memItemLeft" align="right" valign="top"><a id="a930d9cf7f6be40c992c7e76e6609be74"></a>
|
|
auto </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a930d9cf7f6be40c992c7e76e6609be74">Transport</a> () const -> const <a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> *</td></tr>
|
|
<tr class="memdesc:a930d9cf7f6be40c992c7e76e6609be74"><td class="mdescLeft"> </td><td class="mdescRight">Getter for default transport factory. <br /></td></tr>
|
|
<tr class="separator:a930d9cf7f6be40c992c7e76e6609be74"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac747441eeb6f46450630cdb77051123d"><td class="memTemplParams" colspan="2"><a id="ac747441eeb6f46450630cdb77051123d"></a>
|
|
template<typename... Args> </td></tr>
|
|
<tr class="memitem:ac747441eeb6f46450630cdb77051123d"><td class="memTemplItemLeft" align="right" valign="top">FairMQMessagePtr </td><td class="memTemplItemRight" valign="bottom"><b>NewMessage</b> (Args &&... args) const</td></tr>
|
|
<tr class="separator:ac747441eeb6f46450630cdb77051123d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9e5468ba94883594ea52c731eba8e579"><td class="memTemplParams" colspan="2"><a id="a9e5468ba94883594ea52c731eba8e579"></a>
|
|
template<typename... Args> </td></tr>
|
|
<tr class="memitem:a9e5468ba94883594ea52c731eba8e579"><td class="memTemplItemLeft" align="right" valign="top">FairMQMessagePtr </td><td class="memTemplItemRight" valign="bottom"><b>NewMessageFor</b> (const std::string &channel, int index, Args &&... args) const</td></tr>
|
|
<tr class="separator:a9e5468ba94883594ea52c731eba8e579"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2c81a51bb099ff55d1a35bfc645be7c3"><td class="memTemplParams" colspan="2"><a id="a2c81a51bb099ff55d1a35bfc645be7c3"></a>
|
|
template<typename T > </td></tr>
|
|
<tr class="memitem:a2c81a51bb099ff55d1a35bfc645be7c3"><td class="memTemplItemLeft" align="right" valign="top">FairMQMessagePtr </td><td class="memTemplItemRight" valign="bottom"><b>NewStaticMessage</b> (const T &data) const</td></tr>
|
|
<tr class="separator:a2c81a51bb099ff55d1a35bfc645be7c3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:addb42fab36c384b177426aa2390da2c9"><td class="memTemplParams" colspan="2"><a id="addb42fab36c384b177426aa2390da2c9"></a>
|
|
template<typename T > </td></tr>
|
|
<tr class="memitem:addb42fab36c384b177426aa2390da2c9"><td class="memTemplItemLeft" align="right" valign="top">FairMQMessagePtr </td><td class="memTemplItemRight" valign="bottom"><b>NewStaticMessageFor</b> (const std::string &channel, int index, const T &data) const</td></tr>
|
|
<tr class="separator:addb42fab36c384b177426aa2390da2c9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adbe2cb84078e483d7fbe8c3e73da2460"><td class="memTemplParams" colspan="2"><a id="adbe2cb84078e483d7fbe8c3e73da2460"></a>
|
|
template<typename T > </td></tr>
|
|
<tr class="memitem:adbe2cb84078e483d7fbe8c3e73da2460"><td class="memTemplItemLeft" align="right" valign="top">FairMQMessagePtr </td><td class="memTemplItemRight" valign="bottom"><b>NewSimpleMessage</b> (const T &data) const</td></tr>
|
|
<tr class="separator:adbe2cb84078e483d7fbe8c3e73da2460"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1673d10adbc8e303cf292d27f2f52443"><td class="memTemplParams" colspan="2"><a id="a1673d10adbc8e303cf292d27f2f52443"></a>
|
|
template<typename T > </td></tr>
|
|
<tr class="memitem:a1673d10adbc8e303cf292d27f2f52443"><td class="memTemplItemLeft" align="right" valign="top">FairMQMessagePtr </td><td class="memTemplItemRight" valign="bottom"><b>NewSimpleMessageFor</b> (const std::string &channel, int index, const T &data) const</td></tr>
|
|
<tr class="separator:a1673d10adbc8e303cf292d27f2f52443"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adcebde58f30f4c064fb1a98606ab11e0"><td class="memItemLeft" align="right" valign="top"><a id="adcebde58f30f4c064fb1a98606ab11e0"></a>
|
|
FairMQUnmanagedRegionPtr </td><td class="memItemRight" valign="bottom"><b>NewUnmanagedRegion</b> (const size_t size)</td></tr>
|
|
<tr class="separator:adcebde58f30f4c064fb1a98606ab11e0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5ef51f6b77404ec6ff6a4f5337600471"><td class="memItemLeft" align="right" valign="top"><a id="a5ef51f6b77404ec6ff6a4f5337600471"></a>
|
|
FairMQUnmanagedRegionPtr </td><td class="memItemRight" valign="bottom"><b>NewUnmanagedRegionFor</b> (const std::string &channel, int index, const size_t size, FairMQRegionCallback callback=nullptr)</td></tr>
|
|
<tr class="separator:a5ef51f6b77404ec6ff6a4f5337600471"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5d2e8221d94f404d18a73b6d06126e2a"><td class="memTemplParams" colspan="2"><a id="a5d2e8221d94f404d18a73b6d06126e2a"></a>
|
|
template<typename ... Ts> </td></tr>
|
|
<tr class="memitem:a5d2e8221d94f404d18a73b6d06126e2a"><td class="memTemplItemLeft" align="right" valign="top">FairMQPollerPtr </td><td class="memTemplItemRight" valign="bottom"><b>NewPoller</b> (const Ts &... inputs)</td></tr>
|
|
<tr class="separator:a5d2e8221d94f404d18a73b6d06126e2a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae8dd45bbd41649e243e907cd33586b23"><td class="memItemLeft" align="right" valign="top"><a id="ae8dd45bbd41649e243e907cd33586b23"></a>
|
|
FairMQPollerPtr </td><td class="memItemRight" valign="bottom"><b>NewPoller</b> (const std::vector< const <a class="el" href="classFairMQChannel.html">FairMQChannel</a> *> &channels)</td></tr>
|
|
<tr class="separator:ae8dd45bbd41649e243e907cd33586b23"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2b9ce9c70638251d4d6e37c3b5a1b4d3"><td class="memItemLeft" align="right" valign="top"><a id="a2b9ce9c70638251d4d6e37c3b5a1b4d3"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a2b9ce9c70638251d4d6e37c3b5a1b4d3">WaitForInitialValidation</a> ()</td></tr>
|
|
<tr class="memdesc:a2b9ce9c70638251d4d6e37c3b5a1b4d3"><td class="mdescLeft"> </td><td class="mdescRight">Waits for the first initialization run to finish. <br /></td></tr>
|
|
<tr class="separator:a2b9ce9c70638251d4d6e37c3b5a1b4d3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acfff124a29edee532a85f995a5930399"><td class="memItemLeft" align="right" valign="top">std::shared_ptr< <a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#acfff124a29edee532a85f995a5930399">AddTransport</a> (const std::string &transport)</td></tr>
|
|
<tr class="separator:acfff124a29edee532a85f995a5930399"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ade0dff241612213322085701041da2a4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#ade0dff241612213322085701041da2a4">SetTransport</a> (const std::string &transport="zeromq")</td></tr>
|
|
<tr class="separator:ade0dff241612213322085701041da2a4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0a6aa98500c7c66dbd216161251f75f7"><td class="memItemLeft" align="right" valign="top"><a id="a0a6aa98500c7c66dbd216161251f75f7"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>SetConfig</b> (<a class="el" href="classFairMQProgOptions.html">FairMQProgOptions</a> &config)</td></tr>
|
|
<tr class="separator:a0a6aa98500c7c66dbd216161251f75f7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a73af151490abb97c189f47638542540b"><td class="memItemLeft" align="right" valign="top"><a id="a73af151490abb97c189f47638542540b"></a>
|
|
const <a class="el" href="classFairMQProgOptions.html">FairMQProgOptions</a> * </td><td class="memItemRight" valign="bottom"><b>GetConfig</b> () const</td></tr>
|
|
<tr class="separator:a73af151490abb97c189f47638542540b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a27655622eac0524d86737aba269651d4"><td class="memTemplParams" colspan="2"><a id="a27655622eac0524d86737aba269651d4"></a>
|
|
template<typename T > </td></tr>
|
|
<tr class="memitem:a27655622eac0524d86737aba269651d4"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><b>OnData</b> (const std::string &channelName, bool(T::*memberFunction)(FairMQMessagePtr &msg, int index))</td></tr>
|
|
<tr class="separator:a27655622eac0524d86737aba269651d4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a719e0eece74b60c3459b265b1d8db1e1"><td class="memItemLeft" align="right" valign="top"><a id="a719e0eece74b60c3459b265b1d8db1e1"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>OnData</b> (const std::string &channelName, InputMsgCallback callback)</td></tr>
|
|
<tr class="separator:a719e0eece74b60c3459b265b1d8db1e1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4abc9d4a453670012fc317fe534e875b"><td class="memTemplParams" colspan="2"><a id="a4abc9d4a453670012fc317fe534e875b"></a>
|
|
template<typename T > </td></tr>
|
|
<tr class="memitem:a4abc9d4a453670012fc317fe534e875b"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><b>OnData</b> (const std::string &channelName, bool(T::*memberFunction)(<a class="el" href="classFairMQParts.html">FairMQParts</a> &parts, int index))</td></tr>
|
|
<tr class="separator:a4abc9d4a453670012fc317fe534e875b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0b136382dd08310521501ff4ab6de884"><td class="memItemLeft" align="right" valign="top"><a id="a0b136382dd08310521501ff4ab6de884"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>OnData</b> (const std::string &channelName, InputMultipartCallback callback)</td></tr>
|
|
<tr class="separator:a0b136382dd08310521501ff4ab6de884"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab9dfb7d4744f5145b0438f73653b203e"><td class="memItemLeft" align="right" valign="top"><a id="ab9dfb7d4744f5145b0438f73653b203e"></a>
|
|
const <a class="el" href="classFairMQChannel.html">FairMQChannel</a> & </td><td class="memItemRight" valign="bottom"><b>GetChannel</b> (const std::string &channelName, const int index=0) const</td></tr>
|
|
<tr class="separator:ab9dfb7d4744f5145b0438f73653b203e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a36a6ae99b44226a2bdf8de4be6c50ef8"><td class="memItemLeft" align="right" valign="top"><a id="a36a6ae99b44226a2bdf8de4be6c50ef8"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>RegisterChannelEndpoints</b> ()</td></tr>
|
|
<tr class="separator:a36a6ae99b44226a2bdf8de4be6c50ef8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a25c5f3615712f0e4e3aa2667c96be286"><td class="memItemLeft" align="right" valign="top"><a id="a25c5f3615712f0e4e3aa2667c96be286"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>RegisterChannelEndpoint</b> (const std::string &channelName, uint16_t minNumSubChannels=1, uint16_t maxNumSubChannels=1)</td></tr>
|
|
<tr class="separator:a25c5f3615712f0e4e3aa2667c96be286"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0f2eba92316c226ff1daebd5d8de25c4"><td class="memItemLeft" align="right" valign="top"><a id="a0f2eba92316c226ff1daebd5d8de25c4"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>PrintRegisteredChannels</b> ()</td></tr>
|
|
<tr class="separator:a0f2eba92316c226ff1daebd5d8de25c4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a12a348be5f441e0527aae654f9859a89"><td class="memItemLeft" align="right" valign="top"><a id="a12a348be5f441e0527aae654f9859a89"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>SetId</b> (const std::string &id)</td></tr>
|
|
<tr class="separator:a12a348be5f441e0527aae654f9859a89"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4385f446208320a17c22bcbf663c6173"><td class="memItemLeft" align="right" valign="top"><a id="a4385f446208320a17c22bcbf663c6173"></a>
|
|
std::string </td><td class="memItemRight" valign="bottom"><b>GetId</b> ()</td></tr>
|
|
<tr class="separator:a4385f446208320a17c22bcbf663c6173"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab0ad1bbc9ab4452d57460c5ceffa8f47"><td class="memItemLeft" align="right" valign="top"><a id="ab0ad1bbc9ab4452d57460c5ceffa8f47"></a>
|
|
const <a class="el" href="structfair_1_1mq_1_1tools_1_1Version.html">fair::mq::tools::Version</a> </td><td class="memItemRight" valign="bottom"><b>GetVersion</b> () const</td></tr>
|
|
<tr class="separator:ab0ad1bbc9ab4452d57460c5ceffa8f47"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8a64447bc7fa3ca55c6ff004a3d8c2f8"><td class="memItemLeft" align="right" valign="top"><a id="a8a64447bc7fa3ca55c6ff004a3d8c2f8"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>SetNumIoThreads</b> (int numIoThreads)</td></tr>
|
|
<tr class="separator:a8a64447bc7fa3ca55c6ff004a3d8c2f8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a23428fcb596e66ca3e7d3ca2776bd890"><td class="memItemLeft" align="right" valign="top"><a id="a23428fcb596e66ca3e7d3ca2776bd890"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>GetNumIoThreads</b> () const</td></tr>
|
|
<tr class="separator:a23428fcb596e66ca3e7d3ca2776bd890"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a61c11a8bf929d642309f87faf5594c33"><td class="memItemLeft" align="right" valign="top"><a id="a61c11a8bf929d642309f87faf5594c33"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>SetPortRangeMin</b> (int portRangeMin)</td></tr>
|
|
<tr class="separator:a61c11a8bf929d642309f87faf5594c33"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a70588c38d266c66f839a5a9fd65ed9fa"><td class="memItemLeft" align="right" valign="top"><a id="a70588c38d266c66f839a5a9fd65ed9fa"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>GetPortRangeMin</b> () const</td></tr>
|
|
<tr class="separator:a70588c38d266c66f839a5a9fd65ed9fa"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6c7e3a6c8733ea3974f51e1b67d55db3"><td class="memItemLeft" align="right" valign="top"><a id="a6c7e3a6c8733ea3974f51e1b67d55db3"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>SetPortRangeMax</b> (int portRangeMax)</td></tr>
|
|
<tr class="separator:a6c7e3a6c8733ea3974f51e1b67d55db3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a98204e435f1e7b083468c336dab8b8ad"><td class="memItemLeft" align="right" valign="top"><a id="a98204e435f1e7b083468c336dab8b8ad"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>GetPortRangeMax</b> () const</td></tr>
|
|
<tr class="separator:a98204e435f1e7b083468c336dab8b8ad"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abad4a2ad5a139ebaf2f851bd5d037734"><td class="memItemLeft" align="right" valign="top"><a id="abad4a2ad5a139ebaf2f851bd5d037734"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>SetNetworkInterface</b> (const std::string &networkInterface)</td></tr>
|
|
<tr class="separator:abad4a2ad5a139ebaf2f851bd5d037734"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1cbde24481b77946f5b1972e52de5aba"><td class="memItemLeft" align="right" valign="top"><a id="a1cbde24481b77946f5b1972e52de5aba"></a>
|
|
std::string </td><td class="memItemRight" valign="bottom"><b>GetNetworkInterface</b> () const</td></tr>
|
|
<tr class="separator:a1cbde24481b77946f5b1972e52de5aba"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afb2fdb0b3b95d51b822b3dae222dbc8b"><td class="memItemLeft" align="right" valign="top"><a id="afb2fdb0b3b95d51b822b3dae222dbc8b"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>SetDefaultTransport</b> (const std::string &defaultTransport)</td></tr>
|
|
<tr class="separator:afb2fdb0b3b95d51b822b3dae222dbc8b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aec098ab7833ecf3eaeec6f8aa6aed724"><td class="memItemLeft" align="right" valign="top"><a id="aec098ab7833ecf3eaeec6f8aa6aed724"></a>
|
|
std::string </td><td class="memItemRight" valign="bottom"><b>GetDefaultTransport</b> () const</td></tr>
|
|
<tr class="separator:aec098ab7833ecf3eaeec6f8aa6aed724"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9d6601afdcb976b5ad3e88d2628e2fdb"><td class="memItemLeft" align="right" valign="top"><a id="a9d6601afdcb976b5ad3e88d2628e2fdb"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>SetInitializationTimeoutInS</b> (int initializationTimeoutInS)</td></tr>
|
|
<tr class="separator:a9d6601afdcb976b5ad3e88d2628e2fdb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a775346131cdcccf70fdbefa4d3ea7433"><td class="memItemLeft" align="right" valign="top"><a id="a775346131cdcccf70fdbefa4d3ea7433"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>GetInitializationTimeoutInS</b> () const</td></tr>
|
|
<tr class="separator:a775346131cdcccf70fdbefa4d3ea7433"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="inherit_header pub_methods_classFairMQStateMachine"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classFairMQStateMachine')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classFairMQStateMachine.html">FairMQStateMachine</a></td></tr>
|
|
<tr class="memitem:a9ee523fe4940a663c909fce8a51b10f3 inherit pub_methods_classFairMQStateMachine"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQStateMachine.html#a9ee523fe4940a663c909fce8a51b10f3">FairMQStateMachine</a> ()</td></tr>
|
|
<tr class="separator:a9ee523fe4940a663c909fce8a51b10f3 inherit pub_methods_classFairMQStateMachine"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:addf56a5817575421a74fa25bfdfb0662 inherit pub_methods_classFairMQStateMachine"><td class="memItemLeft" align="right" valign="top"><a id="addf56a5817575421a74fa25bfdfb0662"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>GetInterfaceVersion</b> () const</td></tr>
|
|
<tr class="separator:addf56a5817575421a74fa25bfdfb0662 inherit pub_methods_classFairMQStateMachine"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1ffc3496e92ad11f5bc4946d2d7c7b2d inherit pub_methods_classFairMQStateMachine"><td class="memItemLeft" align="right" valign="top"><a id="a1ffc3496e92ad11f5bc4946d2d7c7b2d"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>ChangeState</b> (int event)</td></tr>
|
|
<tr class="separator:a1ffc3496e92ad11f5bc4946d2d7c7b2d inherit pub_methods_classFairMQStateMachine"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a553ab468a73db9c950471cd04eee7582 inherit pub_methods_classFairMQStateMachine"><td class="memItemLeft" align="right" valign="top"><a id="a553ab468a73db9c950471cd04eee7582"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>ChangeState</b> (const std::string &event)</td></tr>
|
|
<tr class="separator:a553ab468a73db9c950471cd04eee7582 inherit pub_methods_classFairMQStateMachine"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aecf55e25c6c70bbeb692ab8d15b0872b inherit pub_methods_classFairMQStateMachine"><td class="memItemLeft" align="right" valign="top"><a id="aecf55e25c6c70bbeb692ab8d15b0872b"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>WaitForEndOfState</b> (int event)</td></tr>
|
|
<tr class="separator:aecf55e25c6c70bbeb692ab8d15b0872b inherit pub_methods_classFairMQStateMachine"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a532450b98022bdeca317da193f66e9cb inherit pub_methods_classFairMQStateMachine"><td class="memItemLeft" align="right" valign="top"><a id="a532450b98022bdeca317da193f66e9cb"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>WaitForEndOfState</b> (const std::string &event)</td></tr>
|
|
<tr class="separator:a532450b98022bdeca317da193f66e9cb inherit pub_methods_classFairMQStateMachine"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5443a5c5fec5d233249e8f688326cecb inherit pub_methods_classFairMQStateMachine"><td class="memItemLeft" align="right" valign="top"><a id="a5443a5c5fec5d233249e8f688326cecb"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>WaitForEndOfStateForMs</b> (int event, int durationInMs)</td></tr>
|
|
<tr class="separator:a5443a5c5fec5d233249e8f688326cecb inherit pub_methods_classFairMQStateMachine"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad775927113eaedbf8a10b32d0114449a inherit pub_methods_classFairMQStateMachine"><td class="memItemLeft" align="right" valign="top"><a id="ad775927113eaedbf8a10b32d0114449a"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>WaitForEndOfStateForMs</b> (const std::string &event, int durationInMs)</td></tr>
|
|
<tr class="separator:ad775927113eaedbf8a10b32d0114449a inherit pub_methods_classFairMQStateMachine"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6c6099c92d83f54c81ac92cf45719690 inherit pub_methods_classFairMQStateMachine"><td class="memItemLeft" align="right" valign="top"><a id="a6c6099c92d83f54c81ac92cf45719690"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>SubscribeToStateChange</b> (const std::string &key, std::function< void(const State)> callback)</td></tr>
|
|
<tr class="separator:a6c6099c92d83f54c81ac92cf45719690 inherit pub_methods_classFairMQStateMachine"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5e2e0243459ebfec7e2a9a9ad4fbd3bc inherit pub_methods_classFairMQStateMachine"><td class="memItemLeft" align="right" valign="top"><a id="a5e2e0243459ebfec7e2a9a9ad4fbd3bc"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>UnsubscribeFromStateChange</b> (const std::string &key)</td></tr>
|
|
<tr class="separator:a5e2e0243459ebfec7e2a9a9ad4fbd3bc inherit pub_methods_classFairMQStateMachine"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
|
|
Static Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a919ea3be67da09c1a2f2f049410589c7"><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a919ea3be67da09c1a2f2f049410589c7">SortSocketsByAddress</a> (const <a class="el" href="classFairMQChannel.html">FairMQChannel</a> &lhs, const <a class="el" href="classFairMQChannel.html">FairMQChannel</a> &rhs)</td></tr>
|
|
<tr class="separator:a919ea3be67da09c1a2f2f049410589c7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
|
|
Public Attributes</h2></td></tr>
|
|
<tr class="memitem:ad6e090504ceef5799b6f85b136d1e547"><td class="memItemLeft" align="right" valign="top"><a id="ad6e090504ceef5799b6f85b136d1e547"></a>
|
|
std::unordered_map< std::string, std::vector< <a class="el" href="classFairMQChannel.html">FairMQChannel</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#ad6e090504ceef5799b6f85b136d1e547">fChannels</a></td></tr>
|
|
<tr class="memdesc:ad6e090504ceef5799b6f85b136d1e547"><td class="mdescLeft"> </td><td class="mdescRight">Device channels. <br /></td></tr>
|
|
<tr class="separator:ad6e090504ceef5799b6f85b136d1e547"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a01a7d955417385b42fdbf8b263e055b7"><td class="memItemLeft" align="right" valign="top"><a id="a01a7d955417385b42fdbf8b263e055b7"></a>
|
|
<a class="el" href="classFairMQProgOptions.html">FairMQProgOptions</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a01a7d955417385b42fdbf8b263e055b7">fConfig</a></td></tr>
|
|
<tr class="memdesc:a01a7d955417385b42fdbf8b263e055b7"><td class="mdescLeft"> </td><td class="mdescRight">Program options configuration. <br /></td></tr>
|
|
<tr class="separator:a01a7d955417385b42fdbf8b263e055b7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr class="memitem:a3d67868b1c926c0a5daf2616d86fcc58"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a3d67868b1c926c0a5daf2616d86fcc58">Init</a> ()</td></tr>
|
|
<tr class="separator:a3d67868b1c926c0a5daf2616d86fcc58"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a906102a56177105296576938af6e59e5"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a906102a56177105296576938af6e59e5">InitTask</a> ()</td></tr>
|
|
<tr class="separator:a906102a56177105296576938af6e59e5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab39e52445f8db507569d09e2539d2dc0"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#ab39e52445f8db507569d09e2539d2dc0">Run</a> ()</td></tr>
|
|
<tr class="separator:ab39e52445f8db507569d09e2539d2dc0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2d6cbe87d8c8e2752523c68049afbe5c"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a2d6cbe87d8c8e2752523c68049afbe5c">PreRun</a> ()</td></tr>
|
|
<tr class="separator:a2d6cbe87d8c8e2752523c68049afbe5c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a964f6e5883b66e7253d58165c66926c8"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a964f6e5883b66e7253d58165c66926c8">ConditionalRun</a> ()</td></tr>
|
|
<tr class="separator:a964f6e5883b66e7253d58165c66926c8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0366c2a8bc2712d4e089b9a2d2a23859"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a0366c2a8bc2712d4e089b9a2d2a23859">PostRun</a> ()</td></tr>
|
|
<tr class="separator:a0366c2a8bc2712d4e089b9a2d2a23859"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aee7780d7ed486ee0212fb3defc68b48d"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#aee7780d7ed486ee0212fb3defc68b48d">Pause</a> ()</td></tr>
|
|
<tr class="separator:aee7780d7ed486ee0212fb3defc68b48d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5e5dfb96b4b897295bbb6696f58fdd10"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a5e5dfb96b4b897295bbb6696f58fdd10">ResetTask</a> ()</td></tr>
|
|
<tr class="separator:a5e5dfb96b4b897295bbb6696f58fdd10"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac202bcd74838d228bc99aafbebf1fe7c"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#ac202bcd74838d228bc99aafbebf1fe7c">Reset</a> ()</td></tr>
|
|
<tr class="separator:ac202bcd74838d228bc99aafbebf1fe7c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
|
|
Protected Attributes</h2></td></tr>
|
|
<tr class="memitem:a1c67c4cbd6140f35292b13e485f39ce0"><td class="memItemLeft" align="right" valign="top"><a id="a1c67c4cbd6140f35292b13e485f39ce0"></a>
|
|
std::shared_ptr< <a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a1c67c4cbd6140f35292b13e485f39ce0">fTransportFactory</a></td></tr>
|
|
<tr class="memdesc:a1c67c4cbd6140f35292b13e485f39ce0"><td class="mdescLeft"> </td><td class="mdescRight">Transport factory. <br /></td></tr>
|
|
<tr class="separator:a1c67c4cbd6140f35292b13e485f39ce0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a52c63dca723d7b2765adf8a927def5cb"><td class="memItemLeft" align="right" valign="top"><a id="a52c63dca723d7b2765adf8a927def5cb"></a>
|
|
std::unordered_map< FairMQ::Transport, std::shared_ptr< <a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a52c63dca723d7b2765adf8a927def5cb">fTransports</a></td></tr>
|
|
<tr class="memdesc:a52c63dca723d7b2765adf8a927def5cb"><td class="mdescLeft"> </td><td class="mdescRight">Container for transports. <br /></td></tr>
|
|
<tr class="separator:a52c63dca723d7b2765adf8a927def5cb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a13141f54111f5f724b79143b4303a32f"><td class="memItemLeft" align="right" valign="top"><a id="a13141f54111f5f724b79143b4303a32f"></a>
|
|
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a13141f54111f5f724b79143b4303a32f">fId</a></td></tr>
|
|
<tr class="memdesc:a13141f54111f5f724b79143b4303a32f"><td class="mdescLeft"> </td><td class="mdescRight">Device ID. <br /></td></tr>
|
|
<tr class="separator:a13141f54111f5f724b79143b4303a32f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1345906d840bd4dc001990766add9f11"><td class="memItemLeft" align="right" valign="top"><a id="a1345906d840bd4dc001990766add9f11"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a1345906d840bd4dc001990766add9f11">fNumIoThreads</a></td></tr>
|
|
<tr class="memdesc:a1345906d840bd4dc001990766add9f11"><td class="mdescLeft"> </td><td class="mdescRight">Number of ZeroMQ I/O threads. <br /></td></tr>
|
|
<tr class="separator:a1345906d840bd4dc001990766add9f11"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
|
|
Friends</h2></td></tr>
|
|
<tr class="memitem:ad5f4bdef909581fd5301ef80ab7757b2"><td class="memItemLeft" align="right" valign="top"><a id="ad5f4bdef909581fd5301ef80ab7757b2"></a>
|
|
class </td><td class="memItemRight" valign="bottom"><b>FairMQChannel</b></td></tr>
|
|
<tr class="separator:ad5f4bdef909581fd5301ef80ab7757b2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
|
|
Additional Inherited Members</h2></td></tr>
|
|
<tr class="inherit_header pub_types_classFairMQStateMachine"><td colspan="2" onclick="javascript:toggleInherit('pub_types_classFairMQStateMachine')"><img src="closed.png" alt="-"/> Public Types inherited from <a class="el" href="classFairMQStateMachine.html">FairMQStateMachine</a></td></tr>
|
|
<tr class="memitem:a40422459e6d1e5427c46d7651ed2e616 inherit pub_types_classFairMQStateMachine"><td class="memItemLeft" align="right" valign="top"><a id="a40422459e6d1e5427c46d7651ed2e616"></a>enum  </td><td class="memItemRight" valign="bottom"><b>Event</b> { <br />
|
|
  <b>INIT_DEVICE</b>,
|
|
<b>internal_DEVICE_READY</b>,
|
|
<b>INIT_TASK</b>,
|
|
<b>internal_READY</b>,
|
|
<br />
|
|
  <b>RUN</b>,
|
|
<b>PAUSE</b>,
|
|
<b>STOP</b>,
|
|
<b>RESET_TASK</b>,
|
|
<br />
|
|
  <b>RESET_DEVICE</b>,
|
|
<b>internal_IDLE</b>,
|
|
<b>END</b>,
|
|
<b>ERROR_FOUND</b>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="separator:a40422459e6d1e5427c46d7651ed2e616 inherit pub_types_classFairMQStateMachine"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="acfff124a29edee532a85f995a5930399"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acfff124a29edee532a85f995a5930399">◆ </a></span>AddTransport()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">shared_ptr< <a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> > FairMQDevice::AddTransport </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>transport</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Adds a transport to the device if it doesn't exist </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">transport</td><td>Transport string ("zeromq"/"nanomsg"/"shmem") </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a964f6e5883b66e7253d58165c66926c8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a964f6e5883b66e7253d58165c66926c8">◆ </a></span>ConditionalRun()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool FairMQDevice::ConditionalRun </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Called during RUNNING state repeatedly until it returns false or device state changes Executed in a worker thread </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3d67868b1c926c0a5daf2616d86fcc58"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3d67868b1c926c0a5daf2616d86fcc58">◆ </a></span>Init()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FairMQDevice::Init </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Additional user initialization (can be overloaded in child classes). Prefer to use <a class="el" href="classFairMQDevice.html#a906102a56177105296576938af6e59e5">InitTask()</a>. Executed in a worker thread </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="classFairMQShmPrototypeSampler.html#ad6e484cfb781998d9158f73ee2cda4cd">FairMQShmPrototypeSampler</a>, and <a class="el" href="classFairMQShmPrototypeSink.html#a2e69b86d6a8e04359c9a8e64a5edd130">FairMQShmPrototypeSink</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a906102a56177105296576938af6e59e5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a906102a56177105296576938af6e59e5">◆ </a></span>InitTask()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FairMQDevice::InitTask </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Task initialization (can be overloaded in child classes) Executed in a worker thread </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="classFairMQBenchmarkSampler.html#aa515049fe636820d5bdb2032d5e3978c">FairMQBenchmarkSampler</a>, <a class="el" href="classFairMQSink.html#acd247d4a876236eeb4034f2737de4651">FairMQSink</a>, <a class="el" href="classFairMQMerger.html#a77dc099209a49cec13493e1ec2953411">FairMQMerger</a>, <a class="el" href="classFairMQSplitter.html#a526a6f7801024963f684979da14346cc">FairMQSplitter</a>, <a class="el" href="classFairMQProxy.html#a7d56b95f6c658183467c3b791884ec03">FairMQProxy</a>, and <a class="el" href="classFairMQMultiplier.html#a0ff397b6656cd0e101d5cd27e98cf10b">FairMQMultiplier</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aee7780d7ed486ee0212fb3defc68b48d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aee7780d7ed486ee0212fb3defc68b48d">◆ </a></span>Pause()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FairMQDevice::Pause </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Handles the PAUSE state Executed in a worker thread </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0366c2a8bc2712d4e089b9a2d2a23859"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0366c2a8bc2712d4e089b9a2d2a23859">◆ </a></span>PostRun()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FairMQDevice::PostRun </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Called in the RUNNING state once after executing the <a class="el" href="classFairMQDevice.html#ab39e52445f8db507569d09e2539d2dc0">Run()</a>/ConditionalRun() method Executed in a worker thread </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="classFairMQBenchmarkSampler.html#a3ae9bb00c511c20e66adf302392c9932">FairMQBenchmarkSampler</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2d6cbe87d8c8e2752523c68049afbe5c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2d6cbe87d8c8e2752523c68049afbe5c">◆ </a></span>PreRun()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FairMQDevice::PreRun </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Called in the RUNNING state once before executing the <a class="el" href="classFairMQDevice.html#ab39e52445f8db507569d09e2539d2dc0">Run()</a>/ConditionalRun() method Executed in a worker thread </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="classFairMQBenchmarkSampler.html#a58075c668532bc033a25177626e1febd">FairMQBenchmarkSampler</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4baa8f7c74791284cd46f0db3cc91efa"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4baa8f7c74791284cd46f0db3cc91efa">◆ </a></span>PrintChannel()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FairMQDevice::PrintChannel </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>name</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Prints channel configuration </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">name</td><td>Name of the channel </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7a975061e30b96b799564b2408e48c8e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7a975061e30b96b799564b2408e48c8e">◆ </a></span>Receive() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int FairMQDevice::Receive </td>
|
|
<td>(</td>
|
|
<td class="paramtype">FairMQMessagePtr & </td>
|
|
<td class="paramname"><em>msg</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>chan</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>i</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>rcvTimeoutInMs</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Shorthand method to receive <code>msg</code> on <code>chan</code> at index <code>i</code> </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">msg</td><td>message reference </td></tr>
|
|
<tr><td class="paramname">chan</td><td>channel name </td></tr>
|
|
<tr><td class="paramname">i</td><td>channel index </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of bytes that have been received. -2 If reading from the queue was not possible or timed out. In case of errors, returns -1. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6d63916e2a5924d82e4380f500d5edfe"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6d63916e2a5924d82e4380f500d5edfe">◆ </a></span>Receive() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int64_t FairMQDevice::Receive </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classFairMQParts.html">FairMQParts</a> & </td>
|
|
<td class="paramname"><em>parts</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>chan</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>i</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>rcvTimeoutInMs</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Shorthand method to receive <a class="el" href="classFairMQParts.html" title="FairMQParts is a lightweight convenience wrapper around a vector of unique pointers to FairMQMessage...">FairMQParts</a> on <code>chan</code> at index <code>i</code> </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">parts</td><td>parts reference </td></tr>
|
|
<tr><td class="paramname">chan</td><td>channel name </td></tr>
|
|
<tr><td class="paramname">i</td><td>channel index </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of bytes that have been received. -2 If reading from the queue was not possible or timed out. In case of errors, returns -1. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5bfc5e8a75d4e2dc214ee10259041dfc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5bfc5e8a75d4e2dc214ee10259041dfc">◆ </a></span>ReceiveAsync() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int FairMQDevice::ReceiveAsync </td>
|
|
<td>(</td>
|
|
<td class="paramtype">FairMQMessagePtr & </td>
|
|
<td class="paramname"><em>msg</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>chan</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>i</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Shorthand method to receive <code>msg</code> on <code>chan</code> at index <code>i</code> without blocking </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">msg</td><td>message reference </td></tr>
|
|
<tr><td class="paramname">chan</td><td>channel name </td></tr>
|
|
<tr><td class="paramname">i</td><td>channel index </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of bytes that have been received. -2 If reading from the queue was not possible or timed out. In case of errors, returns -1. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8c7e504cf91fa786641014171b1e79c4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8c7e504cf91fa786641014171b1e79c4">◆ </a></span>ReceiveAsync() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int64_t FairMQDevice::ReceiveAsync </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classFairMQParts.html">FairMQParts</a> & </td>
|
|
<td class="paramname"><em>parts</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>chan</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>i</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Shorthand method to receive <a class="el" href="classFairMQParts.html" title="FairMQParts is a lightweight convenience wrapper around a vector of unique pointers to FairMQMessage...">FairMQParts</a> on <code>chan</code> at index <code>i</code> without blocking </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">parts</td><td>parts reference </td></tr>
|
|
<tr><td class="paramname">chan</td><td>channel name </td></tr>
|
|
<tr><td class="paramname">i</td><td>channel index </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of bytes that have been received. -2 If reading from the queue was not possible or timed out. In case of errors, returns -1. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac202bcd74838d228bc99aafbebf1fe7c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac202bcd74838d228bc99aafbebf1fe7c">◆ </a></span>Reset()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FairMQDevice::Reset </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Resets the device (can be overloaded in child classes) Executed in a worker thread </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5e5dfb96b4b897295bbb6696f58fdd10"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5e5dfb96b4b897295bbb6696f58fdd10">◆ </a></span>ResetTask()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FairMQDevice::ResetTask </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Resets the user task (to be overloaded in child classes) Executed in a worker thread </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab39e52445f8db507569d09e2539d2dc0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab39e52445f8db507569d09e2539d2dc0">◆ </a></span>Run()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FairMQDevice::Run </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Runs the device (to be overloaded in child classes) Executed in a worker thread </p>
|
|
|
|
<p>Reimplemented in <a class="el" href="classFairMQBenchmarkSampler.html#ae016fde6952dcd0ed671b4a6c51cb835">FairMQBenchmarkSampler</a>, <a class="el" href="classFairMQSink.html#aa49bd0e5ee1274eff043695902a65872">FairMQSink</a>, <a class="el" href="classFairMQShmPrototypeSampler.html#a53a196a25a3517775e584cc5ed987ce1">FairMQShmPrototypeSampler</a>, <a class="el" href="classFairMQShmPrototypeSink.html#a4806dcbec20dbdaa42c59ec934eb2f7a">FairMQShmPrototypeSink</a>, <a class="el" href="classFairMQMerger.html#a7f38f3fe9b3bc3ab9122a40acbc4bdbc">FairMQMerger</a>, and <a class="el" href="classFairMQProxy.html#a1faed0cf55925312d0d53d356edeaf35">FairMQProxy</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae0da59d660e7a7b93432e8c868e557a9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae0da59d660e7a7b93432e8c868e557a9">◆ </a></span>Send() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int FairMQDevice::Send </td>
|
|
<td>(</td>
|
|
<td class="paramtype">FairMQMessagePtr & </td>
|
|
<td class="paramname"><em>msg</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>chan</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>i</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>sndTimeoutInMs</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Shorthand method to send <code>msg</code> on <code>chan</code> at index <code>i</code> </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">msg</td><td>message reference </td></tr>
|
|
<tr><td class="paramname">chan</td><td>channel name </td></tr>
|
|
<tr><td class="paramname">i</td><td>channel index </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of bytes that have been queued. -2 If queueing was not possible or timed out. In case of errors, returns -1. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a354fca6325d0ea05d08cf672d138e698"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a354fca6325d0ea05d08cf672d138e698">◆ </a></span>Send() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int64_t FairMQDevice::Send </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classFairMQParts.html">FairMQParts</a> & </td>
|
|
<td class="paramname"><em>parts</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>chan</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>i</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>sndTimeoutInMs</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Shorthand method to send <a class="el" href="classFairMQParts.html" title="FairMQParts is a lightweight convenience wrapper around a vector of unique pointers to FairMQMessage...">FairMQParts</a> on <code>chan</code> at index <code>i</code> </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">parts</td><td>parts reference </td></tr>
|
|
<tr><td class="paramname">chan</td><td>channel name </td></tr>
|
|
<tr><td class="paramname">i</td><td>channel index </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of bytes that have been queued. -2 If queueing was not possible or timed out. In case of errors, returns -1. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1141a37ca7303a8da704a7c05c4cfb50"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1141a37ca7303a8da704a7c05c4cfb50">◆ </a></span>SendAsync() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int FairMQDevice::SendAsync </td>
|
|
<td>(</td>
|
|
<td class="paramtype">FairMQMessagePtr & </td>
|
|
<td class="paramname"><em>msg</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>chan</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>i</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Shorthand method to send <code>msg</code> on <code>chan</code> at index <code>i</code> without blocking </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">msg</td><td>message reference </td></tr>
|
|
<tr><td class="paramname">chan</td><td>channel name </td></tr>
|
|
<tr><td class="paramname">i</td><td>channel index </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of bytes that have been queued. -2 If queueing was not possible or timed out. In case of errors, returns -1. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3c2060363bfd91feb89eaca0dd1c3e99"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3c2060363bfd91feb89eaca0dd1c3e99">◆ </a></span>SendAsync() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int64_t FairMQDevice::SendAsync </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classFairMQParts.html">FairMQParts</a> & </td>
|
|
<td class="paramname"><em>parts</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>chan</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>i</em> = <code>0</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Shorthand method to send <a class="el" href="classFairMQParts.html" title="FairMQParts is a lightweight convenience wrapper around a vector of unique pointers to FairMQMessage...">FairMQParts</a> on <code>chan</code> at index <code>i</code> without blocking </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">parts</td><td>parts reference </td></tr>
|
|
<tr><td class="paramname">chan</td><td>channel name </td></tr>
|
|
<tr><td class="paramname">i</td><td>channel index </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of bytes that have been queued. -2 If queueing was not possible or timed out. In case of errors, returns -1. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ade0dff241612213322085701041da2a4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ade0dff241612213322085701041da2a4">◆ </a></span>SetTransport()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FairMQDevice::SetTransport </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>transport</em> = <code>"zeromq"</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Sets the default transport for the device </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">transport</td><td>Transport string ("zeromq"/"nanomsg"/"shmem") </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abae08c3f66ce0b36cbc7d688aad753cf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abae08c3f66ce0b36cbc7d688aad753cf">◆ </a></span>SortChannel()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FairMQDevice::SortChannel </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>name</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const bool </td>
|
|
<td class="paramname"><em>reindex</em> = <code>true</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Sorts a channel by address, with optional reindexing of the sorted values </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">name</td><td>Channel name </td></tr>
|
|
<tr><td class="paramname">reindex</td><td>Should reindexing be done </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a919ea3be67da09c1a2f2f049410589c7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a919ea3be67da09c1a2f2f049410589c7">◆ </a></span>SortSocketsByAddress()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool FairMQDevice::SortSocketsByAddress </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="classFairMQChannel.html">FairMQChannel</a> & </td>
|
|
<td class="paramname"><em>lhs</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="classFairMQChannel.html">FairMQChannel</a> & </td>
|
|
<td class="paramname"><em>rhs</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Implements the sort algorithm used in <a class="el" href="classFairMQDevice.html#abae08c3f66ce0b36cbc7d688aad753cf">SortChannel()</a> </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">lhs</td><td>Right hand side value for comparison </td></tr>
|
|
<tr><td class="paramname">rhs</td><td>Left hand side value for comparison </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>fairmq/<a class="el" href="FairMQDevice_8h_source.html">FairMQDevice.h</a></li>
|
|
<li>fairmq/FairMQDevice.cxx</li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</body>
|
|
</html>
|