mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 08:41:16 +00:00
908 lines
76 KiB
HTML
908 lines
76 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.14"/>
|
|
<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.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><!-- 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="node3" href="classFairMQBenchmarkSampler.html" title="FairMQBenchmarkSampler" alt="" coords="352,5,531,32"/>
|
|
<area shape="rect" id="node4" href="classFairMQMerger.html" title="FairMQMerger" alt="" coords="389,56,494,83"/>
|
|
<area shape="rect" id="node5" href="classFairMQMultiplier.html" title="FairMQMultiplier" alt="" coords="383,107,500,133"/>
|
|
<area shape="rect" id="node6" href="classFairMQProxy.html" title="FairMQProxy" alt="" coords="392,157,491,184"/>
|
|
<area shape="rect" id="node7" href="classFairMQSink.html" title="FairMQSink" alt="" coords="396,208,487,235"/>
|
|
<area shape="rect" id="node8" href="classFairMQSplitter.html" title="FairMQSplitter" alt="" coords="388,259,495,285"/>
|
|
<area shape="rect" id="node9" href="classMyDevice.html" title="MyDevice" alt="" coords="401,309,481,336"/>
|
|
<area shape="rect" id="node2" href="classFairMQStateMachine.html" title="FairMQStateMachine" alt="" coords="5,157,151,184"/>
|
|
</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="5,5,151,32"/>
|
|
<area shape="rect" id="node3" href="classFairMQProgOptions.html" title="FairMQProgOptions" alt="" coords="175,5,312,32"/>
|
|
</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:a683febe8d4cc97674085de73eb7ea348"><td class="memItemLeft" align="right" valign="top"><a id="a683febe8d4cc97674085de73eb7ea348"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a683febe8d4cc97674085de73eb7ea348">FairMQDevice</a> (<a class="el" href="classFairMQProgOptions.html">FairMQProgOptions</a> &config)</td></tr>
|
|
<tr class="memdesc:a683febe8d4cc97674085de73eb7ea348"><td class="mdescLeft"> </td><td class="mdescRight">Constructor with external <a class="el" href="classFairMQProgOptions.html">FairMQProgOptions</a>. <br /></td></tr>
|
|
<tr class="separator:a683febe8d4cc97674085de73eb7ea348"><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:af52c3e32027592fb1dba56423495e571"><td class="memItemLeft" align="right" valign="top"><a id="af52c3e32027592fb1dba56423495e571"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#af52c3e32027592fb1dba56423495e571">FairMQDevice</a> (<a class="el" href="classFairMQProgOptions.html">FairMQProgOptions</a> &config, const <a class="el" href="structfair_1_1mq_1_1tools_1_1Version.html">fair::mq::tools::Version</a> version)</td></tr>
|
|
<tr class="memdesc:af52c3e32027592fb1dba56423495e571"><td class="mdescLeft"> </td><td class="mdescRight">Constructor that sets the version and external <a class="el" href="classFairMQProgOptions.html">FairMQProgOptions</a>. <br /></td></tr>
|
|
<tr class="separator:af52c3e32027592fb1dba56423495e571"><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: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:a8128a7a1276d04128ba0824f65796866"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a8128a7a1276d04128ba0824f65796866">Send</a> (FairMQMessagePtr &msg, const std::string &channel, const int index=0, int sndTimeoutInMs=-1)</td></tr>
|
|
<tr class="separator:a8128a7a1276d04128ba0824f65796866"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a62c7e619c0483dacb9615669d43e7085"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a62c7e619c0483dacb9615669d43e7085">Receive</a> (FairMQMessagePtr &msg, const std::string &channel, const int index=0, int rcvTimeoutInMs=-1)</td></tr>
|
|
<tr class="separator:a62c7e619c0483dacb9615669d43e7085"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab9dc8b33792bec45bbdcb8ab65d1880a"><td class="memItemLeft" align="right" valign="top"><a id="ab9dc8b33792bec45bbdcb8ab65d1880a"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>SendAsync</b> (FairMQMessagePtr &msg, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking <a class="el" href="classFairMQDevice.html#a8128a7a1276d04128ba0824f65796866">Send</a></td></tr>
|
|
<tr class="separator:ab9dc8b33792bec45bbdcb8ab65d1880a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a61ebb149b685b941b9c4f89b42d41fe9"><td class="memItemLeft" align="right" valign="top"><a id="a61ebb149b685b941b9c4f89b42d41fe9"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>ReceiveAsync</b> (FairMQMessagePtr &msg, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking <a class="el" href="classFairMQDevice.html#a62c7e619c0483dacb9615669d43e7085">Receive</a></td></tr>
|
|
<tr class="separator:a61ebb149b685b941b9c4f89b42d41fe9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2ff45ca40adf8ad8e046651f14a63f55"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a2ff45ca40adf8ad8e046651f14a63f55">Send</a> (<a class="el" href="classFairMQParts.html">FairMQParts</a> &parts, const std::string &channel, const int index=0, int sndTimeoutInMs=-1)</td></tr>
|
|
<tr class="separator:a2ff45ca40adf8ad8e046651f14a63f55"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9b4c9df42a95d0e428106244a9ae5c54"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a9b4c9df42a95d0e428106244a9ae5c54">Receive</a> (<a class="el" href="classFairMQParts.html">FairMQParts</a> &parts, const std::string &channel, const int index=0, int rcvTimeoutInMs=-1)</td></tr>
|
|
<tr class="separator:a9b4c9df42a95d0e428106244a9ae5c54"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4d14047c2c14c3be83a817b1aa43b076"><td class="memItemLeft" align="right" valign="top"><a id="a4d14047c2c14c3be83a817b1aa43b076"></a>
|
|
int64_t </td><td class="memItemRight" valign="bottom"><b>SendAsync</b> (<a class="el" href="classFairMQParts.html">FairMQParts</a> &parts, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking <a class="el" href="classFairMQDevice.html#a8128a7a1276d04128ba0824f65796866">Send</a></td></tr>
|
|
<tr class="separator:a4d14047c2c14c3be83a817b1aa43b076"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a12a71ff348f81d49f4043710f18b5cc6"><td class="memItemLeft" align="right" valign="top"><a id="a12a71ff348f81d49f4043710f18b5cc6"></a>
|
|
int64_t </td><td class="memItemRight" valign="bottom"><b>ReceiveAsync</b> (<a class="el" href="classFairMQParts.html">FairMQParts</a> &parts, const std::string &channel, const int index=0) __attribute__((deprecated("For non-blocking <a class="el" href="classFairMQDevice.html#a62c7e619c0483dacb9615669d43e7085">Receive</a></td></tr>
|
|
<tr class="separator:a12a71ff348f81d49f4043710f18b5cc6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aab6d9bd4d57360a2b85ee3dec980395c"><td class="memItemLeft" align="right" valign="top"><a id="aab6d9bd4d57360a2b85ee3dec980395c"></a>
|
|
auto </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#aab6d9bd4d57360a2b85ee3dec980395c">Transport</a> () const -> <a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> *</td></tr>
|
|
<tr class="memdesc:aab6d9bd4d57360a2b85ee3dec980395c"><td class="mdescLeft"> </td><td class="mdescRight">Getter for default transport factory. <br /></td></tr>
|
|
<tr class="separator:aab6d9bd4d57360a2b85ee3dec980395c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a76166a3408962d3f57ebfa966aec65a7"><td class="memTemplParams" colspan="2"><a id="a76166a3408962d3f57ebfa966aec65a7"></a>
|
|
template<typename... Args> </td></tr>
|
|
<tr class="memitem:a76166a3408962d3f57ebfa966aec65a7"><td class="memTemplItemLeft" align="right" valign="top">FairMQMessagePtr </td><td class="memTemplItemRight" valign="bottom"><b>NewMessage</b> (Args &&... args)</td></tr>
|
|
<tr class="separator:a76166a3408962d3f57ebfa966aec65a7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a836d37a65d5ecce1779b63c75379652c"><td class="memTemplParams" colspan="2"><a id="a836d37a65d5ecce1779b63c75379652c"></a>
|
|
template<typename... Args> </td></tr>
|
|
<tr class="memitem:a836d37a65d5ecce1779b63c75379652c"><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)</td></tr>
|
|
<tr class="separator:a836d37a65d5ecce1779b63c75379652c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2543793c031c94a2db5142cd51fae31d"><td class="memTemplParams" colspan="2"><a id="a2543793c031c94a2db5142cd51fae31d"></a>
|
|
template<typename T > </td></tr>
|
|
<tr class="memitem:a2543793c031c94a2db5142cd51fae31d"><td class="memTemplItemLeft" align="right" valign="top">FairMQMessagePtr </td><td class="memTemplItemRight" valign="bottom"><b>NewStaticMessage</b> (const T &data)</td></tr>
|
|
<tr class="separator:a2543793c031c94a2db5142cd51fae31d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abbcd4ce9e3700863e28f07d80cbb1985"><td class="memTemplParams" colspan="2"><a id="abbcd4ce9e3700863e28f07d80cbb1985"></a>
|
|
template<typename T > </td></tr>
|
|
<tr class="memitem:abbcd4ce9e3700863e28f07d80cbb1985"><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)</td></tr>
|
|
<tr class="separator:abbcd4ce9e3700863e28f07d80cbb1985"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a82bb4426f1e314cc719ed282f6bf7548"><td class="memTemplParams" colspan="2"><a id="a82bb4426f1e314cc719ed282f6bf7548"></a>
|
|
template<typename T > </td></tr>
|
|
<tr class="memitem:a82bb4426f1e314cc719ed282f6bf7548"><td class="memTemplItemLeft" align="right" valign="top">FairMQMessagePtr </td><td class="memTemplItemRight" valign="bottom"><b>NewSimpleMessage</b> (const T &data)</td></tr>
|
|
<tr class="separator:a82bb4426f1e314cc719ed282f6bf7548"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abf88eece03b79f9f6d9cec0f12913baa"><td class="memTemplParams" colspan="2"><a id="abf88eece03b79f9f6d9cec0f12913baa"></a>
|
|
template<typename T > </td></tr>
|
|
<tr class="memitem:abf88eece03b79f9f6d9cec0f12913baa"><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)</td></tr>
|
|
<tr class="separator:abf88eece03b79f9f6d9cec0f12913baa"><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:afd2fbba837e3638883906063e7e24a6e"><td class="memItemLeft" align="right" valign="top"><a id="afd2fbba837e3638883906063e7e24a6e"></a>
|
|
FairMQPollerPtr </td><td class="memItemRight" valign="bottom"><b>NewPoller</b> (const std::vector< <a class="el" href="classFairMQChannel.html">FairMQChannel</a> *> &channels)</td></tr>
|
|
<tr class="separator:afd2fbba837e3638883906063e7e24a6e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeff235b417915d9e9c1b190ce9329de7"><td class="memItemLeft" align="right" valign="top"><a id="aeff235b417915d9e9c1b190ce9329de7"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#aeff235b417915d9e9c1b190ce9329de7">WaitForInitialValidation</a> () __attribute__((deprecated("This method will have no effect in future versions and will be removed. Instead subscribe for state changes and inspect configuration values.")))</td></tr>
|
|
<tr class="memdesc:aeff235b417915d9e9c1b190ce9329de7"><td class="mdescLeft"> </td><td class="mdescRight">Waits for the first initialization run to finish. <br /></td></tr>
|
|
<tr class="separator:aeff235b417915d9e9c1b190ce9329de7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9bddc6f64f9c89b8ffe3670d91c06b29"><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#a9bddc6f64f9c89b8ffe3670d91c06b29">AddTransport</a> (const fair::mq::Transport transport)</td></tr>
|
|
<tr class="separator:a9bddc6f64f9c89b8ffe3670d91c06b29"><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"><a class="el" href="classFairMQDevice.html#a0a6aa98500c7c66dbd216161251f75f7">SetConfig</a> (<a class="el" href="classFairMQProgOptions.html">FairMQProgOptions</a> &config)</td></tr>
|
|
<tr class="memdesc:a0a6aa98500c7c66dbd216161251f75f7"><td class="mdescLeft"> </td><td class="mdescRight">Assigns config to the device. <br /></td></tr>
|
|
<tr class="separator:a0a6aa98500c7c66dbd216161251f75f7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a559d7e744424c0c2b50caac3b161ea0b"><td class="memItemLeft" align="right" valign="top"><a id="a559d7e744424c0c2b50caac3b161ea0b"></a>
|
|
<a class="el" href="classFairMQProgOptions.html">FairMQProgOptions</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a559d7e744424c0c2b50caac3b161ea0b">GetConfig</a> () const</td></tr>
|
|
<tr class="memdesc:a559d7e744424c0c2b50caac3b161ea0b"><td class="mdescLeft"> </td><td class="mdescRight">Get pointer to the config. <br /></td></tr>
|
|
<tr class="separator:a559d7e744424c0c2b50caac3b161ea0b"><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:a929c915505060a09885093b1a894c358"><td class="memItemLeft" align="right" valign="top"><a id="a929c915505060a09885093b1a894c358"></a>
|
|
<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)</td></tr>
|
|
<tr class="separator:a929c915505060a09885093b1a894c358"><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: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:ad931f34f50461f4bc85d4e7697d9562e"><td class="memItemLeft" align="right" valign="top"><a id="ad931f34f50461f4bc85d4e7697d9562e"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>SetDefaultTransport</b> (const std::string &name)</td></tr>
|
|
<tr class="separator:ad931f34f50461f4bc85d4e7697d9562e"><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="memitem:a72517f8d1edab9b879d573fb09e8b5cf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a72517f8d1edab9b879d573fb09e8b5cf">SetTransport</a> (const std::string &transport)</td></tr>
|
|
<tr class="separator:a72517f8d1edab9b879d573fb09e8b5cf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae3e16932f18d4966d51c906f1fe99d4a"><td class="memItemLeft" align="right" valign="top"><a id="ae3e16932f18d4966d51c906f1fe99d4a"></a>
|
|
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#ae3e16932f18d4966d51c906f1fe99d4a">GetTransportName</a> () const</td></tr>
|
|
<tr class="memdesc:ae3e16932f18d4966d51c906f1fe99d4a"><td class="mdescLeft"> </td><td class="mdescRight">Gets the default transport name. <br /></td></tr>
|
|
<tr class="separator:ae3e16932f18d4966d51c906f1fe99d4a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2d674c1794f63a6721913fa964d89908"><td class="memItemLeft" align="right" valign="top"><a id="a2d674c1794f63a6721913fa964d89908"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>SetRawCmdLineArgs</b> (const std::vector< std::string > &args)</td></tr>
|
|
<tr class="separator:a2d674c1794f63a6721913fa964d89908"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a277a1096321320d4d54a7e2c7e65e31a"><td class="memItemLeft" align="right" valign="top"><a id="a277a1096321320d4d54a7e2c7e65e31a"></a>
|
|
std::vector< std::string > </td><td class="memItemRight" valign="bottom"><b>GetRawCmdLineArgs</b> () const</td></tr>
|
|
<tr class="separator:a277a1096321320d4d54a7e2c7e65e31a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a37c599287a50f4691fe6cd3488c9cd28"><td class="memItemLeft" align="right" valign="top"><a id="a37c599287a50f4691fe6cd3488c9cd28"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>RunStateMachine</b> ()</td></tr>
|
|
<tr class="separator:a37c599287a50f4691fe6cd3488c9cd28"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab2e07c7f823cbd0ea76ea6d1b7fdd1d4"><td class="memTemplParams" colspan="2">template<class Rep , class Period > </td></tr>
|
|
<tr class="memitem:ab2e07c7f823cbd0ea76ea6d1b7fdd1d4"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#ab2e07c7f823cbd0ea76ea6d1b7fdd1d4">WaitFor</a> (std::chrono::duration< Rep, Period > const &duration)</td></tr>
|
|
<tr class="separator:ab2e07c7f823cbd0ea76ea6d1b7fdd1d4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a198f9b6650b04076503caab3688ca234"><td class="memItemLeft" align="right" valign="top"><a id="a198f9b6650b04076503caab3688ca234"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>AddChannel</b> (const std::string &channelName, const <a class="el" href="classFairMQChannel.html">FairMQChannel</a> &channel)</td></tr>
|
|
<tr class="separator:a198f9b6650b04076503caab3688ca234"><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: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>
|
|
<tr class="memitem:a81c04706dbb4c36898890d2b2bfd4468 inherit pub_methods_classFairMQStateMachine"><td class="memItemLeft" align="right" valign="top"><a id="a81c04706dbb4c36898890d2b2bfd4468"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>CallStateChangeCallbacks</b> (const State state) const</td></tr>
|
|
<tr class="separator:a81c04706dbb4c36898890d2b2bfd4468 inherit pub_methods_classFairMQStateMachine"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aebcb84a366fc0f2ecae76019fc2817e4 inherit pub_methods_classFairMQStateMachine"><td class="memItemLeft" align="right" valign="top"><a id="aebcb84a366fc0f2ecae76019fc2817e4"></a>
|
|
std::string </td><td class="memItemRight" valign="bottom"><b>GetCurrentStateName</b> () const</td></tr>
|
|
<tr class="separator:aebcb84a366fc0f2ecae76019fc2817e4 inherit pub_methods_classFairMQStateMachine"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a574073a49878cde71d06bb54cbb5afe4 inherit pub_methods_classFairMQStateMachine"><td class="memItemLeft" align="right" valign="top"><a id="a574073a49878cde71d06bb54cbb5afe4"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>GetCurrentState</b> () const</td></tr>
|
|
<tr class="separator:a574073a49878cde71d06bb54cbb5afe4 inherit pub_methods_classFairMQStateMachine"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a52ee38d6106038dbb6ad969ffd060bb9 inherit pub_methods_classFairMQStateMachine"><td class="memItemLeft" align="right" valign="top"><a id="a52ee38d6106038dbb6ad969ffd060bb9"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>CheckCurrentState</b> (int state) const</td></tr>
|
|
<tr class="separator:a52ee38d6106038dbb6ad969ffd060bb9 inherit pub_methods_classFairMQStateMachine"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a141f0861df906ecb4d64757a5ad0a563 inherit pub_methods_classFairMQStateMachine"><td class="memItemLeft" align="right" valign="top"><a id="a141f0861df906ecb4d64757a5ad0a563"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>CheckCurrentState</b> (const std::string &state) const</td></tr>
|
|
<tr class="separator:a141f0861df906ecb4d64757a5ad0a563 inherit pub_methods_classFairMQStateMachine"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7be1d28d8c38a168f3c148fdb9a0a3f0 inherit pub_methods_classFairMQStateMachine"><td class="memItemLeft" align="right" valign="top"><a id="a7be1d28d8c38a168f3c148fdb9a0a3f0"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>ProcessWork</b> ()</td></tr>
|
|
<tr class="separator:a7be1d28d8c38a168f3c148fdb9a0a3f0 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>
|
|
<tr class="inherit_header pub_static_methods_classFairMQStateMachine"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classFairMQStateMachine')"><img src="closed.png" alt="-"/> Static Public Member Functions inherited from <a class="el" href="classFairMQStateMachine.html">FairMQStateMachine</a></td></tr>
|
|
<tr class="memitem:a8e3207ea52fbad6e20c903e85952b809 inherit pub_static_methods_classFairMQStateMachine"><td class="memItemLeft" align="right" valign="top"><a id="a8e3207ea52fbad6e20c903e85952b809"></a>
|
|
static std::string </td><td class="memItemRight" valign="bottom"><b>GetStateName</b> (const State)</td></tr>
|
|
<tr class="separator:a8e3207ea52fbad6e20c903e85952b809 inherit pub_static_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-attribs"></a>
|
|
Public Attributes</h2></td></tr>
|
|
<tr class="memitem:aef039b89ef03f6b96ebbfc0b7322ef68"><td class="memItemLeft" align="right" valign="top"><a id="aef039b89ef03f6b96ebbfc0b7322ef68"></a>
|
|
int use timeout version with timeout </td><td class="memItemRight" valign="bottom"><b>of</b>: <a class="el" href="classFairMQDevice.html#a8128a7a1276d04128ba0824f65796866">Send</a>(msg</td></tr>
|
|
<tr class="separator:aef039b89ef03f6b96ebbfc0b7322ef68"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1931bdaa8a05fcfd8d66be8ba2ec2139"><td class="memItemLeft" align="right" valign="top"><a id="a1931bdaa8a05fcfd8d66be8ba2ec2139"></a>
|
|
int use timeout version with timeout </td><td class="memItemRight" valign="bottom"><b>channelA</b></td></tr>
|
|
<tr class="separator:a1931bdaa8a05fcfd8d66be8ba2ec2139"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5abcc121750cc351b74f70dbf6f842d7"><td class="memItemLeft" align="right" valign="top"><a id="a5abcc121750cc351b74f70dbf6f842d7"></a>
|
|
int use timeout version with timeout </td><td class="memItemRight" valign="bottom"><b>subchannelIndex</b></td></tr>
|
|
<tr class="separator:a5abcc121750cc351b74f70dbf6f842d7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3a29707570dfcb5c75ff2d66e37d55e5"><td class="memItemLeft" align="right" valign="top"><a id="a3a29707570dfcb5c75ff2d66e37d55e5"></a>
|
|
int use timeout version with timeout </td><td class="memItemRight" valign="bottom"><b>timeout</b></td></tr>
|
|
<tr class="separator:a3a29707570dfcb5c75ff2d66e37d55e5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aef039b89ef03f6b96ebbfc0b7322ef68"><td class="memItemLeft" align="right" valign="top"><a id="aef039b89ef03f6b96ebbfc0b7322ef68"></a>
|
|
int64_t use timeout version with timeout </td><td class="memItemRight" valign="bottom"><b>of</b>: <a class="el" href="classFairMQDevice.html#a8128a7a1276d04128ba0824f65796866">Send</a>(parts</td></tr>
|
|
<tr class="separator:aef039b89ef03f6b96ebbfc0b7322ef68"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1931bdaa8a05fcfd8d66be8ba2ec2139"><td class="memItemLeft" align="right" valign="top"><a id="a1931bdaa8a05fcfd8d66be8ba2ec2139"></a>
|
|
int64_t use timeout version with timeout </td><td class="memItemRight" valign="bottom"><b>channelA</b></td></tr>
|
|
<tr class="separator:a1931bdaa8a05fcfd8d66be8ba2ec2139"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5abcc121750cc351b74f70dbf6f842d7"><td class="memItemLeft" align="right" valign="top"><a id="a5abcc121750cc351b74f70dbf6f842d7"></a>
|
|
int64_t use timeout version with timeout </td><td class="memItemRight" valign="bottom"><b>subchannelIndex</b></td></tr>
|
|
<tr class="separator:a5abcc121750cc351b74f70dbf6f842d7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3a29707570dfcb5c75ff2d66e37d55e5"><td class="memItemLeft" align="right" valign="top"><a id="a3a29707570dfcb5c75ff2d66e37d55e5"></a>
|
|
int64_t use timeout version with timeout </td><td class="memItemRight" valign="bottom"><b>timeout</b></td></tr>
|
|
<tr class="separator:a3a29707570dfcb5c75ff2d66e37d55e5"><td class="memSeparator" colspan="2"> </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:ae806b9730e4812fe9e970f0efdfec9b1"><td class="memItemLeft" align="right" valign="top"><a id="ae806b9730e4812fe9e970f0efdfec9b1"></a>
|
|
std::unique_ptr< <a class="el" href="classFairMQProgOptions.html">FairMQProgOptions</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#ae806b9730e4812fe9e970f0efdfec9b1">fInternalConfig</a></td></tr>
|
|
<tr class="memdesc:ae806b9730e4812fe9e970f0efdfec9b1"><td class="mdescLeft"> </td><td class="mdescRight">Internal program options configuration. <br /></td></tr>
|
|
<tr class="separator:ae806b9730e4812fe9e970f0efdfec9b1"><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">Pointer to config (internal or external) <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"><a id="a3d67868b1c926c0a5daf2616d86fcc58"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a3d67868b1c926c0a5daf2616d86fcc58">Init</a> ()</td></tr>
|
|
<tr class="memdesc:a3d67868b1c926c0a5daf2616d86fcc58"><td class="mdescLeft"> </td><td class="mdescRight">Additional user initialization (can be overloaded in child classes). Prefer to use <a class="el" href="classFairMQDevice.html#a906102a56177105296576938af6e59e5" title="Task initialization (can be overloaded in child classes) ">InitTask()</a>. <br /></td></tr>
|
|
<tr class="separator:a3d67868b1c926c0a5daf2616d86fcc58"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a906102a56177105296576938af6e59e5"><td class="memItemLeft" align="right" valign="top"><a id="a906102a56177105296576938af6e59e5"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a906102a56177105296576938af6e59e5">InitTask</a> ()</td></tr>
|
|
<tr class="memdesc:a906102a56177105296576938af6e59e5"><td class="mdescLeft"> </td><td class="mdescRight">Task initialization (can be overloaded in child classes) <br /></td></tr>
|
|
<tr class="separator:a906102a56177105296576938af6e59e5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab39e52445f8db507569d09e2539d2dc0"><td class="memItemLeft" align="right" valign="top"><a id="ab39e52445f8db507569d09e2539d2dc0"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#ab39e52445f8db507569d09e2539d2dc0">Run</a> ()</td></tr>
|
|
<tr class="memdesc:ab39e52445f8db507569d09e2539d2dc0"><td class="mdescLeft"> </td><td class="mdescRight">Runs the device (to be overloaded in child classes) <br /></td></tr>
|
|
<tr class="separator:ab39e52445f8db507569d09e2539d2dc0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2d6cbe87d8c8e2752523c68049afbe5c"><td class="memItemLeft" align="right" valign="top"><a id="a2d6cbe87d8c8e2752523c68049afbe5c"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a2d6cbe87d8c8e2752523c68049afbe5c">PreRun</a> ()</td></tr>
|
|
<tr class="memdesc:a2d6cbe87d8c8e2752523c68049afbe5c"><td class="mdescLeft"> </td><td class="mdescRight">Called in the RUNNING state once before executing the <a class="el" href="classFairMQDevice.html#ab39e52445f8db507569d09e2539d2dc0" title="Runs the device (to be overloaded in child classes) ">Run()</a>/ConditionalRun() method. <br /></td></tr>
|
|
<tr class="separator:a2d6cbe87d8c8e2752523c68049afbe5c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a964f6e5883b66e7253d58165c66926c8"><td class="memItemLeft" align="right" valign="top"><a id="a964f6e5883b66e7253d58165c66926c8"></a>
|
|
virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a964f6e5883b66e7253d58165c66926c8">ConditionalRun</a> ()</td></tr>
|
|
<tr class="memdesc:a964f6e5883b66e7253d58165c66926c8"><td class="mdescLeft"> </td><td class="mdescRight">Called during RUNNING state repeatedly until it returns false or device state changes. <br /></td></tr>
|
|
<tr class="separator:a964f6e5883b66e7253d58165c66926c8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0366c2a8bc2712d4e089b9a2d2a23859"><td class="memItemLeft" align="right" valign="top"><a id="a0366c2a8bc2712d4e089b9a2d2a23859"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a0366c2a8bc2712d4e089b9a2d2a23859">PostRun</a> ()</td></tr>
|
|
<tr class="memdesc:a0366c2a8bc2712d4e089b9a2d2a23859"><td class="mdescLeft"> </td><td class="mdescRight">Called in the RUNNING state once after executing the <a class="el" href="classFairMQDevice.html#ab39e52445f8db507569d09e2539d2dc0" title="Runs the device (to be overloaded in child classes) ">Run()</a>/ConditionalRun() method. <br /></td></tr>
|
|
<tr class="separator:a0366c2a8bc2712d4e089b9a2d2a23859"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aee7780d7ed486ee0212fb3defc68b48d"><td class="memItemLeft" align="right" valign="top"><a id="aee7780d7ed486ee0212fb3defc68b48d"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#aee7780d7ed486ee0212fb3defc68b48d">Pause</a> ()</td></tr>
|
|
<tr class="memdesc:aee7780d7ed486ee0212fb3defc68b48d"><td class="mdescLeft"> </td><td class="mdescRight">Handles the PAUSE state. <br /></td></tr>
|
|
<tr class="separator:aee7780d7ed486ee0212fb3defc68b48d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5e5dfb96b4b897295bbb6696f58fdd10"><td class="memItemLeft" align="right" valign="top"><a id="a5e5dfb96b4b897295bbb6696f58fdd10"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a5e5dfb96b4b897295bbb6696f58fdd10">ResetTask</a> ()</td></tr>
|
|
<tr class="memdesc:a5e5dfb96b4b897295bbb6696f58fdd10"><td class="mdescLeft"> </td><td class="mdescRight">Resets the user task (to be overloaded in child classes) <br /></td></tr>
|
|
<tr class="separator:a5e5dfb96b4b897295bbb6696f58fdd10"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac202bcd74838d228bc99aafbebf1fe7c"><td class="memItemLeft" align="right" valign="top"><a id="ac202bcd74838d228bc99aafbebf1fe7c"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#ac202bcd74838d228bc99aafbebf1fe7c">Reset</a> ()</td></tr>
|
|
<tr class="memdesc:ac202bcd74838d228bc99aafbebf1fe7c"><td class="mdescLeft"> </td><td class="mdescRight">Resets the device (can be overloaded in child classes) <br /></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">Default transport factory. <br /></td></tr>
|
|
<tr class="separator:a1c67c4cbd6140f35292b13e485f39ce0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a02d4d28747aa58c9b67915e79520cc7b"><td class="memItemLeft" align="right" valign="top"><a id="a02d4d28747aa58c9b67915e79520cc7b"></a>
|
|
std::unordered_map< fair::mq::Transport, std::shared_ptr< <a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a02d4d28747aa58c9b67915e79520cc7b">fTransports</a></td></tr>
|
|
<tr class="memdesc:a02d4d28747aa58c9b67915e79520cc7b"><td class="mdescLeft"> </td><td class="mdescRight">Container for transports. <br /></td></tr>
|
|
<tr class="separator:a02d4d28747aa58c9b67915e79520cc7b"><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>
|
|
</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>
|
|
<tr class="memitem:a62d70a09c189d592bd08f8b092c306bc inherit pub_types_classFairMQStateMachine"><td class="memItemLeft" align="right" valign="top"><a id="a62d70a09c189d592bd08f8b092c306bc"></a>enum  </td><td class="memItemRight" valign="bottom"><b>State</b> { <br />
|
|
  <b>OK</b>,
|
|
<b>Error</b>,
|
|
<b>IDLE</b>,
|
|
<b>INITIALIZING_DEVICE</b>,
|
|
<br />
|
|
  <b>DEVICE_READY</b>,
|
|
<b>INITIALIZING_TASK</b>,
|
|
<b>READY</b>,
|
|
<b>RUNNING</b>,
|
|
<br />
|
|
  <b>PAUSED</b>,
|
|
<b>RESETTING_TASK</b>,
|
|
<b>RESETTING_DEVICE</b>,
|
|
<b>EXITING</b>
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="separator:a62d70a09c189d592bd08f8b092c306bc inherit pub_types_classFairMQStateMachine"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a9bddc6f64f9c89b8ffe3670d91c06b29"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9bddc6f64f9c89b8ffe3670d91c06b29">◆ </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 fair::mq::Transport </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="a62c7e619c0483dacb9615669d43e7085"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a62c7e619c0483dacb9615669d43e7085">◆ </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>channel</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>index</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>rcvTimeoutInMs</em> = <code>-1</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></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>
|
|
<tr><td class="paramname">rcvTimeoutInMs</td><td>receive timeout in ms, -1 will wait forever (or until interrupt (e.g. via state change)), 0 will not wait (return immediately if cannot receive) </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. -1 if there was an error. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9b4c9df42a95d0e428106244a9ae5c54"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9b4c9df42a95d0e428106244a9ae5c54">◆ </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>channel</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>index</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>rcvTimeoutInMs</em> = <code>-1</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></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>
|
|
<tr><td class="paramname">rcvTimeoutInMs</td><td>receive timeout in ms, -1 will wait forever (or until interrupt (e.g. via state change)), 0 will not wait (return immediately if cannot receive) </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. -1 if there was an error. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8128a7a1276d04128ba0824f65796866"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8128a7a1276d04128ba0824f65796866">◆ </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>channel</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>index</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>sndTimeoutInMs</em> = <code>-1</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></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>
|
|
<tr><td class="paramname">sndTimeoutInMs</td><td>send timeout in ms, -1 will wait forever (or until interrupt (e.g. via state change)), 0 will not wait (return immediately if cannot send) </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. -1 if there was an error. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a2ff45ca40adf8ad8e046651f14a63f55"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2ff45ca40adf8ad8e046651f14a63f55">◆ </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>channel</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const int </td>
|
|
<td class="paramname"><em>index</em> = <code>0</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>sndTimeoutInMs</em> = <code>-1</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></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>
|
|
<tr><td class="paramname">sndTimeoutInMs</td><td>send timeout in ms, -1 will wait forever (or until interrupt (e.g. via state change)), 0 will not wait (return immediately if cannot send) </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. -1 if there was an error. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a72517f8d1edab9b879d573fb09e8b5cf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a72517f8d1edab9b879d573fb09e8b5cf">◆ </a></span>SetTransport()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<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></td><td>)</td>
|
|
<td></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>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>
|
|
<a id="ab2e07c7f823cbd0ea76ea6d1b7fdd1d4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab2e07c7f823cbd0ea76ea6d1b7fdd1d4">◆ </a></span>WaitFor()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class Rep , class Period > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool FairMQDevice::WaitFor </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::chrono::duration< Rep, Period > const & </td>
|
|
<td class="paramname"><em>duration</em></td><td>)</td>
|
|
<td></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>Wait for the supplied amount of time or for interruption. If interrupted, returns false, otherwise true. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">duration</td><td>wait duration </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 -->
|
|
<p style="margin: 0 12px 10px 12px;"><a href="https://help.github.com/articles/github-privacy-statement/">privacy</a></p>
|