mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 00:31:14 +00:00
177 lines
14 KiB
HTML
177 lines
14 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: 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
|
|
 <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 id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><b>fair</b></li><li class="navelem"><a class="el" href="namespacefair_1_1mq.html">mq</a></li><li class="navelem"><a class="el" href="namespacefair_1_1mq_1_1shmem.html">shmem</a></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> |
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<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">
|
|
<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:a2dde72f9d1b4eb359dc60847046cd6d1"><td class="memItemLeft" align="right" valign="top"><a id="a2dde72f9d1b4eb359dc60847046cd6d1"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>Region</b> (const std::string &shmId, uint16_t id, uint64_t size, bool remote, RegionCallback callback, RegionBulkCallback bulkCallback, const std::string &path, int flags)</td></tr>
|
|
<tr class="separator:a2dde72f9d1b4eb359dc60847046cd6d1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a07714e39a0edf21a6d8658bf4f9ec731"><td class="memItemLeft" align="right" valign="top"><a id="a07714e39a0edf21a6d8658bf4f9ec731"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>Region</b> (const <a class="el" href="structfair_1_1mq_1_1shmem_1_1Region.html">Region</a> &)=delete</td></tr>
|
|
<tr class="separator:a07714e39a0edf21a6d8658bf4f9ec731"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afc2c5a4c5a2fe5f9592e0ccd2f365898"><td class="memItemLeft" align="right" valign="top"><a id="afc2c5a4c5a2fe5f9592e0ccd2f365898"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>Region</b> (<a class="el" href="structfair_1_1mq_1_1shmem_1_1Region.html">Region</a> &&)=delete</td></tr>
|
|
<tr class="separator:afc2c5a4c5a2fe5f9592e0ccd2f365898"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3a07916f63f86b7f5b6037dc82e06d5a"><td class="memItemLeft" align="right" valign="top"><a id="a3a07916f63f86b7f5b6037dc82e06d5a"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>InitializeQueues</b> ()</td></tr>
|
|
<tr class="separator:a3a07916f63f86b7f5b6037dc82e06d5a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a140ef47d44b631fd470abdd47a3370e8"><td class="memItemLeft" align="right" valign="top"><a id="a140ef47d44b631fd470abdd47a3370e8"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>StartSendingAcks</b> ()</td></tr>
|
|
<tr class="separator:a140ef47d44b631fd470abdd47a3370e8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8043d01db508013d651747dc55b299b0"><td class="memItemLeft" align="right" valign="top"><a id="a8043d01db508013d651747dc55b299b0"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>SendAcks</b> ()</td></tr>
|
|
<tr class="separator:a8043d01db508013d651747dc55b299b0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9f31e1f4bb8518050b0ae00d40bc8fa4"><td class="memItemLeft" align="right" valign="top"><a id="a9f31e1f4bb8518050b0ae00d40bc8fa4"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>StartReceivingAcks</b> ()</td></tr>
|
|
<tr class="separator:a9f31e1f4bb8518050b0ae00d40bc8fa4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a740f843a72b9ffb82047b1f19014aa57"><td class="memItemLeft" align="right" valign="top"><a id="a740f843a72b9ffb82047b1f19014aa57"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>ReceiveAcks</b> ()</td></tr>
|
|
<tr class="separator:a740f843a72b9ffb82047b1f19014aa57"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a644a8d20f22ca835e7e33eecccf3a493"><td class="memItemLeft" align="right" valign="top"><a id="a644a8d20f22ca835e7e33eecccf3a493"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>ReleaseBlock</b> (const <a class="el" href="structfair_1_1mq_1_1shmem_1_1RegionBlock.html">RegionBlock</a> &block)</td></tr>
|
|
<tr class="separator:a644a8d20f22ca835e7e33eecccf3a493"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a25d7847b2e12196d5c30997e92be59ca"><td class="memItemLeft" align="right" valign="top"><a id="a25d7847b2e12196d5c30997e92be59ca"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>SetLinger</b> (uint32_t linger)</td></tr>
|
|
<tr class="separator:a25d7847b2e12196d5c30997e92be59ca"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa4c4e88f4b9cebff9c06a3d4e9dd6558"><td class="memItemLeft" align="right" valign="top"><a id="aa4c4e88f4b9cebff9c06a3d4e9dd6558"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><b>GetLinger</b> () const</td></tr>
|
|
<tr class="separator:aa4c4e88f4b9cebff9c06a3d4e9dd6558"><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:a4b06c7cf19f318e40632b5433433647c"><td class="memItemLeft" align="right" valign="top"><a id="a4b06c7cf19f318e40632b5433433647c"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>fRemote</b></td></tr>
|
|
<tr class="separator:a4b06c7cf19f318e40632b5433433647c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a70c33b38d306bade945073e8cce0c4e5"><td class="memItemLeft" align="right" valign="top"><a id="a70c33b38d306bade945073e8cce0c4e5"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><b>fLinger</b></td></tr>
|
|
<tr class="separator:a70c33b38d306bade945073e8cce0c4e5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af175a561ab4be1584241c6616fd316e8"><td class="memItemLeft" align="right" valign="top"><a id="af175a561ab4be1584241c6616fd316e8"></a>
|
|
std::atomic< bool > </td><td class="memItemRight" valign="bottom"><b>fStop</b></td></tr>
|
|
<tr class="separator:af175a561ab4be1584241c6616fd316e8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa46b13131a66d11604522f4df53d90ab"><td class="memItemLeft" align="right" valign="top"><a id="aa46b13131a66d11604522f4df53d90ab"></a>
|
|
std::string </td><td class="memItemRight" valign="bottom"><b>fName</b></td></tr>
|
|
<tr class="separator:aa46b13131a66d11604522f4df53d90ab"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afad02dca29d815fe776450c73a5ac3ab"><td class="memItemLeft" align="right" valign="top"><a id="afad02dca29d815fe776450c73a5ac3ab"></a>
|
|
std::string </td><td class="memItemRight" valign="bottom"><b>fQueueName</b></td></tr>
|
|
<tr class="separator:afad02dca29d815fe776450c73a5ac3ab"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aec14c4eda1609d994403f8c3857b8523"><td class="memItemLeft" align="right" valign="top"><a id="aec14c4eda1609d994403f8c3857b8523"></a>
|
|
boost::interprocess::shared_memory_object </td><td class="memItemRight" valign="bottom"><b>fShmemObject</b></td></tr>
|
|
<tr class="separator:aec14c4eda1609d994403f8c3857b8523"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a85e5086e9188481f835951011f8e5e0e"><td class="memItemLeft" align="right" valign="top"><a id="a85e5086e9188481f835951011f8e5e0e"></a>
|
|
FILE * </td><td class="memItemRight" valign="bottom"><b>fFile</b></td></tr>
|
|
<tr class="separator:a85e5086e9188481f835951011f8e5e0e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a099e9f62e48320bdb539a0b077860755"><td class="memItemLeft" align="right" valign="top"><a id="a099e9f62e48320bdb539a0b077860755"></a>
|
|
boost::interprocess::file_mapping </td><td class="memItemRight" valign="bottom"><b>fFileMapping</b></td></tr>
|
|
<tr class="separator:a099e9f62e48320bdb539a0b077860755"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adfcdfaf0616c19ab6922b190f588d3c1"><td class="memItemLeft" align="right" valign="top"><a id="adfcdfaf0616c19ab6922b190f588d3c1"></a>
|
|
boost::interprocess::mapped_region </td><td class="memItemRight" valign="bottom"><b>fRegion</b></td></tr>
|
|
<tr class="separator:adfcdfaf0616c19ab6922b190f588d3c1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afef5f7dec1889852a8fe02da1e160ccb"><td class="memItemLeft" align="right" valign="top"><a id="afef5f7dec1889852a8fe02da1e160ccb"></a>
|
|
std::mutex </td><td class="memItemRight" valign="bottom"><b>fBlockMtx</b></td></tr>
|
|
<tr class="separator:afef5f7dec1889852a8fe02da1e160ccb"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a45bff4ced34ab0a49b903b37bdc35e1f"><td class="memItemLeft" align="right" valign="top"><a id="a45bff4ced34ab0a49b903b37bdc35e1f"></a>
|
|
std::condition_variable </td><td class="memItemRight" valign="bottom"><b>fBlockSendCV</b></td></tr>
|
|
<tr class="separator:a45bff4ced34ab0a49b903b37bdc35e1f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3d109a23dfca7b6175d4b98a89350aa7"><td class="memItemLeft" align="right" valign="top"><a id="a3d109a23dfca7b6175d4b98a89350aa7"></a>
|
|
std::vector< <a class="el" href="structfair_1_1mq_1_1shmem_1_1RegionBlock.html">RegionBlock</a> > </td><td class="memItemRight" valign="bottom"><b>fBlocksToFree</b></td></tr>
|
|
<tr class="separator:a3d109a23dfca7b6175d4b98a89350aa7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a91316ece8af336e01885ebcdd4f63a41"><td class="memItemLeft" align="right" valign="top"><a id="a91316ece8af336e01885ebcdd4f63a41"></a>
|
|
const std::size_t </td><td class="memItemRight" valign="bottom"><b>fAckBunchSize</b> = 256</td></tr>
|
|
<tr class="separator:a91316ece8af336e01885ebcdd4f63a41"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a07ecc280212256eae69f0167aa1cb9c9"><td class="memItemLeft" align="right" valign="top"><a id="a07ecc280212256eae69f0167aa1cb9c9"></a>
|
|
std::unique_ptr< boost::interprocess::message_queue > </td><td class="memItemRight" valign="bottom"><b>fQueue</b></td></tr>
|
|
<tr class="separator:a07ecc280212256eae69f0167aa1cb9c9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:accde90e52d7aeeec3f56af1730142e5f"><td class="memItemLeft" align="right" valign="top"><a id="accde90e52d7aeeec3f56af1730142e5f"></a>
|
|
std::thread </td><td class="memItemRight" valign="bottom"><b>fAcksReceiver</b></td></tr>
|
|
<tr class="separator:accde90e52d7aeeec3f56af1730142e5f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad7b84c783b22d5961413153ad5236753"><td class="memItemLeft" align="right" valign="top"><a id="ad7b84c783b22d5961413153ad5236753"></a>
|
|
std::thread </td><td class="memItemRight" valign="bottom"><b>fAcksSender</b></td></tr>
|
|
<tr class="separator:ad7b84c783b22d5961413153ad5236753"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a38f214f3d93c96baa8ec2a8e9833e62f"><td class="memItemLeft" align="right" valign="top"><a id="a38f214f3d93c96baa8ec2a8e9833e62f"></a>
|
|
RegionCallback </td><td class="memItemRight" valign="bottom"><b>fCallback</b></td></tr>
|
|
<tr class="separator:a38f214f3d93c96baa8ec2a8e9833e62f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad091b52f1261e2460f8245a8112edb66"><td class="memItemLeft" align="right" valign="top"><a id="ad091b52f1261e2460f8245a8112edb66"></a>
|
|
RegionBulkCallback </td><td class="memItemRight" valign="bottom"><b>fBulkCallback</b></td></tr>
|
|
<tr class="separator:ad091b52f1261e2460f8245a8112edb66"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<hr/>The documentation for this struct was generated from the following file:<ul>
|
|
<li>fairmq/shmem/<a class="el" href="Region_8h_source.html">Region.h</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<p style="margin: 0 12px 10px 12px;"><a href="https://help.github.com/articles/github-privacy-statement/">privacy</a></p>
|