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

141 lines
9.8 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: fair::mq::shmem::Region Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">FairMQ
&#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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespacefair.html">fair</a></li><li class="navelem"><b>mq</b></li><li class="navelem"><b>shmem</b></li><li class="navelem"><a class="el" href="structfair_1_1mq_1_1shmem_1_1Region.html">Region</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structfair_1_1mq_1_1shmem_1_1Region-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">fair::mq::shmem::Region Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for fair::mq::shmem::Region:</div>
<div class="dyncontent">
<div class="center"><img src="structfair_1_1mq_1_1shmem_1_1Region__coll__graph.png" border="0" usemap="#fair_1_1mq_1_1shmem_1_1Region_coll__map" alt="Collaboration graph"/></div>
<map name="fair_1_1mq_1_1shmem_1_1Region_coll__map" id="fair_1_1mq_1_1shmem_1_1Region_coll__map">
<area shape="rect" id="node2" href="classfair_1_1mq_1_1shmem_1_1Manager.html" title="fair::mq::shmem::Manager" alt="" coords="5,5,180,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:a46a0bffa7e82eccecfc6a17e78528741"><td class="memItemLeft" align="right" valign="top"><a id="a46a0bffa7e82eccecfc6a17e78528741"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Region</b> (<a class="el" href="classfair_1_1mq_1_1shmem_1_1Manager.html">Manager</a> &amp;manager, uint64_t id, uint64_t size, bool remote, FairMQRegionCallback callback=nullptr)</td></tr>
<tr class="separator:a46a0bffa7e82eccecfc6a17e78528741"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef8dfff58deba6380ec68be433757ba2"><td class="memItemLeft" align="right" valign="top"><a id="aef8dfff58deba6380ec68be433757ba2"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Region</b> (const <a class="el" href="structfair_1_1mq_1_1shmem_1_1Region.html">Region</a> &amp;)=default</td></tr>
<tr class="separator:aef8dfff58deba6380ec68be433757ba2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abdea0261aaf8f6c3d8651b153daf066f"><td class="memItemLeft" align="right" valign="top"><a id="abdea0261aaf8f6c3d8651b153daf066f"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Region</b> (<a class="el" href="structfair_1_1mq_1_1shmem_1_1Region.html">Region</a> &amp;&amp;)=default</td></tr>
<tr class="separator:abdea0261aaf8f6c3d8651b153daf066f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9f31e1f4bb8518050b0ae00d40bc8fa4"><td class="memItemLeft" align="right" valign="top"><a id="a9f31e1f4bb8518050b0ae00d40bc8fa4"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>StartReceivingAcks</b> ()</td></tr>
<tr class="separator:a9f31e1f4bb8518050b0ae00d40bc8fa4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a740f843a72b9ffb82047b1f19014aa57"><td class="memItemLeft" align="right" valign="top"><a id="a740f843a72b9ffb82047b1f19014aa57"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>ReceiveAcks</b> ()</td></tr>
<tr class="separator:a740f843a72b9ffb82047b1f19014aa57"><td class="memSeparator" colspan="2">&#160;</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:ae46ac9fde0e05fe0c65216f31c0d3421"><td class="memItemLeft" align="right" valign="top"><a id="ae46ac9fde0e05fe0c65216f31c0d3421"></a>
<a class="el" href="classfair_1_1mq_1_1shmem_1_1Manager.html">Manager</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>fManager</b></td></tr>
<tr class="separator:ae46ac9fde0e05fe0c65216f31c0d3421"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b06c7cf19f318e40632b5433433647c"><td class="memItemLeft" align="right" valign="top"><a id="a4b06c7cf19f318e40632b5433433647c"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>fRemote</b></td></tr>
<tr class="separator:a4b06c7cf19f318e40632b5433433647c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a39f81f1a734d92a19469ceccd2e03a51"><td class="memItemLeft" align="right" valign="top"><a id="a39f81f1a734d92a19469ceccd2e03a51"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>fStop</b></td></tr>
<tr class="separator:a39f81f1a734d92a19469ceccd2e03a51"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa46b13131a66d11604522f4df53d90ab"><td class="memItemLeft" align="right" valign="top"><a id="aa46b13131a66d11604522f4df53d90ab"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>fName</b></td></tr>
<tr class="separator:aa46b13131a66d11604522f4df53d90ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afad02dca29d815fe776450c73a5ac3ab"><td class="memItemLeft" align="right" valign="top"><a id="afad02dca29d815fe776450c73a5ac3ab"></a>
std::string&#160;</td><td class="memItemRight" valign="bottom"><b>fQueueName</b></td></tr>
<tr class="separator:afad02dca29d815fe776450c73a5ac3ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec14c4eda1609d994403f8c3857b8523"><td class="memItemLeft" align="right" valign="top"><a id="aec14c4eda1609d994403f8c3857b8523"></a>
boost::interprocess::shared_memory_object&#160;</td><td class="memItemRight" valign="bottom"><b>fShmemObject</b></td></tr>
<tr class="separator:aec14c4eda1609d994403f8c3857b8523"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adfcdfaf0616c19ab6922b190f588d3c1"><td class="memItemLeft" align="right" valign="top"><a id="adfcdfaf0616c19ab6922b190f588d3c1"></a>
boost::interprocess::mapped_region&#160;</td><td class="memItemRight" valign="bottom"><b>fRegion</b></td></tr>
<tr class="separator:adfcdfaf0616c19ab6922b190f588d3c1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07ecc280212256eae69f0167aa1cb9c9"><td class="memItemLeft" align="right" valign="top"><a id="a07ecc280212256eae69f0167aa1cb9c9"></a>
std::unique_ptr&lt; boost::interprocess::message_queue &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>fQueue</b></td></tr>
<tr class="separator:a07ecc280212256eae69f0167aa1cb9c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef45ed549839d07cb28fe4483fc47dc8"><td class="memItemLeft" align="right" valign="top"><a id="aef45ed549839d07cb28fe4483fc47dc8"></a>
std::thread&#160;</td><td class="memItemRight" valign="bottom"><b>fWorker</b></td></tr>
<tr class="separator:aef45ed549839d07cb28fe4483fc47dc8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3449fa7540ec9d2d14e274cd3fa4a695"><td class="memItemLeft" align="right" valign="top"><a id="a3449fa7540ec9d2d14e274cd3fa4a695"></a>
FairMQRegionCallback&#160;</td><td class="memItemRight" valign="bottom"><b>fCallback</b></td></tr>
<tr class="separator:a3449fa7540ec9d2d14e274cd3fa4a695"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<hr/>The documentation for this struct was generated from the following files:<ul>
<li>fairmq/shmem/<a class="el" href="Region_8h_source.html">Region.h</a></li>
<li>fairmq/shmem/Region.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>