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.2.3/classFairMQTransportFactorySHM.html
Dennis Klein d1e25efd23
Add API docs for 1.2.3
2018-05-22 16:56:41 +02:00

325 lines
25 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: FairMQTransportFactorySHM 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.2.3</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="classFairMQTransportFactorySHM-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">FairMQTransportFactorySHM Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for FairMQTransportFactorySHM:</div>
<div class="dyncontent">
<div class="center"><img src="classFairMQTransportFactorySHM__inherit__graph.png" border="0" usemap="#FairMQTransportFactorySHM_inherit__map" alt="Inheritance graph"/></div>
<map name="FairMQTransportFactorySHM_inherit__map" id="FairMQTransportFactorySHM_inherit__map">
<area shape="rect" id="node2" href="classFairMQTransportFactory.html" title="FairMQTransportFactory" alt="" coords="20,5,193,32"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for FairMQTransportFactorySHM:</div>
<div class="dyncontent">
<div class="center"><img src="classFairMQTransportFactorySHM__coll__graph.png" border="0" usemap="#FairMQTransportFactorySHM_coll__map" alt="Collaboration graph"/></div>
<map name="FairMQTransportFactorySHM_coll__map" id="FairMQTransportFactorySHM_coll__map">
<area shape="rect" id="node2" href="classFairMQTransportFactory.html" title="FairMQTransportFactory" alt="" coords="20,5,193,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:aa729ed102f21b3422e6c35e2fe7c6ee9"><td class="memItemLeft" align="right" valign="top"><a id="aa729ed102f21b3422e6c35e2fe7c6ee9"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>FairMQTransportFactorySHM</b> (const std::string &amp;id=&quot;&quot;, const <a class="el" href="classFairMQProgOptions.html">FairMQProgOptions</a> *config=nullptr)</td></tr>
<tr class="separator:aa729ed102f21b3422e6c35e2fe7c6ee9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65e1950dc61e80dde6b9de585c2989a4"><td class="memItemLeft" align="right" valign="top"><a id="a65e1950dc61e80dde6b9de585c2989a4"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>FairMQTransportFactorySHM</b> (const <a class="el" href="classFairMQTransportFactorySHM.html">FairMQTransportFactorySHM</a> &amp;)=delete</td></tr>
<tr class="separator:a65e1950dc61e80dde6b9de585c2989a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1bcebbda205c36909ef011ad9c9366e"><td class="memItemLeft" align="right" valign="top"><a id="ae1bcebbda205c36909ef011ad9c9366e"></a>
<a class="el" href="classFairMQTransportFactorySHM.html">FairMQTransportFactorySHM</a>&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classFairMQTransportFactorySHM.html">FairMQTransportFactorySHM</a> &amp;)=delete</td></tr>
<tr class="separator:ae1bcebbda205c36909ef011ad9c9366e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a77aa402c6fe37941fba8c7826f9275a3"><td class="memItemLeft" align="right" valign="top">FairMQMessagePtr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQTransportFactorySHM.html#a77aa402c6fe37941fba8c7826f9275a3">CreateMessage</a> () const override</td></tr>
<tr class="memdesc:a77aa402c6fe37941fba8c7826f9275a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create empty <a class="el" href="classFairMQMessage.html">FairMQMessage</a>. <a href="#a77aa402c6fe37941fba8c7826f9275a3">More...</a><br /></td></tr>
<tr class="separator:a77aa402c6fe37941fba8c7826f9275a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac96d5b86543c4d2420bd210647c8319c"><td class="memItemLeft" align="right" valign="top">FairMQMessagePtr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQTransportFactorySHM.html#ac96d5b86543c4d2420bd210647c8319c">CreateMessage</a> (const size_t size) const override</td></tr>
<tr class="memdesc:ac96d5b86543c4d2420bd210647c8319c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create new <a class="el" href="classFairMQMessage.html">FairMQMessage</a> of specified size. <a href="#ac96d5b86543c4d2420bd210647c8319c">More...</a><br /></td></tr>
<tr class="separator:ac96d5b86543c4d2420bd210647c8319c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6ac1dbb4f86dcff2ee3f7e7732617662"><td class="memItemLeft" align="right" valign="top">FairMQMessagePtr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQTransportFactorySHM.html#a6ac1dbb4f86dcff2ee3f7e7732617662">CreateMessage</a> (void *data, const size_t size, fairmq_free_fn *ffn, void *hint=nullptr) const override</td></tr>
<tr class="memdesc:a6ac1dbb4f86dcff2ee3f7e7732617662"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create new <a class="el" href="classFairMQMessage.html">FairMQMessage</a> with user provided buffer and size. <a href="#a6ac1dbb4f86dcff2ee3f7e7732617662">More...</a><br /></td></tr>
<tr class="separator:a6ac1dbb4f86dcff2ee3f7e7732617662"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a586a884f3f5d5cdff7d6315e2ff98a15"><td class="memItemLeft" align="right" valign="top"><a id="a586a884f3f5d5cdff7d6315e2ff98a15"></a>
FairMQMessagePtr&#160;</td><td class="memItemRight" valign="bottom"><b>CreateMessage</b> (FairMQUnmanagedRegionPtr &amp;region, void *data, const size_t size, void *hint=0) const override</td></tr>
<tr class="separator:a586a884f3f5d5cdff7d6315e2ff98a15"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaef762a56913683bf907076b94e9acbb"><td class="memItemLeft" align="right" valign="top"><a id="aaef762a56913683bf907076b94e9acbb"></a>
FairMQSocketPtr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQTransportFactorySHM.html#aaef762a56913683bf907076b94e9acbb">CreateSocket</a> (const std::string &amp;type, const std::string &amp;name) const override</td></tr>
<tr class="memdesc:aaef762a56913683bf907076b94e9acbb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a socket. <br /></td></tr>
<tr class="separator:aaef762a56913683bf907076b94e9acbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4926bd73e570031db341659b8953c9ed"><td class="memItemLeft" align="right" valign="top"><a id="a4926bd73e570031db341659b8953c9ed"></a>
FairMQPollerPtr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQTransportFactorySHM.html#a4926bd73e570031db341659b8953c9ed">CreatePoller</a> (const std::vector&lt; <a class="el" href="classFairMQChannel.html">FairMQChannel</a> &gt; &amp;channels) const override</td></tr>
<tr class="memdesc:a4926bd73e570031db341659b8953c9ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a poller for a single channel (all subchannels) <br /></td></tr>
<tr class="separator:a4926bd73e570031db341659b8953c9ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a057552d66ac0d09c902900f9685e7fe9"><td class="memItemLeft" align="right" valign="top"><a id="a057552d66ac0d09c902900f9685e7fe9"></a>
FairMQPollerPtr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQTransportFactorySHM.html#a057552d66ac0d09c902900f9685e7fe9">CreatePoller</a> (const std::vector&lt; const <a class="el" href="classFairMQChannel.html">FairMQChannel</a> *&gt; &amp;channels) const override</td></tr>
<tr class="memdesc:a057552d66ac0d09c902900f9685e7fe9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a poller for specific channels. <br /></td></tr>
<tr class="separator:a057552d66ac0d09c902900f9685e7fe9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0fe7eee2b03567ef937738fd7c6a3e5d"><td class="memItemLeft" align="right" valign="top"><a id="a0fe7eee2b03567ef937738fd7c6a3e5d"></a>
FairMQPollerPtr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQTransportFactorySHM.html#a0fe7eee2b03567ef937738fd7c6a3e5d">CreatePoller</a> (const std::unordered_map&lt; std::string, std::vector&lt; <a class="el" href="classFairMQChannel.html">FairMQChannel</a> &gt;&gt; &amp;channelsMap, const std::vector&lt; std::string &gt; &amp;channelList) const override</td></tr>
<tr class="memdesc:a0fe7eee2b03567ef937738fd7c6a3e5d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a poller for specific channels (all subchannels) <br /></td></tr>
<tr class="separator:a0fe7eee2b03567ef937738fd7c6a3e5d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a43a35dfbe5105bbd5044b550dcc763b2"><td class="memItemLeft" align="right" valign="top"><a id="a43a35dfbe5105bbd5044b550dcc763b2"></a>
FairMQPollerPtr&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQTransportFactorySHM.html#a43a35dfbe5105bbd5044b550dcc763b2">CreatePoller</a> (const <a class="el" href="classFairMQSocket.html">FairMQSocket</a> &amp;cmdSocket, const <a class="el" href="classFairMQSocket.html">FairMQSocket</a> &amp;dataSocket) const override</td></tr>
<tr class="memdesc:a43a35dfbe5105bbd5044b550dcc763b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a poller for two sockets. <br /></td></tr>
<tr class="separator:a43a35dfbe5105bbd5044b550dcc763b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6bc25d9a3880e5fcb8ad7de7492f3fb5"><td class="memItemLeft" align="right" valign="top"><a id="a6bc25d9a3880e5fcb8ad7de7492f3fb5"></a>
FairMQUnmanagedRegionPtr&#160;</td><td class="memItemRight" valign="bottom"><b>CreateUnmanagedRegion</b> (const size_t size, FairMQRegionCallback callback=nullptr) const override</td></tr>
<tr class="separator:a6bc25d9a3880e5fcb8ad7de7492f3fb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac0ea415aee514cfa5ed977caf4f32d72"><td class="memItemLeft" align="right" valign="top"><a id="ac0ea415aee514cfa5ed977caf4f32d72"></a>
fair::mq::Transport&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQTransportFactorySHM.html#ac0ea415aee514cfa5ed977caf4f32d72">GetType</a> () const override</td></tr>
<tr class="memdesc:ac0ea415aee514cfa5ed977caf4f32d72"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get transport type. <br /></td></tr>
<tr class="separator:ac0ea415aee514cfa5ed977caf4f32d72"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a006d225c508de61e08f6dd14b4bc4113"><td class="memItemLeft" align="right" valign="top"><a id="a006d225c508de61e08f6dd14b4bc4113"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>Interrupt</b> () override</td></tr>
<tr class="separator:a006d225c508de61e08f6dd14b4bc4113"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae9711786500704535b9cfad812e90368"><td class="memItemLeft" align="right" valign="top"><a id="ae9711786500704535b9cfad812e90368"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>Resume</b> () override</td></tr>
<tr class="separator:ae9711786500704535b9cfad812e90368"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classFairMQTransportFactory"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classFairMQTransportFactory')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a></td></tr>
<tr class="memitem:aafbb0f83fc97a50e96c7e6616bc215c9 inherit pub_methods_classFairMQTransportFactory"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classFairMQTransportFactory.html#aafbb0f83fc97a50e96c7e6616bc215c9">FairMQTransportFactory</a> (const std::string &amp;id)</td></tr>
<tr class="separator:aafbb0f83fc97a50e96c7e6616bc215c9 inherit pub_methods_classFairMQTransportFactory"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a56b39bedec57fb890cee700bf8653f5a inherit pub_methods_classFairMQTransportFactory"><td class="memItemLeft" align="right" valign="top"><a id="a56b39bedec57fb890cee700bf8653f5a"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>GetId</b> () const -&gt; const std::string</td></tr>
<tr class="separator:a56b39bedec57fb890cee700bf8653f5a inherit pub_methods_classFairMQTransportFactory"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa205c82635147a509f347772b6b1b2b0 inherit pub_methods_classFairMQTransportFactory"><td class="memTemplParams" colspan="2"><a id="aa205c82635147a509f347772b6b1b2b0"></a>
template&lt;typename T &gt; </td></tr>
<tr class="memitem:aa205c82635147a509f347772b6b1b2b0 inherit pub_methods_classFairMQTransportFactory"><td class="memTemplItemLeft" align="right" valign="top">FairMQMessagePtr&#160;</td><td class="memTemplItemRight" valign="bottom"><b>NewSimpleMessage</b> (const T &amp;data) const</td></tr>
<tr class="separator:aa205c82635147a509f347772b6b1b2b0 inherit pub_methods_classFairMQTransportFactory"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a629616759b08054968b631939513a3af inherit pub_methods_classFairMQTransportFactory"><td class="memTemplParams" colspan="2"><a id="a629616759b08054968b631939513a3af"></a>
template&lt;std::size_t N&gt; </td></tr>
<tr class="memitem:a629616759b08054968b631939513a3af inherit pub_methods_classFairMQTransportFactory"><td class="memTemplItemLeft" align="right" valign="top">FairMQMessagePtr&#160;</td><td class="memTemplItemRight" valign="bottom"><b>NewSimpleMessage</b> (const char(&amp;data)[N]) const</td></tr>
<tr class="separator:a629616759b08054968b631939513a3af inherit pub_methods_classFairMQTransportFactory"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a95787b67d0602c1bf6c9d0c311b04ca0 inherit pub_methods_classFairMQTransportFactory"><td class="memItemLeft" align="right" valign="top"><a id="a95787b67d0602c1bf6c9d0c311b04ca0"></a>
FairMQMessagePtr&#160;</td><td class="memItemRight" valign="bottom"><b>NewSimpleMessage</b> (const std::string &amp;str) const</td></tr>
<tr class="separator:a95787b67d0602c1bf6c9d0c311b04ca0 inherit pub_methods_classFairMQTransportFactory"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae5f1390ec7571b4d0e6cbe3cc3f92656 inherit pub_methods_classFairMQTransportFactory"><td class="memTemplParams" colspan="2"><a id="ae5f1390ec7571b4d0e6cbe3cc3f92656"></a>
template&lt;typename T &gt; </td></tr>
<tr class="memitem:ae5f1390ec7571b4d0e6cbe3cc3f92656 inherit pub_methods_classFairMQTransportFactory"><td class="memTemplItemLeft" align="right" valign="top">FairMQMessagePtr&#160;</td><td class="memTemplItemRight" valign="bottom"><b>NewStaticMessage</b> (const T &amp;data) const</td></tr>
<tr class="separator:ae5f1390ec7571b4d0e6cbe3cc3f92656 inherit pub_methods_classFairMQTransportFactory"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2515ea8a834cfddb52192c52965e306a inherit pub_methods_classFairMQTransportFactory"><td class="memItemLeft" align="right" valign="top"><a id="a2515ea8a834cfddb52192c52965e306a"></a>
FairMQMessagePtr&#160;</td><td class="memItemRight" valign="bottom"><b>NewStaticMessage</b> (const std::string &amp;str) const</td></tr>
<tr class="separator:a2515ea8a834cfddb52192c52965e306a inherit pub_methods_classFairMQTransportFactory"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_static_methods_classFairMQTransportFactory"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classFairMQTransportFactory')"><img src="closed.png" alt="-"/>&#160;Static Public Member Functions inherited from <a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a></td></tr>
<tr class="memitem:a702085eb13b47c137a1ccb631249bfb8 inherit pub_static_methods_classFairMQTransportFactory"><td class="memItemLeft" align="right" valign="top"><a id="a702085eb13b47c137a1ccb631249bfb8"></a>
static auto&#160;</td><td class="memItemRight" valign="bottom"><b>CreateTransportFactory</b> (const std::string &amp;type, const std::string &amp;id=&quot;&quot;, const <a class="el" href="classFairMQProgOptions.html">FairMQProgOptions</a> *config=nullptr) -&gt; std::shared_ptr&lt; <a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> &gt;</td></tr>
<tr class="separator:a702085eb13b47c137a1ccb631249bfb8 inherit pub_static_methods_classFairMQTransportFactory"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1e3f845a722ba2c7effb7ba4d609be8b inherit pub_static_methods_classFairMQTransportFactory"><td class="memItemLeft" align="right" valign="top"><a id="a1e3f845a722ba2c7effb7ba4d609be8b"></a>
static void&#160;</td><td class="memItemRight" valign="bottom"><b>FairMQNoCleanup</b> (void *, void *)</td></tr>
<tr class="separator:a1e3f845a722ba2c7effb7ba4d609be8b inherit pub_static_methods_classFairMQTransportFactory"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a749b6b1f0c527a2ea28e9d78e5953a98 inherit pub_static_methods_classFairMQTransportFactory"><td class="memTemplParams" colspan="2"><a id="a749b6b1f0c527a2ea28e9d78e5953a98"></a>
template&lt;typename T &gt; </td></tr>
<tr class="memitem:a749b6b1f0c527a2ea28e9d78e5953a98 inherit pub_static_methods_classFairMQTransportFactory"><td class="memTemplItemLeft" align="right" valign="top">static void&#160;</td><td class="memTemplItemRight" valign="bottom"><b>FairMQSimpleMsgCleanup</b> (void *, void *obj)</td></tr>
<tr class="separator:a749b6b1f0c527a2ea28e9d78e5953a98 inherit pub_static_methods_classFairMQTransportFactory"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a77aa402c6fe37941fba8c7826f9275a3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a77aa402c6fe37941fba8c7826f9275a3">&#9670;&nbsp;</a></span>CreateMessage() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">FairMQMessagePtr FairMQTransportFactorySHM::CreateMessage </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create empty <a class="el" href="classFairMQMessage.html">FairMQMessage</a>. </p>
<dl class="section return"><dt>Returns</dt><dd>pointer to <a class="el" href="classFairMQMessage.html">FairMQMessage</a> </dd></dl>
<p>Implements <a class="el" href="classFairMQTransportFactory.html#a25118b9f75be87ba31f9ef793ba29014">FairMQTransportFactory</a>.</p>
</div>
</div>
<a id="ac96d5b86543c4d2420bd210647c8319c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac96d5b86543c4d2420bd210647c8319c">&#9670;&nbsp;</a></span>CreateMessage() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">FairMQMessagePtr FairMQTransportFactorySHM::CreateMessage </td>
<td>(</td>
<td class="paramtype">const size_t&#160;</td>
<td class="paramname"><em>size</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create new <a class="el" href="classFairMQMessage.html">FairMQMessage</a> of specified size. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>message size </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>pointer to <a class="el" href="classFairMQMessage.html">FairMQMessage</a> </dd></dl>
<p>Implements <a class="el" href="classFairMQTransportFactory.html#a81097c35318ed699cad37accc16d53e9">FairMQTransportFactory</a>.</p>
</div>
</div>
<a id="a6ac1dbb4f86dcff2ee3f7e7732617662"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6ac1dbb4f86dcff2ee3f7e7732617662">&#9670;&nbsp;</a></span>CreateMessage() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">FairMQMessagePtr FairMQTransportFactorySHM::CreateMessage </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const size_t&#160;</td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">fairmq_free_fn *&#160;</td>
<td class="paramname"><em>ffn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>hint</em> = <code>nullptr</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Create new <a class="el" href="classFairMQMessage.html">FairMQMessage</a> with user provided buffer and size. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">data</td><td>pointer to user provided buffer </td></tr>
<tr><td class="paramname">size</td><td>size of the user provided buffer </td></tr>
<tr><td class="paramname">ffn</td><td>callback, called when the message is transfered (and can be deleted) </td></tr>
<tr><td class="paramname">obj</td><td>optional helper pointer that can be used in the callback </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>pointer to <a class="el" href="classFairMQMessage.html">FairMQMessage</a> </dd></dl>
<p>Implements <a class="el" href="classFairMQTransportFactory.html#a11bc1c0070058dbed6280b4b847016a4">FairMQTransportFactory</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>fairmq/shmem/<a class="el" href="FairMQTransportFactorySHM_8h_source.html">FairMQTransportFactorySHM.h</a></li>
<li>fairmq/shmem/FairMQTransportFactorySHM.cxx</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink