Mirror/FairMQ
1
0
Fork 0
mirror of https://github.com/FairRootGroup/FairMQ.git synced 2025-12-18 08:50:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add API docs for 1.4.14

Browse Source
This commit is contained in:
Alexey Rybalchenko
2020-04-28 15:12:15 +02:00
parent 95b8ff7858
commit 6101a6678e
1714 changed files with 68444 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

160
v1.4.14/classfair_1_1mq_1_1shmem_1_1Manager.html Normal file
View File

@@ -0,0 +1,160 @@
<!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::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
&#160;<span id="projectnumber">1.4.14</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.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="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> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<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:a0814e37f80e5e5a47e6284bd8bd58899"><td class="memItemLeft" align="right" valign="top"><a id="a0814e37f80e5e5a47e6284bd8bd58899"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Manager</b> (const std::string &amp;id, size_t size)</td></tr>
<tr class="separator:a0814e37f80e5e5a47e6284bd8bd58899"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac98a341de68acce3d5ba909df3d154af"><td class="memItemLeft" align="right" valign="top"><a id="ac98a341de68acce3d5ba909df3d154af"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Manager</b> (const <a class="el" href="classfair_1_1mq_1_1shmem_1_1Manager.html">Manager</a> &amp;)=delete</td></tr>
<tr class="separator:ac98a341de68acce3d5ba909df3d154af"><td class="memSeparator" colspan="2">&#160;</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>&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classfair_1_1mq_1_1shmem_1_1Manager.html">Manager</a> &amp;)=delete</td></tr>
<tr class="separator:a7e704b70cf22ff68c93c03a29eb8e66d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa238fff6894a48234ec9207b8d205f6d"><td class="memItemLeft" align="right" valign="top"><a id="aa238fff6894a48234ec9207b8d205f6d"></a>
boost::interprocess::managed_shared_memory &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>Segment</b> ()</td></tr>
<tr class="separator:aa238fff6894a48234ec9207b8d205f6d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a037bcf92e14583576f3fbd5604704170"><td class="memItemLeft" align="right" valign="top"><a id="a037bcf92e14583576f3fbd5604704170"></a>
boost::interprocess::managed_shared_memory &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>ManagementSegment</b> ()</td></tr>
<tr class="separator:a037bcf92e14583576f3fbd5604704170"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a859bf06795513bcd1129f944931e3100"><td class="memItemLeft" align="right" valign="top"><a id="a859bf06795513bcd1129f944931e3100"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>Interrupt</b> ()</td></tr>
<tr class="separator:a859bf06795513bcd1129f944931e3100"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adcab19238f8df5c76eb35752e1899c13"><td class="memItemLeft" align="right" valign="top"><a id="adcab19238f8df5c76eb35752e1899c13"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>Resume</b> ()</td></tr>
<tr class="separator:adcab19238f8df5c76eb35752e1899c13"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a913d218c5e5bfab739f2dfda7916a75b"><td class="memItemLeft" align="right" valign="top"><a id="a913d218c5e5bfab739f2dfda7916a75b"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>Interrupted</b> ()</td></tr>
<tr class="separator:a913d218c5e5bfab739f2dfda7916a75b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adf9b1053d707ec700f1f4e84d6d3a758"><td class="memItemLeft" align="right" valign="top"><a id="adf9b1053d707ec700f1f4e84d6d3a758"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>GetDeviceCounter</b> ()</td></tr>
<tr class="separator:adf9b1053d707ec700f1f4e84d6d3a758"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d08865d8daec6cee5ea988bcde3fd2e"><td class="memItemLeft" align="right" valign="top"><a id="a4d08865d8daec6cee5ea988bcde3fd2e"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>IncrementDeviceCounter</b> ()</td></tr>
<tr class="separator:a4d08865d8daec6cee5ea988bcde3fd2e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaeb39bc1b36b190f4cb75d12c52ed095"><td class="memItemLeft" align="right" valign="top"><a id="aaeb39bc1b36b190f4cb75d12c52ed095"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>DecrementDeviceCounter</b> ()</td></tr>
<tr class="separator:aaeb39bc1b36b190f4cb75d12c52ed095"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abb9aedc533dc2f08662129b00b609c5b"><td class="memItemLeft" align="right" valign="top"><a id="abb9aedc533dc2f08662129b00b609c5b"></a>
std::pair&lt; boost::interprocess::mapped_region *, uint64_t &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>CreateRegion</b> (const size_t size, const int64_t userFlags, RegionCallback callback, const std::string &amp;path=&quot;&quot;, int flags=0)</td></tr>
<tr class="separator:abb9aedc533dc2f08662129b00b609c5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a608a5a32dc0e4bb8ed418bb5d445998c"><td class="memItemLeft" align="right" valign="top"><a id="a608a5a32dc0e4bb8ed418bb5d445998c"></a>
<a class="el" href="structfair_1_1mq_1_1shmem_1_1Region.html">Region</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>GetRegion</b> (const uint64_t id)</td></tr>
<tr class="separator:a608a5a32dc0e4bb8ed418bb5d445998c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a817479f05d3bcd3065667eefb131fb57"><td class="memItemLeft" align="right" valign="top"><a id="a817479f05d3bcd3065667eefb131fb57"></a>
<a class="el" href="structfair_1_1mq_1_1shmem_1_1Region.html">Region</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>GetRegionUnsafe</b> (const uint64_t id)</td></tr>
<tr class="separator:a817479f05d3bcd3065667eefb131fb57"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2a0e23dd8ad6d0c0fee733526823264a"><td class="memItemLeft" align="right" valign="top"><a id="a2a0e23dd8ad6d0c0fee733526823264a"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>RemoveRegion</b> (const uint64_t id)</td></tr>
<tr class="separator:a2a0e23dd8ad6d0c0fee733526823264a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acdfa93e9182e49cb0ec11d1448fa70b6"><td class="memItemLeft" align="right" valign="top"><a id="acdfa93e9182e49cb0ec11d1448fa70b6"></a>
std::vector&lt; <a class="el" href="structFairMQRegionInfo.html">fair::mq::RegionInfo</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>GetRegionInfo</b> ()</td></tr>
<tr class="separator:acdfa93e9182e49cb0ec11d1448fa70b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9898344a5a8c17735984f12c8ce4e7dc"><td class="memItemLeft" align="right" valign="top"><a id="a9898344a5a8c17735984f12c8ce4e7dc"></a>
std::vector&lt; <a class="el" href="structFairMQRegionInfo.html">fair::mq::RegionInfo</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>GetRegionInfoUnsafe</b> ()</td></tr>
<tr class="separator:a9898344a5a8c17735984f12c8ce4e7dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adfc12b928c747b2373199bfc11aeae16"><td class="memItemLeft" align="right" valign="top"><a id="adfc12b928c747b2373199bfc11aeae16"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>SubscribeToRegionEvents</b> (RegionEventCallback callback)</td></tr>
<tr class="separator:adfc12b928c747b2373199bfc11aeae16"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a42b3ef7dc42f7698debafa28059b4c18"><td class="memItemLeft" align="right" valign="top"><a id="a42b3ef7dc42f7698debafa28059b4c18"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>UnsubscribeFromRegionEvents</b> ()</td></tr>
<tr class="separator:a42b3ef7dc42f7698debafa28059b4c18"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a61e12dc9b663fe94c102390beac3eb78"><td class="memItemLeft" align="right" valign="top"><a id="a61e12dc9b663fe94c102390beac3eb78"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>RegionEventsSubscription</b> ()</td></tr>
<tr class="separator:a61e12dc9b663fe94c102390beac3eb78"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae04bceb19a11786595e281e93012d24d"><td class="memItemLeft" align="right" valign="top"><a id="ae04bceb19a11786595e281e93012d24d"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>RemoveSegments</b> ()</td></tr>
<tr class="separator:ae04bceb19a11786595e281e93012d24d"><td class="memSeparator" colspan="2">&#160;</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:afe2a5e0940212e3c2b3a464b7886363c"><td class="memItemLeft" align="right" valign="top"><a id="afe2a5e0940212e3c2b3a464b7886363c"></a>
static void&#160;</td><td class="memItemRight" valign="bottom"><b>StartMonitor</b> (const std::string &amp;)</td></tr>
<tr class="separator:afe2a5e0940212e3c2b3a464b7886363c"><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:a091820603b0c7a0963592a7149027154"><td class="memItemLeft" align="right" valign="top"><a id="a091820603b0c7a0963592a7149027154"></a>
struct&#160;</td><td class="memItemRight" valign="bottom"><b>Region</b></td></tr>
<tr class="separator:a091820603b0c7a0963592a7149027154"><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="Manager_8h_source.html">Manager.h</a></li>
<li>fairmq/shmem/Manager.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>