Mirror/FairMQ
1
0
Fork 0
mirror of https://github.com/FairRootGroup/FairMQ.git synced 2025-10-16 01:51:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add API docs for v1.4.33

Browse Source
This commit is contained in:
Alexey Rybalchenko
2021-03-23 14:11:44 +01:00
parent 6101a6678e
commit 6d82d305b9
1791 changed files with 88009 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

141
v1.4.33/classfair_1_1mq_1_1shmem_1_1UnmanagedRegion.html Normal file
View File

@@ -0,0 +1,141 @@
<!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::UnmanagedRegion 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.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&amp;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&amp;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_1UnmanagedRegion.html">UnmanagedRegion</a></li> </ul>
</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="classfair_1_1mq_1_1shmem_1_1UnmanagedRegion-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">fair::mq::shmem::UnmanagedRegion Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for fair::mq::shmem::UnmanagedRegion:</div>
<div class="dyncontent">
<div class="center"><img src="classfair_1_1mq_1_1shmem_1_1UnmanagedRegion__inherit__graph.png" border="0" usemap="#fair_1_1mq_1_1shmem_1_1UnmanagedRegion_inherit__map" alt="Inheritance graph"/></div>
<map name="fair_1_1mq_1_1shmem_1_1UnmanagedRegion_inherit__map" id="fair_1_1mq_1_1shmem_1_1UnmanagedRegion_inherit__map">
<area shape="rect" title=" " alt="" coords="5,80,223,121"/>
<area shape="rect" href="classFairMQUnmanagedRegion.html" title=" " alt="" coords="11,5,217,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for fair::mq::shmem::UnmanagedRegion:</div>
<div class="dyncontent">
<div class="center"><img src="classfair_1_1mq_1_1shmem_1_1UnmanagedRegion__coll__graph.png" border="0" usemap="#fair_1_1mq_1_1shmem_1_1UnmanagedRegion_coll__map" alt="Collaboration graph"/></div>
<map name="fair_1_1mq_1_1shmem_1_1UnmanagedRegion_coll__map" id="fair_1_1mq_1_1shmem_1_1UnmanagedRegion_coll__map">
<area shape="rect" title=" " alt="" coords="5,80,223,121"/>
<area shape="rect" href="classFairMQUnmanagedRegion.html" title=" " alt="" coords="11,5,217,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:ad691fb40b2de9ef8481947f004b59a7d"><td class="memItemLeft" align="right" valign="top"><a id="ad691fb40b2de9ef8481947f004b59a7d"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>UnmanagedRegion</b> (<a class="el" href="classfair_1_1mq_1_1shmem_1_1Manager.html">Manager</a> &amp;manager, const size_t size, const int64_t userFlags, RegionCallback callback, RegionBulkCallback bulkCallback, const std::string &amp;path=&quot;&quot;, int flags=0, <a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> *factory=nullptr)</td></tr>
<tr class="separator:ad691fb40b2de9ef8481947f004b59a7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4c0ba042a8c73334629482c1fe8bb4af"><td class="memItemLeft" align="right" valign="top"><a id="a4c0ba042a8c73334629482c1fe8bb4af"></a>
void *&#160;</td><td class="memItemRight" valign="bottom"><b>GetData</b> () const override</td></tr>
<tr class="separator:a4c0ba042a8c73334629482c1fe8bb4af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a22511fd6e22aaa6f1ba2cd4343c4ce5a"><td class="memItemLeft" align="right" valign="top"><a id="a22511fd6e22aaa6f1ba2cd4343c4ce5a"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>GetSize</b> () const override</td></tr>
<tr class="separator:a22511fd6e22aaa6f1ba2cd4343c4ce5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf06af71c2def3a2d33729c5e66d7066"><td class="memItemLeft" align="right" valign="top"><a id="aaf06af71c2def3a2d33729c5e66d7066"></a>
uint16_t&#160;</td><td class="memItemRight" valign="bottom"><b>GetId</b> () const override</td></tr>
<tr class="separator:aaf06af71c2def3a2d33729c5e66d7066"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a528b2844433cfa27cdfec2158c26f4c8"><td class="memItemLeft" align="right" valign="top"><a id="a528b2844433cfa27cdfec2158c26f4c8"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>SetLinger</b> (uint32_t linger) override</td></tr>
<tr class="separator:a528b2844433cfa27cdfec2158c26f4c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7600dbd2cd9503883c9403facaea2cbf"><td class="memItemLeft" align="right" valign="top"><a id="a7600dbd2cd9503883c9403facaea2cbf"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><b>GetLinger</b> () const override</td></tr>
<tr class="separator:a7600dbd2cd9503883c9403facaea2cbf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classFairMQUnmanagedRegion"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classFairMQUnmanagedRegion')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classFairMQUnmanagedRegion.html">FairMQUnmanagedRegion</a></td></tr>
<tr class="memitem:ae5ae3a8323861cad3df9ba73c2063f04 inherit pub_methods_classFairMQUnmanagedRegion"><td class="memItemLeft" align="right" valign="top"><a id="ae5ae3a8323861cad3df9ba73c2063f04"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>FairMQUnmanagedRegion</b> (<a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> *factory)</td></tr>
<tr class="separator:ae5ae3a8323861cad3df9ba73c2063f04 inherit pub_methods_classFairMQUnmanagedRegion"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80c1e3e53101a411fd45b80fd9115ab4 inherit pub_methods_classFairMQUnmanagedRegion"><td class="memItemLeft" align="right" valign="top"><a id="a80c1e3e53101a411fd45b80fd9115ab4"></a>
<a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>GetTransport</b> ()</td></tr>
<tr class="separator:a80c1e3e53101a411fd45b80fd9115ab4 inherit pub_methods_classFairMQUnmanagedRegion"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a22da1c1a8847c4f7522c6e876ad3a16e inherit pub_methods_classFairMQUnmanagedRegion"><td class="memItemLeft" align="right" valign="top"><a id="a22da1c1a8847c4f7522c6e876ad3a16e"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>SetTransport</b> (<a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> *transport)</td></tr>
<tr class="separator:a22da1c1a8847c4f7522c6e876ad3a16e inherit pub_methods_classFairMQUnmanagedRegion"><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:a658ef47bd757fd5e0f13adab5a417ced"><td class="memItemLeft" align="right" valign="top"><a id="a658ef47bd757fd5e0f13adab5a417ced"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>Message</b></td></tr>
<tr class="separator:a658ef47bd757fd5e0f13adab5a417ced"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab510887d735ee73ab1cb598c66260e87"><td class="memItemLeft" align="right" valign="top"><a id="ab510887d735ee73ab1cb598c66260e87"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>Socket</b></td></tr>
<tr class="separator:ab510887d735ee73ab1cb598c66260e87"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>fairmq/shmem/<a class="el" href="shmem_2UnmanagedRegion_8h_source.html">UnmanagedRegion.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>