mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 08:41:16 +00:00
1140 lines
80 KiB
HTML
1140 lines
80 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.18"/>
|
|
<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.4.33</span>
|
|
</div>
|
|
<div id="projectbrief">C++ Message Queuing Library and Framework</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.18 -->
|
|
<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="#pub-static-attribs">Static 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" title=" " alt="" coords="5,132,117,159"/>
|
|
<area shape="rect" href="classFairMQBenchmarkSampler.html" title=" " alt="" coords="165,5,360,32"/>
|
|
<area shape="rect" href="classFairMQMerger.html" title=" " alt="" coords="206,56,319,83"/>
|
|
<area shape="rect" href="classFairMQMultiplier.html" title=" " alt="" coords="198,107,327,133"/>
|
|
<area shape="rect" href="classFairMQProxy.html" title=" " alt="" coords="211,157,315,184"/>
|
|
<area shape="rect" href="classFairMQSink.html" title=" " alt="" coords="215,208,310,235"/>
|
|
<area shape="rect" href="classFairMQSplitter.html" title=" " alt="" coords="205,259,320,285"/>
|
|
</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" title=" " alt="" coords="29,95,141,121"/>
|
|
<area shape="rect" href="classfair_1_1mq_1_1ProgOptions.html" title=" " alt="" coords="5,5,165,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:afb850ea8ff5817c69bdb8aaf9ece69b7"><td class="memItemLeft" align="right" valign="top"><a id="afb850ea8ff5817c69bdb8aaf9ece69b7"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#afb850ea8ff5817c69bdb8aaf9ece69b7">FairMQDevice</a> (<a class="el" href="classfair_1_1mq_1_1ProgOptions.html">fair::mq::ProgOptions</a> &config)</td></tr>
|
|
<tr class="memdesc:afb850ea8ff5817c69bdb8aaf9ece69b7"><td class="mdescLeft"> </td><td class="mdescRight">Constructor with external <a class="el" href="classfair_1_1mq_1_1ProgOptions.html">fair::mq::ProgOptions</a>. <br /></td></tr>
|
|
<tr class="separator:afb850ea8ff5817c69bdb8aaf9ece69b7"><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:a08a86dedb427e05c67802e273fdde7cf"><td class="memItemLeft" align="right" valign="top"><a id="a08a86dedb427e05c67802e273fdde7cf"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a08a86dedb427e05c67802e273fdde7cf">FairMQDevice</a> (<a class="el" href="classfair_1_1mq_1_1ProgOptions.html">fair::mq::ProgOptions</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:a08a86dedb427e05c67802e273fdde7cf"><td class="mdescLeft"> </td><td class="mdescRight">Constructor that sets the version and external <a class="el" href="classfair_1_1mq_1_1ProgOptions.html">fair::mq::ProgOptions</a>. <br /></td></tr>
|
|
<tr class="separator:a08a86dedb427e05c67802e273fdde7cf"><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: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: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:ac9458e96239d625186c7e5f9163ae7e2"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#ac9458e96239d625186c7e5f9163ae7e2">Send</a> (FairMQMessagePtr &msg, const std::string &channel, const int index=0, int sndTimeoutInMs=-1)</td></tr>
|
|
<tr class="separator:ac9458e96239d625186c7e5f9163ae7e2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a363cf1b520148d9864fa800b4341b77f"><td class="memItemLeft" align="right" valign="top">int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a363cf1b520148d9864fa800b4341b77f">Receive</a> (FairMQMessagePtr &msg, const std::string &channel, const int index=0, int rcvTimeoutInMs=-1)</td></tr>
|
|
<tr class="separator:a363cf1b520148d9864fa800b4341b77f"><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: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:a806c0e860c59909e5a2b946c53c73c89"><td class="memTemplParams" colspan="2"><a id="a806c0e860c59909e5a2b946c53c73c89"></a>
|
|
template<typename... Args> </td></tr>
|
|
<tr class="memitem:a806c0e860c59909e5a2b946c53c73c89"><td class="memTemplItemLeft" align="right" valign="top">FairMQUnmanagedRegionPtr </td><td class="memTemplItemRight" valign="bottom"><b>NewUnmanagedRegion</b> (Args &&... args)</td></tr>
|
|
<tr class="separator:a806c0e860c59909e5a2b946c53c73c89"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a468151007d5f7d430ae94cfdce6e7882"><td class="memTemplParams" colspan="2"><a id="a468151007d5f7d430ae94cfdce6e7882"></a>
|
|
template<typename... Args> </td></tr>
|
|
<tr class="memitem:a468151007d5f7d430ae94cfdce6e7882"><td class="memTemplItemLeft" align="right" valign="top">FairMQUnmanagedRegionPtr </td><td class="memTemplItemRight" valign="bottom"><b>NewUnmanagedRegionFor</b> (const std::string &channel, int index, Args &&... args)</td></tr>
|
|
<tr class="separator:a468151007d5f7d430ae94cfdce6e7882"><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:a89b5fb7dad976206939ff1175a6899ea"><td class="memItemLeft" align="right" valign="top"><a id="a89b5fb7dad976206939ff1175a6899ea"></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:a89b5fb7dad976206939ff1175a6899ea"><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:aa272062ccaff78a61d78ddfbefa25dec"><td class="memItemLeft" align="right" valign="top"><a id="aa272062ccaff78a61d78ddfbefa25dec"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#aa272062ccaff78a61d78ddfbefa25dec">SetConfig</a> (<a class="el" href="classfair_1_1mq_1_1ProgOptions.html">fair::mq::ProgOptions</a> &config)</td></tr>
|
|
<tr class="memdesc:aa272062ccaff78a61d78ddfbefa25dec"><td class="mdescLeft"> </td><td class="mdescRight">Assigns config to the device. <br /></td></tr>
|
|
<tr class="separator:aa272062ccaff78a61d78ddfbefa25dec"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acb7448dc5d278c6f51e3fcf7a49f367e"><td class="memItemLeft" align="right" valign="top"><a id="acb7448dc5d278c6f51e3fcf7a49f367e"></a>
|
|
<a class="el" href="classfair_1_1mq_1_1ProgOptions.html">fair::mq::ProgOptions</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#acb7448dc5d278c6f51e3fcf7a49f367e">GetConfig</a> () const</td></tr>
|
|
<tr class="memdesc:acb7448dc5d278c6f51e3fcf7a49f367e"><td class="mdescLeft"> </td><td class="mdescRight">Get pointer to the config. <br /></td></tr>
|
|
<tr class="separator:acb7448dc5d278c6f51e3fcf7a49f367e"><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:a74dd6b1a4ee8371afb1126c68bc3fb9d"><td class="memItemLeft" align="right" valign="top"><a id="a74dd6b1a4ee8371afb1126c68bc3fb9d"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>SetInitTimeoutInS</b> (int initTimeoutInS)</td></tr>
|
|
<tr class="separator:a74dd6b1a4ee8371afb1126c68bc3fb9d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a80897eabf43ff737314e612edc84558c"><td class="memItemLeft" align="right" valign="top"><a id="a80897eabf43ff737314e612edc84558c"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>GetInitTimeoutInS</b> () const</td></tr>
|
|
<tr class="separator:a80897eabf43ff737314e612edc84558c"><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<typename Rep , typename 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:a81348221f634f43f5ee94782fcb6f3e7"><td class="memItemLeft" align="right" valign="top"><a id="a81348221f634f43f5ee94782fcb6f3e7"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>AddChannel</b> (const std::string &name, <a class="el" href="classFairMQChannel.html">FairMQChannel</a> &&channel)</td></tr>
|
|
<tr class="separator:a81348221f634f43f5ee94782fcb6f3e7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad35b073f8fa62d4559a1efbf38d5ded5"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#ad35b073f8fa62d4559a1efbf38d5ded5">ChangeState</a> (const fair::mq::Transition transition)</td></tr>
|
|
<tr class="memdesc:ad35b073f8fa62d4559a1efbf38d5ded5"><td class="mdescLeft"> </td><td class="mdescRight">Request a device state transition. <a href="classFairMQDevice.html#ad35b073f8fa62d4559a1efbf38d5ded5">More...</a><br /></td></tr>
|
|
<tr class="separator:ad35b073f8fa62d4559a1efbf38d5ded5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0f7f383786cd37df5bdd5769ac6521ea"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a0f7f383786cd37df5bdd5769ac6521ea">ChangeState</a> (const std::string &transition)</td></tr>
|
|
<tr class="memdesc:a0f7f383786cd37df5bdd5769ac6521ea"><td class="mdescLeft"> </td><td class="mdescRight">Request a device state transition. <a href="classFairMQDevice.html#a0f7f383786cd37df5bdd5769ac6521ea">More...</a><br /></td></tr>
|
|
<tr class="separator:a0f7f383786cd37df5bdd5769ac6521ea"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7b64f14a98d56fc575d13f7da0ad0a4d"><td class="memItemLeft" align="right" valign="top"><a id="a7b64f14a98d56fc575d13f7da0ad0a4d"></a>
|
|
fair::mq::State </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a7b64f14a98d56fc575d13f7da0ad0a4d">WaitForNextState</a> ()</td></tr>
|
|
<tr class="memdesc:a7b64f14a98d56fc575d13f7da0ad0a4d"><td class="mdescLeft"> </td><td class="mdescRight">waits for the next state (any) to occur <br /></td></tr>
|
|
<tr class="separator:a7b64f14a98d56fc575d13f7da0ad0a4d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a40ef078cf464d17af1e8faeb69c61206"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a40ef078cf464d17af1e8faeb69c61206">WaitForState</a> (fair::mq::State state)</td></tr>
|
|
<tr class="memdesc:a40ef078cf464d17af1e8faeb69c61206"><td class="mdescLeft"> </td><td class="mdescRight">waits for the specified state to occur <a href="classFairMQDevice.html#a40ef078cf464d17af1e8faeb69c61206">More...</a><br /></td></tr>
|
|
<tr class="separator:a40ef078cf464d17af1e8faeb69c61206"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5b28e672fc4bdd82513fff138ff672d9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a5b28e672fc4bdd82513fff138ff672d9">WaitForState</a> (const std::string &state)</td></tr>
|
|
<tr class="memdesc:a5b28e672fc4bdd82513fff138ff672d9"><td class="mdescLeft"> </td><td class="mdescRight">waits for the specified state to occur <a href="classFairMQDevice.html#a5b28e672fc4bdd82513fff138ff672d9">More...</a><br /></td></tr>
|
|
<tr class="separator:a5b28e672fc4bdd82513fff138ff672d9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a916c44294188084712c333182e7cce57"><td class="memItemLeft" align="right" valign="top"><a id="a916c44294188084712c333182e7cce57"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>TransitionTo</b> (const fair::mq::State state)</td></tr>
|
|
<tr class="separator:a916c44294188084712c333182e7cce57"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae3c2c8524082bf37eafaa26030ee7452"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#ae3c2c8524082bf37eafaa26030ee7452">SubscribeToStateChange</a> (const std::string &key, std::function< void(const fair::mq::State)> callback)</td></tr>
|
|
<tr class="memdesc:ae3c2c8524082bf37eafaa26030ee7452"><td class="mdescLeft"> </td><td class="mdescRight">Subscribe with a callback to state changes. <a href="classFairMQDevice.html#ae3c2c8524082bf37eafaa26030ee7452">More...</a><br /></td></tr>
|
|
<tr class="separator:ae3c2c8524082bf37eafaa26030ee7452"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af9b5b7a5469bff53feb6a1e000230e73"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#af9b5b7a5469bff53feb6a1e000230e73">UnsubscribeFromStateChange</a> (const std::string &key)</td></tr>
|
|
<tr class="memdesc:af9b5b7a5469bff53feb6a1e000230e73"><td class="mdescLeft"> </td><td class="mdescRight">Unsubscribe from state changes. <a href="classFairMQDevice.html#af9b5b7a5469bff53feb6a1e000230e73">More...</a><br /></td></tr>
|
|
<tr class="separator:af9b5b7a5469bff53feb6a1e000230e73"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aff6cf5db6dfc546431fc76548b8c09c4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#aff6cf5db6dfc546431fc76548b8c09c4">SubscribeToNewTransition</a> (const std::string &key, std::function< void(const fair::mq::Transition)> callback)</td></tr>
|
|
<tr class="memdesc:aff6cf5db6dfc546431fc76548b8c09c4"><td class="mdescLeft"> </td><td class="mdescRight">Subscribe with a callback to incoming state transitions. <a href="classFairMQDevice.html#aff6cf5db6dfc546431fc76548b8c09c4">More...</a><br /></td></tr>
|
|
<tr class="separator:aff6cf5db6dfc546431fc76548b8c09c4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaa9562c293ae1522975f171dfee00d69"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#aaa9562c293ae1522975f171dfee00d69">UnsubscribeFromNewTransition</a> (const std::string &key)</td></tr>
|
|
<tr class="memdesc:aaa9562c293ae1522975f171dfee00d69"><td class="mdescLeft"> </td><td class="mdescRight">Unsubscribe from state transitions. <a href="classFairMQDevice.html#aaa9562c293ae1522975f171dfee00d69">More...</a><br /></td></tr>
|
|
<tr class="separator:aaa9562c293ae1522975f171dfee00d69"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac6e41280dd6cc8b217944a97fd9c548c"><td class="memItemLeft" align="right" valign="top"><a id="ac6e41280dd6cc8b217944a97fd9c548c"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#ac6e41280dd6cc8b217944a97fd9c548c">NewStatePending</a> () const</td></tr>
|
|
<tr class="memdesc:ac6e41280dd6cc8b217944a97fd9c548c"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if a new state has been requested, signaling the current handler to stop. <br /></td></tr>
|
|
<tr class="separator:ac6e41280dd6cc8b217944a97fd9c548c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7ba52b2fc3908c6bf1391eb5f27b03bd"><td class="memItemLeft" align="right" valign="top"><a id="a7ba52b2fc3908c6bf1391eb5f27b03bd"></a>
|
|
fair::mq::State </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a7ba52b2fc3908c6bf1391eb5f27b03bd">GetCurrentState</a> () const</td></tr>
|
|
<tr class="memdesc:a7ba52b2fc3908c6bf1391eb5f27b03bd"><td class="mdescLeft"> </td><td class="mdescRight">Returns the current state. <br /></td></tr>
|
|
<tr class="separator:a7ba52b2fc3908c6bf1391eb5f27b03bd"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad1b949fc86f1028a1421972d43b37df9"><td class="memItemLeft" align="right" valign="top"><a id="ad1b949fc86f1028a1421972d43b37df9"></a>
|
|
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#ad1b949fc86f1028a1421972d43b37df9">GetCurrentStateName</a> () const</td></tr>
|
|
<tr class="memdesc:ad1b949fc86f1028a1421972d43b37df9"><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the current state as a string. <br /></td></tr>
|
|
<tr class="separator:ad1b949fc86f1028a1421972d43b37df9"><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:af13f02da4e38ec68e23b7fab6677540a"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#af13f02da4e38ec68e23b7fab6677540a">GetStateName</a> (const fair::mq::State state)</td></tr>
|
|
<tr class="memdesc:af13f02da4e38ec68e23b7fab6677540a"><td class="mdescLeft"> </td><td class="mdescRight">Returns name of the given state as a string. <a href="classFairMQDevice.html#af13f02da4e38ec68e23b7fab6677540a">More...</a><br /></td></tr>
|
|
<tr class="separator:af13f02da4e38ec68e23b7fab6677540a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afeaaeb9cb5ce8e0ac617600af8cfee52"><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#afeaaeb9cb5ce8e0ac617600af8cfee52">GetTransitionName</a> (const fair::mq::Transition transition)</td></tr>
|
|
<tr class="memdesc:afeaaeb9cb5ce8e0ac617600af8cfee52"><td class="mdescLeft"> </td><td class="mdescRight">Returns name of the given transition as a string. <a href="classFairMQDevice.html#afeaaeb9cb5ce8e0ac617600af8cfee52">More...</a><br /></td></tr>
|
|
<tr class="separator:afeaaeb9cb5ce8e0ac617600af8cfee52"><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:a597c3c39cb45accfcf28e44071e4baff"><td class="memItemLeft" align="right" valign="top"><a id="a597c3c39cb45accfcf28e44071e4baff"></a>
|
|
std::unique_ptr< <a class="el" href="classfair_1_1mq_1_1ProgOptions.html">fair::mq::ProgOptions</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a597c3c39cb45accfcf28e44071e4baff">fInternalConfig</a></td></tr>
|
|
<tr class="memdesc:a597c3c39cb45accfcf28e44071e4baff"><td class="mdescLeft"> </td><td class="mdescRight">Internal program options configuration. <br /></td></tr>
|
|
<tr class="separator:a597c3c39cb45accfcf28e44071e4baff"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3496403c6124440185111ba3b49fb80d"><td class="memItemLeft" align="right" valign="top"><a id="a3496403c6124440185111ba3b49fb80d"></a>
|
|
<a class="el" href="classfair_1_1mq_1_1ProgOptions.html">fair::mq::ProgOptions</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a3496403c6124440185111ba3b49fb80d">fConfig</a></td></tr>
|
|
<tr class="memdesc:a3496403c6124440185111ba3b49fb80d"><td class="mdescLeft"> </td><td class="mdescRight">Pointer to config (internal or external) <br /></td></tr>
|
|
<tr class="separator:a3496403c6124440185111ba3b49fb80d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
|
|
Static Public Attributes</h2></td></tr>
|
|
<tr class="memitem:a5b207943e3276401338e9a3a54dc2403"><td class="memItemLeft" align="right" valign="top"><a id="a5b207943e3276401338e9a3a54dc2403"></a>
|
|
static constexpr const char * </td><td class="memItemRight" valign="bottom"><b>DefaultId</b> = ""</td></tr>
|
|
<tr class="separator:a5b207943e3276401338e9a3a54dc2403"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2d06052069ad94a9a1dbdfda0fbd9874"><td class="memItemLeft" align="right" valign="top"><a id="a2d06052069ad94a9a1dbdfda0fbd9874"></a>
|
|
static constexpr int </td><td class="memItemRight" valign="bottom"><b>DefaultIOThreads</b> = 1</td></tr>
|
|
<tr class="separator:a2d06052069ad94a9a1dbdfda0fbd9874"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a484eef27bd4a618bb157ce1e078b428f"><td class="memItemLeft" align="right" valign="top"><a id="a484eef27bd4a618bb157ce1e078b428f"></a>
|
|
static constexpr const char * </td><td class="memItemRight" valign="bottom"><b>DefaultTransportName</b> = "zeromq"</td></tr>
|
|
<tr class="separator:a484eef27bd4a618bb157ce1e078b428f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af4602a67ba7255e1cdfbee223bd3faee"><td class="memItemLeft" align="right" valign="top"><a id="af4602a67ba7255e1cdfbee223bd3faee"></a>
|
|
static constexpr fair::mq::Transport </td><td class="memItemRight" valign="bottom"><b>DefaultTransportType</b> = fair::mq::Transport::ZMQ</td></tr>
|
|
<tr class="separator:af4602a67ba7255e1cdfbee223bd3faee"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aebeeb3468b8f3c6531b44b15e1069ee5"><td class="memItemLeft" align="right" valign="top"><a id="aebeeb3468b8f3c6531b44b15e1069ee5"></a>
|
|
static constexpr const char * </td><td class="memItemRight" valign="bottom"><b>DefaultNetworkInterface</b> = "default"</td></tr>
|
|
<tr class="separator:aebeeb3468b8f3c6531b44b15e1069ee5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ada5af08bd8533ec62efdd2e1e6b53b13"><td class="memItemLeft" align="right" valign="top"><a id="ada5af08bd8533ec62efdd2e1e6b53b13"></a>
|
|
static constexpr int </td><td class="memItemRight" valign="bottom"><b>DefaultInitTimeout</b> = 120</td></tr>
|
|
<tr class="separator:ada5af08bd8533ec62efdd2e1e6b53b13"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a92eab91e99eea4f4cbfd095e536e3455"><td class="memItemLeft" align="right" valign="top"><a id="a92eab91e99eea4f4cbfd095e536e3455"></a>
|
|
static constexpr uint64_t </td><td class="memItemRight" valign="bottom"><b>DefaultMaxRunTime</b> = 0</td></tr>
|
|
<tr class="separator:a92eab91e99eea4f4cbfd095e536e3455"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac2c8dd974b57c3729a706e38bc684fc5"><td class="memItemLeft" align="right" valign="top"><a id="ac2c8dd974b57c3729a706e38bc684fc5"></a>
|
|
static constexpr float </td><td class="memItemRight" valign="bottom"><b>DefaultRate</b> = 0.</td></tr>
|
|
<tr class="separator:ac2c8dd974b57c3729a706e38bc684fc5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa3eaa8ef93c5758e16409f01ccbd3671"><td class="memItemLeft" align="right" valign="top"><a id="aa3eaa8ef93c5758e16409f01ccbd3671"></a>
|
|
static constexpr const char * </td><td class="memItemRight" valign="bottom"><b>DefaultSession</b> = "default"</td></tr>
|
|
<tr class="separator:aa3eaa8ef93c5758e16409f01ccbd3671"><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:a51db444647edcea2464ca3c59d6bb818"><td class="memItemLeft" align="right" valign="top"><a id="a51db444647edcea2464ca3c59d6bb818"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a51db444647edcea2464ca3c59d6bb818">Init</a> ()</td></tr>
|
|
<tr class="memdesc:a51db444647edcea2464ca3c59d6bb818"><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#ae4e81b923615502666e5531f532ffc98" title="Task initialization (can be overloaded in child classes)">InitTask()</a>. <br /></td></tr>
|
|
<tr class="separator:a51db444647edcea2464ca3c59d6bb818"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8716714540007b19024148aedf96bfdc"><td class="memItemLeft" align="right" valign="top"><a id="a8716714540007b19024148aedf96bfdc"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>Bind</b> ()</td></tr>
|
|
<tr class="separator:a8716714540007b19024148aedf96bfdc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3eaa3a5b5d11f92073ca863593eb8b6f"><td class="memItemLeft" align="right" valign="top"><a id="a3eaa3a5b5d11f92073ca863593eb8b6f"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>Connect</b> ()</td></tr>
|
|
<tr class="separator:a3eaa3a5b5d11f92073ca863593eb8b6f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae4e81b923615502666e5531f532ffc98"><td class="memItemLeft" align="right" valign="top"><a id="ae4e81b923615502666e5531f532ffc98"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#ae4e81b923615502666e5531f532ffc98">InitTask</a> ()</td></tr>
|
|
<tr class="memdesc:ae4e81b923615502666e5531f532ffc98"><td class="mdescLeft"> </td><td class="mdescRight">Task initialization (can be overloaded in child classes) <br /></td></tr>
|
|
<tr class="separator:ae4e81b923615502666e5531f532ffc98"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3b90dbcf10552daab760629857e3ba3e"><td class="memItemLeft" align="right" valign="top"><a id="a3b90dbcf10552daab760629857e3ba3e"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a3b90dbcf10552daab760629857e3ba3e">Run</a> ()</td></tr>
|
|
<tr class="memdesc:a3b90dbcf10552daab760629857e3ba3e"><td class="mdescLeft"> </td><td class="mdescRight">Runs the device (to be overloaded in child classes) <br /></td></tr>
|
|
<tr class="separator:a3b90dbcf10552daab760629857e3ba3e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7578022e18bc2b5b40ba56249cf23719"><td class="memItemLeft" align="right" valign="top"><a id="a7578022e18bc2b5b40ba56249cf23719"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a7578022e18bc2b5b40ba56249cf23719">PreRun</a> ()</td></tr>
|
|
<tr class="memdesc:a7578022e18bc2b5b40ba56249cf23719"><td class="mdescLeft"> </td><td class="mdescRight">Called in the RUNNING state once before executing the <a class="el" href="classFairMQDevice.html#a3b90dbcf10552daab760629857e3ba3e" title="Runs the device (to be overloaded in child classes)">Run()</a>/ConditionalRun() method. <br /></td></tr>
|
|
<tr class="separator:a7578022e18bc2b5b40ba56249cf23719"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad88707048f53c88ef0d6848deb962284"><td class="memItemLeft" align="right" valign="top"><a id="ad88707048f53c88ef0d6848deb962284"></a>
|
|
virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#ad88707048f53c88ef0d6848deb962284">ConditionalRun</a> ()</td></tr>
|
|
<tr class="memdesc:ad88707048f53c88ef0d6848deb962284"><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:ad88707048f53c88ef0d6848deb962284"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a56d2e72203b11fb4d636e22018456965"><td class="memItemLeft" align="right" valign="top"><a id="a56d2e72203b11fb4d636e22018456965"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a56d2e72203b11fb4d636e22018456965">PostRun</a> ()</td></tr>
|
|
<tr class="memdesc:a56d2e72203b11fb4d636e22018456965"><td class="mdescLeft"> </td><td class="mdescRight">Called in the RUNNING state once after executing the <a class="el" href="classFairMQDevice.html#a3b90dbcf10552daab760629857e3ba3e" title="Runs the device (to be overloaded in child classes)">Run()</a>/ConditionalRun() method. <br /></td></tr>
|
|
<tr class="separator:a56d2e72203b11fb4d636e22018456965"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9ca6f7041dd312096fce7d42ebd3586c"><td class="memItemLeft" align="right" valign="top"><a id="a9ca6f7041dd312096fce7d42ebd3586c"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a9ca6f7041dd312096fce7d42ebd3586c">ResetTask</a> ()</td></tr>
|
|
<tr class="memdesc:a9ca6f7041dd312096fce7d42ebd3586c"><td class="mdescLeft"> </td><td class="mdescRight">Resets the user task (to be overloaded in child classes) <br /></td></tr>
|
|
<tr class="separator:a9ca6f7041dd312096fce7d42ebd3586c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2a1a3157b7cb40ddc299b8865f3ef305"><td class="memItemLeft" align="right" valign="top"><a id="a2a1a3157b7cb40ddc299b8865f3ef305"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQDevice.html#a2a1a3157b7cb40ddc299b8865f3ef305">Reset</a> ()</td></tr>
|
|
<tr class="memdesc:a2a1a3157b7cb40ddc299b8865f3ef305"><td class="mdescLeft"> </td><td class="mdescRight">Resets the device (can be overloaded in child classes) <br /></td></tr>
|
|
<tr class="separator:a2a1a3157b7cb40ddc299b8865f3ef305"><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>
|
|
<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"/"shmem") </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad35b073f8fa62d4559a1efbf38d5ded5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad35b073f8fa62d4559a1efbf38d5ded5">◆ </a></span>ChangeState() <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">bool FairMQDevice::ChangeState </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const fair::mq::Transition </td>
|
|
<td class="paramname"><em>transition</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>Request a device state transition. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">transition</td><td>state transition</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>The state transition may not happen immediately, but when the current state evaluates the pending transition event and terminates. In other words, the device states are scheduled cooperatively. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a0f7f383786cd37df5bdd5769ac6521ea"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0f7f383786cd37df5bdd5769ac6521ea">◆ </a></span>ChangeState() <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">bool FairMQDevice::ChangeState </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>transition</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>Request a device state transition. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">transition</td><td>state transition</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>The state transition may not happen immediately, but when the current state evaluates the pending transition event and terminates. In other words, the device states are scheduled cooperatively. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af13f02da4e38ec68e23b7fab6677540a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af13f02da4e38ec68e23b7fab6677540a">◆ </a></span>GetStateName()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static std::string FairMQDevice::GetStateName </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const fair::mq::State </td>
|
|
<td class="paramname"><em>state</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns name of the given state as a string. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">state</td><td>state </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afeaaeb9cb5ce8e0ac617600af8cfee52"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afeaaeb9cb5ce8e0ac617600af8cfee52">◆ </a></span>GetTransitionName()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static std::string FairMQDevice::GetTransitionName </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const fair::mq::Transition </td>
|
|
<td class="paramname"><em>transition</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns name of the given transition as a string. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">transition</td><td>transition </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a363cf1b520148d9864fa800b4341b77f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a363cf1b520148d9864fa800b4341b77f">◆ </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">int64_t 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, TransferCode::timeout if timed out, TransferCode::error if there was an error, TransferCode::interrupted if interrupted (e.g. by requested state change) </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, TransferCode::timeout if timed out, TransferCode::error if there was an error, TransferCode::interrupted if interrupted (e.g. by requested state change) </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac9458e96239d625186c7e5f9163ae7e2"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac9458e96239d625186c7e5f9163ae7e2">◆ </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">int64_t 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, TransferCode::timeout if timed out, TransferCode::error if there was an error, TransferCode::interrupted if interrupted (e.g. by requested state change) </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, TransferCode::timeout if timed out, TransferCode::error if there was an error, TransferCode::interrupted if interrupted (e.g. by requested state change) </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"/"shmem") </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aff6cf5db6dfc546431fc76548b8c09c4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aff6cf5db6dfc546431fc76548b8c09c4">◆ </a></span>SubscribeToNewTransition()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FairMQDevice::SubscribeToNewTransition </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::function< void(const fair::mq::Transition)> </td>
|
|
<td class="paramname"><em>callback</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">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Subscribe with a callback to incoming state transitions. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">key</td><td>id to identify your subscription </td></tr>
|
|
<tr><td class="paramname">callback</td><td>callback (called with the incoming transition as the parameter) The callback is called when new transition is initiated. The callback is called from the thread that initiates the transition (via ChangeState). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae3c2c8524082bf37eafaa26030ee7452"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae3c2c8524082bf37eafaa26030ee7452">◆ </a></span>SubscribeToStateChange()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FairMQDevice::SubscribeToStateChange </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::function< void(const fair::mq::State)> </td>
|
|
<td class="paramname"><em>callback</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">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Subscribe with a callback to state changes. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">key</td><td>id to identify your subscription </td></tr>
|
|
<tr><td class="paramname">callback</td><td>callback (called with the new state as the parameter)</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<p>The callback is called at the beginning of a new state. The callback is called from the thread the state is running in. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aaa9562c293ae1522975f171dfee00d69"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaa9562c293ae1522975f171dfee00d69">◆ </a></span>UnsubscribeFromNewTransition()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FairMQDevice::UnsubscribeFromNewTransition </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>key</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>Unsubscribe from state transitions. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">key</td><td>id (that was used when subscribing) </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="af9b5b7a5469bff53feb6a1e000230e73"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af9b5b7a5469bff53feb6a1e000230e73">◆ </a></span>UnsubscribeFromStateChange()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void FairMQDevice::UnsubscribeFromStateChange </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>key</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>Unsubscribe from state changes. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">key</td><td>id (that was used when subscribing) </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<typename Rep , typename 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>
|
|
<a id="a5b28e672fc4bdd82513fff138ff672d9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5b28e672fc4bdd82513fff138ff672d9">◆ </a></span>WaitForState() <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">void FairMQDevice::WaitForState </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>state</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>waits for the specified state to occur </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">state</td><td>state to wait for </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a40ef078cf464d17af1e8faeb69c61206"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a40ef078cf464d17af1e8faeb69c61206">◆ </a></span>WaitForState() <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">void FairMQDevice::WaitForState </td>
|
|
<td>(</td>
|
|
<td class="paramtype">fair::mq::State </td>
|
|
<td class="paramname"><em>state</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>waits for the specified state to occur </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">state</td><td>state to wait for </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>
|