FairMQ/v1.3.7/classFairMQPollerSHM.html
2018-11-29 13:31:29 +01:00

139 lines
9.6 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FairMQ: FairMQPollerSHM 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
&#160;<span id="projectnumber">1.3.7</span>
</div>
<div id="projectbrief">C++ Message Passing Framework</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classFairMQPollerSHM-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">FairMQPollerSHM Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for FairMQPollerSHM:</div>
<div class="dyncontent">
<div class="center"><img src="classFairMQPollerSHM__inherit__graph.png" border="0" usemap="#FairMQPollerSHM_inherit__map" alt="Inheritance graph"/></div>
<map name="FairMQPollerSHM_inherit__map" id="FairMQPollerSHM_inherit__map">
<area shape="rect" id="node2" href="classFairMQPoller.html" title="FairMQPoller" alt="" coords="20,5,119,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for FairMQPollerSHM:</div>
<div class="dyncontent">
<div class="center"><img src="classFairMQPollerSHM__coll__graph.png" border="0" usemap="#FairMQPollerSHM_coll__map" alt="Collaboration graph"/></div>
<map name="FairMQPollerSHM_coll__map" id="FairMQPollerSHM_coll__map">
<area shape="rect" id="node2" href="classFairMQPoller.html" title="FairMQPoller" alt="" coords="20,5,119,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:a7f04c78619c8c6fa2f0cb7fc01c51e12"><td class="memItemLeft" align="right" valign="top"><a id="a7f04c78619c8c6fa2f0cb7fc01c51e12"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>FairMQPollerSHM</b> (const std::vector&lt; <a class="el" href="classFairMQChannel.html">FairMQChannel</a> &gt; &amp;channels)</td></tr>
<tr class="separator:a7f04c78619c8c6fa2f0cb7fc01c51e12"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af0072738c3623c6e2b7c10bf656ee15b"><td class="memItemLeft" align="right" valign="top"><a id="af0072738c3623c6e2b7c10bf656ee15b"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>FairMQPollerSHM</b> (const std::vector&lt; <a class="el" href="classFairMQChannel.html">FairMQChannel</a> *&gt; &amp;channels)</td></tr>
<tr class="separator:af0072738c3623c6e2b7c10bf656ee15b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2a28d92c3c54725b69acb285211b35ef"><td class="memItemLeft" align="right" valign="top"><a id="a2a28d92c3c54725b69acb285211b35ef"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>FairMQPollerSHM</b> (const std::unordered_map&lt; std::string, std::vector&lt; <a class="el" href="classFairMQChannel.html">FairMQChannel</a> &gt;&gt; &amp;channelsMap, const std::vector&lt; std::string &gt; &amp;channelList)</td></tr>
<tr class="separator:a2a28d92c3c54725b69acb285211b35ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b5323dfdfb96cdd654647a948990285"><td class="memItemLeft" align="right" valign="top"><a id="a0b5323dfdfb96cdd654647a948990285"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>FairMQPollerSHM</b> (const <a class="el" href="classFairMQPollerSHM.html">FairMQPollerSHM</a> &amp;)=delete</td></tr>
<tr class="separator:a0b5323dfdfb96cdd654647a948990285"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ddb7a91337ae21e9de584840d020d47"><td class="memItemLeft" align="right" valign="top"><a id="a8ddb7a91337ae21e9de584840d020d47"></a>
<a class="el" href="classFairMQPollerSHM.html">FairMQPollerSHM</a>&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classFairMQPollerSHM.html">FairMQPollerSHM</a> &amp;)=delete</td></tr>
<tr class="separator:a8ddb7a91337ae21e9de584840d020d47"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:accb5700ebf5cde82f3fbd15928e3918f"><td class="memItemLeft" align="right" valign="top"><a id="accb5700ebf5cde82f3fbd15928e3918f"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>SetItemEvents</b> (zmq_pollitem_t &amp;item, const int type)</td></tr>
<tr class="separator:accb5700ebf5cde82f3fbd15928e3918f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1b5689fd0d304f343df99f45448f31d4"><td class="memItemLeft" align="right" valign="top"><a id="a1b5689fd0d304f343df99f45448f31d4"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>Poll</b> (const int timeout) override</td></tr>
<tr class="separator:a1b5689fd0d304f343df99f45448f31d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a901f51443f415e612465290597386efe"><td class="memItemLeft" align="right" valign="top"><a id="a901f51443f415e612465290597386efe"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>CheckInput</b> (const int index) override</td></tr>
<tr class="separator:a901f51443f415e612465290597386efe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a349fd50aea216b6a434a3fc3f572153c"><td class="memItemLeft" align="right" valign="top"><a id="a349fd50aea216b6a434a3fc3f572153c"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>CheckOutput</b> (const int index) override</td></tr>
<tr class="separator:a349fd50aea216b6a434a3fc3f572153c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa9b1d63d58a33a4063702830526c7733"><td class="memItemLeft" align="right" valign="top"><a id="aa9b1d63d58a33a4063702830526c7733"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>CheckInput</b> (const std::string &amp;channelKey, const int index) override</td></tr>
<tr class="separator:aa9b1d63d58a33a4063702830526c7733"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a314607621a6bdb33d266ae4291930d11"><td class="memItemLeft" align="right" valign="top"><a id="a314607621a6bdb33d266ae4291930d11"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>CheckOutput</b> (const std::string &amp;channelKey, const int index) override</td></tr>
<tr class="separator:a314607621a6bdb33d266ae4291930d11"><td class="memSeparator" colspan="2">&#160;</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&#160;</td><td class="memItemRight" valign="bottom"><b>FairMQChannel</b></td></tr>
<tr class="separator:ad5f4bdef909581fd5301ef80ab7757b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab57541b87a9aee46a035a04477d94318"><td class="memItemLeft" align="right" valign="top"><a id="ab57541b87a9aee46a035a04477d94318"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>FairMQTransportFactorySHM</b></td></tr>
<tr class="separator:ab57541b87a9aee46a035a04477d94318"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>fairmq/shmem/<a class="el" href="FairMQPollerSHM_8h_source.html">FairMQPollerSHM.h</a></li>
<li>fairmq/shmem/FairMQPollerSHM.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>