Mirror/FairMQ
1
0
Fork 0
mirror of https://github.com/FairRootGroup/FairMQ.git synced 2025-10-13 08:41:16 +00:00
Code Issues Packages Projects Releases Wiki Activity
gh-pages
FairMQ/v1.3.7/classFairMQMessageSHM.html
Alexey Rybalchenko eb43855b10 Add API docs for 1.3.7
2018-11-29 13:31:29 +01:00

152 lines
12 KiB
HTML
Raw Permalink Blame History

<!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: FairMQMessageSHM 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.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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classFairMQMessageSHM-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">FairMQMessageSHM Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for FairMQMessageSHM:</div>
<div class="dyncontent">
<div class="center"><img src="classFairMQMessageSHM__inherit__graph.png" border="0" usemap="#FairMQMessageSHM_inherit__map" alt="Inheritance graph"/></div>
<map name="FairMQMessageSHM_inherit__map" id="FairMQMessageSHM_inherit__map">
<area shape="rect" id="node2" href="classFairMQMessage.html" title="FairMQMessage" alt="" coords="20,5,139,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for FairMQMessageSHM:</div>
<div class="dyncontent">
<div class="center"><img src="classFairMQMessageSHM__coll__graph.png" border="0" usemap="#FairMQMessageSHM_coll__map" alt="Collaboration graph"/></div>
<map name="FairMQMessageSHM_coll__map" id="FairMQMessageSHM_coll__map">
<area shape="rect" id="node2" href="classFairMQMessage.html" title="FairMQMessage" alt="" coords="20,5,139,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:a8855d9591e01bb57a70125cda6ac00ca"><td class="memItemLeft" align="right" valign="top"><a id="a8855d9591e01bb57a70125cda6ac00ca"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>FairMQMessageSHM</b> (<a class="el" href="classfair_1_1mq_1_1shmem_1_1Manager.html">fair::mq::shmem::Manager</a> &amp;manager, <a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> *factory=nullptr)</td></tr>
<tr class="separator:a8855d9591e01bb57a70125cda6ac00ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae8351e01fc324aee06e789b0dadf42d1"><td class="memItemLeft" align="right" valign="top"><a id="ae8351e01fc324aee06e789b0dadf42d1"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>FairMQMessageSHM</b> (<a class="el" href="classfair_1_1mq_1_1shmem_1_1Manager.html">fair::mq::shmem::Manager</a> &amp;manager, const size_t size, <a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> *factory=nullptr)</td></tr>
<tr class="separator:ae8351e01fc324aee06e789b0dadf42d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5825ded9177c58871e9943e402fe54db"><td class="memItemLeft" align="right" valign="top"><a id="a5825ded9177c58871e9943e402fe54db"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>FairMQMessageSHM</b> (<a class="el" href="classfair_1_1mq_1_1shmem_1_1Manager.html">fair::mq::shmem::Manager</a> &amp;manager, void *data, const size_t size, fairmq_free_fn *ffn, void *hint=nullptr, <a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> *factory=nullptr)</td></tr>
<tr class="separator:a5825ded9177c58871e9943e402fe54db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2c9c3ec2d49c106a7d3924241909e1e"><td class="memItemLeft" align="right" valign="top"><a id="ae2c9c3ec2d49c106a7d3924241909e1e"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>FairMQMessageSHM</b> (<a class="el" href="classfair_1_1mq_1_1shmem_1_1Manager.html">fair::mq::shmem::Manager</a> &amp;manager, FairMQUnmanagedRegionPtr &amp;region, void *data, const size_t size, void *hint=0, <a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> *factory=nullptr)</td></tr>
<tr class="separator:ae2c9c3ec2d49c106a7d3924241909e1e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d0f93ca813bbe47ee6b6f6c10362f2f"><td class="memItemLeft" align="right" valign="top"><a id="a0d0f93ca813bbe47ee6b6f6c10362f2f"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>FairMQMessageSHM</b> (const <a class="el" href="classFairMQMessageSHM.html">FairMQMessageSHM</a> &amp;)=delete</td></tr>
<tr class="separator:a0d0f93ca813bbe47ee6b6f6c10362f2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab3a043af12b3b1a7b122e40bbfeb2e13"><td class="memItemLeft" align="right" valign="top"><a id="ab3a043af12b3b1a7b122e40bbfeb2e13"></a>
<a class="el" href="classFairMQMessageSHM.html">FairMQMessageSHM</a>&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classFairMQMessageSHM.html">FairMQMessageSHM</a> &amp;)=delete</td></tr>
<tr class="separator:ab3a043af12b3b1a7b122e40bbfeb2e13"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a691d864baff0218d81def0d95968d25e"><td class="memItemLeft" align="right" valign="top"><a id="a691d864baff0218d81def0d95968d25e"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>Rebuild</b> () override</td></tr>
<tr class="separator:a691d864baff0218d81def0d95968d25e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af65e48ac09df9183fd2517f5beb44f20"><td class="memItemLeft" align="right" valign="top"><a id="af65e48ac09df9183fd2517f5beb44f20"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>Rebuild</b> (const size_t size) override</td></tr>
<tr class="separator:af65e48ac09df9183fd2517f5beb44f20"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aadf7b18e9a99550d661091fc2eb3ef30"><td class="memItemLeft" align="right" valign="top"><a id="aadf7b18e9a99550d661091fc2eb3ef30"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>Rebuild</b> (void *data, const size_t size, fairmq_free_fn *ffn, void *hint=nullptr) override</td></tr>
<tr class="separator:aadf7b18e9a99550d661091fc2eb3ef30"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c9627aae793cdfca3eea7e78177b83e"><td class="memItemLeft" align="right" valign="top"><a id="a8c9627aae793cdfca3eea7e78177b83e"></a>
void *&#160;</td><td class="memItemRight" valign="bottom"><b>GetData</b> () const override</td></tr>
<tr class="separator:a8c9627aae793cdfca3eea7e78177b83e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac3b2a0407c0dfd5a7b4da47a5d9c5047"><td class="memItemLeft" align="right" valign="top"><a id="ac3b2a0407c0dfd5a7b4da47a5d9c5047"></a>
size_t&#160;</td><td class="memItemRight" valign="bottom"><b>GetSize</b> () const override</td></tr>
<tr class="separator:ac3b2a0407c0dfd5a7b4da47a5d9c5047"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a97f34726b6add7e60a464fcd81c4b42f"><td class="memItemLeft" align="right" valign="top"><a id="a97f34726b6add7e60a464fcd81c4b42f"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>SetUsedSize</b> (const size_t size) override</td></tr>
<tr class="separator:a97f34726b6add7e60a464fcd81c4b42f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad070a3d3bac86d657dd1babefe03cd93"><td class="memItemLeft" align="right" valign="top"><a id="ad070a3d3bac86d657dd1babefe03cd93"></a>
fair::mq::Transport&#160;</td><td class="memItemRight" valign="bottom"><b>GetType</b> () const override</td></tr>
<tr class="separator:ad070a3d3bac86d657dd1babefe03cd93"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad88a60d5c6b075fbf34969e34a77f2dc"><td class="memItemLeft" align="right" valign="top"><a id="ad88a60d5c6b075fbf34969e34a77f2dc"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>Copy</b> (const <a class="el" href="classFairMQMessage.html">FairMQMessage</a> &amp;msg) override</td></tr>
<tr class="separator:ad88a60d5c6b075fbf34969e34a77f2dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classFairMQMessage"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classFairMQMessage')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classFairMQMessage.html">FairMQMessage</a></td></tr>
<tr class="memitem:a5f154d1d94d95d05641a6309732c7284 inherit pub_methods_classFairMQMessage"><td class="memItemLeft" align="right" valign="top"><a id="a5f154d1d94d95d05641a6309732c7284"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>FairMQMessage</b> (<a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> *factory)</td></tr>
<tr class="separator:a5f154d1d94d95d05641a6309732c7284 inherit pub_methods_classFairMQMessage"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94e8e6a871d57bd04d58ef62d27f532d inherit pub_methods_classFairMQMessage"><td class="memItemLeft" align="right" valign="top"><a id="a94e8e6a871d57bd04d58ef62d27f532d"></a>
<a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>GetTransport</b> ()</td></tr>
<tr class="separator:a94e8e6a871d57bd04d58ef62d27f532d inherit pub_methods_classFairMQMessage"><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:a73d018e529c2d003d69578305e1bf5f7"><td class="memItemLeft" align="right" valign="top"><a id="a73d018e529c2d003d69578305e1bf5f7"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>FairMQSocketSHM</b></td></tr>
<tr class="separator:a73d018e529c2d003d69578305e1bf5f7"><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="FairMQMessageSHM_8h_source.html">FairMQMessageSHM.h</a></li>
<li>fairmq/shmem/FairMQMessageSHM.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>
Reference in New Issue View Git Blame Copy Permalink