mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 08:41:16 +00:00
180 lines
16 KiB
HTML
180 lines
16 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::Manager 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 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="classfair_1_1mq_1_1shmem_1_1Manager.html">Manager</a></li> </ul>
|
|
</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="classfair_1_1mq_1_1shmem_1_1Manager-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">fair::mq::shmem::Manager Class 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:ad3c91b9fa616b4e59a0f77d4eb463c85"><td class="memItemLeft" align="right" valign="top"><a id="ad3c91b9fa616b4e59a0f77d4eb463c85"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>Manager</b> (std::string shmId, std::string deviceId, size_t size, const <a class="el" href="classfair_1_1mq_1_1ProgOptions.html">ProgOptions</a> *config)</td></tr>
|
|
<tr class="separator:ad3c91b9fa616b4e59a0f77d4eb463c85"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac98a341de68acce3d5ba909df3d154af"><td class="memItemLeft" align="right" valign="top"><a id="ac98a341de68acce3d5ba909df3d154af"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>Manager</b> (const <a class="el" href="classfair_1_1mq_1_1shmem_1_1Manager.html">Manager</a> &)=delete</td></tr>
|
|
<tr class="separator:ac98a341de68acce3d5ba909df3d154af"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7e704b70cf22ff68c93c03a29eb8e66d"><td class="memItemLeft" align="right" valign="top"><a id="a7e704b70cf22ff68c93c03a29eb8e66d"></a>
|
|
<a class="el" href="classfair_1_1mq_1_1shmem_1_1Manager.html">Manager</a> </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classfair_1_1mq_1_1shmem_1_1Manager.html">Manager</a> &)=delete</td></tr>
|
|
<tr class="separator:a7e704b70cf22ff68c93c03a29eb8e66d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a859bf06795513bcd1129f944931e3100"><td class="memItemLeft" align="right" valign="top"><a id="a859bf06795513bcd1129f944931e3100"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>Interrupt</b> ()</td></tr>
|
|
<tr class="separator:a859bf06795513bcd1129f944931e3100"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adcab19238f8df5c76eb35752e1899c13"><td class="memItemLeft" align="right" valign="top"><a id="adcab19238f8df5c76eb35752e1899c13"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>Resume</b> ()</td></tr>
|
|
<tr class="separator:adcab19238f8df5c76eb35752e1899c13"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4193cb0735194571b035925a7301cdd9"><td class="memItemLeft" align="right" valign="top"><a id="a4193cb0735194571b035925a7301cdd9"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>Reset</b> ()</td></tr>
|
|
<tr class="separator:a4193cb0735194571b035925a7301cdd9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a913d218c5e5bfab739f2dfda7916a75b"><td class="memItemLeft" align="right" valign="top"><a id="a913d218c5e5bfab739f2dfda7916a75b"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>Interrupted</b> ()</td></tr>
|
|
<tr class="separator:a913d218c5e5bfab739f2dfda7916a75b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aeb6abf20b217e86b8acd5554431ef6ec"><td class="memItemLeft" align="right" valign="top"><a id="aeb6abf20b217e86b8acd5554431ef6ec"></a>
|
|
std::pair< boost::interprocess::mapped_region *, uint16_t > </td><td class="memItemRight" valign="bottom"><b>CreateRegion</b> (const size_t size, const int64_t userFlags, RegionCallback callback, RegionBulkCallback bulkCallback, const std::string &path="", int flags=0)</td></tr>
|
|
<tr class="separator:aeb6abf20b217e86b8acd5554431ef6ec"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a08b435788b96822e4812309ce99c78d6"><td class="memItemLeft" align="right" valign="top"><a id="a08b435788b96822e4812309ce99c78d6"></a>
|
|
<a class="el" href="structfair_1_1mq_1_1shmem_1_1Region.html">Region</a> * </td><td class="memItemRight" valign="bottom"><b>GetRegion</b> (const uint16_t id)</td></tr>
|
|
<tr class="separator:a08b435788b96822e4812309ce99c78d6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab4bbc84c7852d19a4a88d172cab1235e"><td class="memItemLeft" align="right" valign="top"><a id="ab4bbc84c7852d19a4a88d172cab1235e"></a>
|
|
<a class="el" href="structfair_1_1mq_1_1shmem_1_1Region.html">Region</a> * </td><td class="memItemRight" valign="bottom"><b>GetRegionUnsafe</b> (const uint16_t id)</td></tr>
|
|
<tr class="separator:ab4bbc84c7852d19a4a88d172cab1235e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9630b9ee978b26e0e5a0ef9af1c3083f"><td class="memItemLeft" align="right" valign="top"><a id="a9630b9ee978b26e0e5a0ef9af1c3083f"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>RemoveRegion</b> (const uint16_t id)</td></tr>
|
|
<tr class="separator:a9630b9ee978b26e0e5a0ef9af1c3083f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2ac58a063be8868360124055e036d4a3"><td class="memItemLeft" align="right" valign="top"><a id="a2ac58a063be8868360124055e036d4a3"></a>
|
|
std::vector< <a class="el" href="structFairMQRegionInfo.html">fair::mq::RegionInfo</a> > </td><td class="memItemRight" valign="bottom"><b>GetRegionInfo</b> ()</td></tr>
|
|
<tr class="separator:a2ac58a063be8868360124055e036d4a3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad3b55d3e488a88dee5429625f9b8e6c1"><td class="memItemLeft" align="right" valign="top"><a id="ad3b55d3e488a88dee5429625f9b8e6c1"></a>
|
|
std::vector< <a class="el" href="structFairMQRegionInfo.html">fair::mq::RegionInfo</a> > </td><td class="memItemRight" valign="bottom"><b>GetRegionInfoUnsafe</b> ()</td></tr>
|
|
<tr class="separator:ad3b55d3e488a88dee5429625f9b8e6c1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adfc12b928c747b2373199bfc11aeae16"><td class="memItemLeft" align="right" valign="top"><a id="adfc12b928c747b2373199bfc11aeae16"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>SubscribeToRegionEvents</b> (RegionEventCallback callback)</td></tr>
|
|
<tr class="separator:adfc12b928c747b2373199bfc11aeae16"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac36cddc798c59a90bcb3e7f2f1f661d5"><td class="memItemLeft" align="right" valign="top"><a id="ac36cddc798c59a90bcb3e7f2f1f661d5"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>SubscribedToRegionEvents</b> ()</td></tr>
|
|
<tr class="separator:ac36cddc798c59a90bcb3e7f2f1f661d5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a42b3ef7dc42f7698debafa28059b4c18"><td class="memItemLeft" align="right" valign="top"><a id="a42b3ef7dc42f7698debafa28059b4c18"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>UnsubscribeFromRegionEvents</b> ()</td></tr>
|
|
<tr class="separator:a42b3ef7dc42f7698debafa28059b4c18"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a61e12dc9b663fe94c102390beac3eb78"><td class="memItemLeft" align="right" valign="top"><a id="a61e12dc9b663fe94c102390beac3eb78"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>RegionEventsSubscription</b> ()</td></tr>
|
|
<tr class="separator:a61e12dc9b663fe94c102390beac3eb78"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af98fcd4bc13b7e0e9b9b6ebd58491bda"><td class="memItemLeft" align="right" valign="top"><a id="af98fcd4bc13b7e0e9b9b6ebd58491bda"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>IncrementMsgCounter</b> ()</td></tr>
|
|
<tr class="separator:af98fcd4bc13b7e0e9b9b6ebd58491bda"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abafd2edeac1d34ceeea4568d4b794072"><td class="memItemLeft" align="right" valign="top"><a id="abafd2edeac1d34ceeea4568d4b794072"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>DecrementMsgCounter</b> ()</td></tr>
|
|
<tr class="separator:abafd2edeac1d34ceeea4568d4b794072"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a17af5e47db81da6e565aa7018871178c"><td class="memItemLeft" align="right" valign="top"><a id="a17af5e47db81da6e565aa7018871178c"></a>
|
|
boost::interprocess::named_mutex & </td><td class="memItemRight" valign="bottom"><b>GetMtx</b> ()</td></tr>
|
|
<tr class="separator:a17af5e47db81da6e565aa7018871178c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3b835b15173ce5877410d51e10097eb5"><td class="memItemLeft" align="right" valign="top"><a id="a3b835b15173ce5877410d51e10097eb5"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>SendHeartbeats</b> ()</td></tr>
|
|
<tr class="separator:a3b835b15173ce5877410d51e10097eb5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac123c0353d4d17b99920602ac8c97b78"><td class="memItemLeft" align="right" valign="top"><a id="ac123c0353d4d17b99920602ac8c97b78"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>ThrowingOnBadAlloc</b> () const</td></tr>
|
|
<tr class="separator:ac123c0353d4d17b99920602ac8c97b78"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a91b83975148322ffccdb914793825ce2"><td class="memItemLeft" align="right" valign="top"><a id="a91b83975148322ffccdb914793825ce2"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>GetSegment</b> (uint16_t id)</td></tr>
|
|
<tr class="separator:a91b83975148322ffccdb914793825ce2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adb454ca44e6c7196ac14817f480153f0"><td class="memItemLeft" align="right" valign="top"><a id="adb454ca44e6c7196ac14817f480153f0"></a>
|
|
boost::interprocess::managed_shared_memory::handle_t </td><td class="memItemRight" valign="bottom"><b>GetHandleFromAddress</b> (const void *ptr, uint16_t segmentId) const</td></tr>
|
|
<tr class="separator:adb454ca44e6c7196ac14817f480153f0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a37873394b4b2be38f3ef162772783414"><td class="memItemLeft" align="right" valign="top"><a id="a37873394b4b2be38f3ef162772783414"></a>
|
|
void * </td><td class="memItemRight" valign="bottom"><b>GetAddressFromHandle</b> (const boost::interprocess::managed_shared_memory::handle_t handle, uint16_t segmentId) const</td></tr>
|
|
<tr class="separator:a37873394b4b2be38f3ef162772783414"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a78c9edd2947853161ead99ffbc866962"><td class="memItemLeft" align="right" valign="top"><a id="a78c9edd2947853161ead99ffbc866962"></a>
|
|
char * </td><td class="memItemRight" valign="bottom"><b>Allocate</b> (const size_t size, size_t alignment=0)</td></tr>
|
|
<tr class="separator:a78c9edd2947853161ead99ffbc866962"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acf805ebfdd9779ce65ea07cb624a64a1"><td class="memItemLeft" align="right" valign="top"><a id="acf805ebfdd9779ce65ea07cb624a64a1"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>Deallocate</b> (boost::interprocess::managed_shared_memory::handle_t handle, uint16_t segmentId)</td></tr>
|
|
<tr class="separator:acf805ebfdd9779ce65ea07cb624a64a1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afe791776766c4042f2893a89d2c49b7c"><td class="memItemLeft" align="right" valign="top"><a id="afe791776766c4042f2893a89d2c49b7c"></a>
|
|
char * </td><td class="memItemRight" valign="bottom"><b>ShrinkInPlace</b> (size_t newSize, char *localPtr, uint16_t segmentId)</td></tr>
|
|
<tr class="separator:afe791776766c4042f2893a89d2c49b7c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3369d939ba4b534d0caec9ab0c3466c4"><td class="memItemLeft" align="right" valign="top"><a id="a3369d939ba4b534d0caec9ab0c3466c4"></a>
|
|
uint16_t </td><td class="memItemRight" valign="bottom"><b>GetSegmentId</b> () const</td></tr>
|
|
<tr class="separator:a3369d939ba4b534d0caec9ab0c3466c4"><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:a986c1b33649df4c2a4dde11e9c6d8acf"><td class="memItemLeft" align="right" valign="top"><a id="a986c1b33649df4c2a4dde11e9c6d8acf"></a>
|
|
static void </td><td class="memItemRight" valign="bottom"><b>StartMonitor</b> (const std::string &id)</td></tr>
|
|
<tr class="separator:a986c1b33649df4c2a4dde11e9c6d8acf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>fairmq/shmem/<a class="el" href="Manager_8h_source.html">Manager.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>
|