mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 08:41:16 +00:00
143 lines
7.7 KiB
HTML
143 lines
7.7 KiB
HTML
<!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::FairMQMemoryResource 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.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 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"><a class="el" href="classfair_1_1mq_1_1FairMQMemoryResource.html">FairMQMemoryResource</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="classfair_1_1mq_1_1FairMQMemoryResource-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">fair::mq::FairMQMemoryResource Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p><code>#include <<a class="el" href="MemoryResources_8h_source.html">MemoryResources.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for fair::mq::FairMQMemoryResource:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classfair_1_1mq_1_1FairMQMemoryResource__inherit__graph.png" border="0" usemap="#fair_1_1mq_1_1FairMQMemoryResource_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="fair_1_1mq_1_1FairMQMemoryResource_inherit__map" id="fair_1_1mq_1_1FairMQMemoryResource_inherit__map">
|
|
<area shape="rect" id="node3" href="classfair_1_1mq_1_1ChannelResource.html" title="fair::mq::ChannelResource" alt="" coords="26,155,205,181"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for fair::mq::FairMQMemoryResource:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classfair_1_1mq_1_1FairMQMemoryResource__coll__graph.png" border="0" usemap="#fair_1_1mq_1_1FairMQMemoryResource_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="fair_1_1mq_1_1FairMQMemoryResource_coll__map" id="fair_1_1mq_1_1FairMQMemoryResource_coll__map">
|
|
</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:ac4af63a6341db214cc350b3270543584"><td class="memItemLeft" align="right" valign="top">virtual FairMQMessagePtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1FairMQMemoryResource.html#ac4af63a6341db214cc350b3270543584">getMessage</a> (void *p)=0</td></tr>
|
|
<tr class="separator:ac4af63a6341db214cc350b3270543584"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:add4908dccdf6cee4662fb5e86b1f9267"><td class="memItemLeft" align="right" valign="top"><a id="add4908dccdf6cee4662fb5e86b1f9267"></a>
|
|
virtual void * </td><td class="memItemRight" valign="bottom"><b>setMessage</b> (FairMQMessagePtr)=0</td></tr>
|
|
<tr class="separator:add4908dccdf6cee4662fb5e86b1f9267"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8601f1db963b1866fdea336eb2cd399c"><td class="memItemLeft" align="right" valign="top"><a id="a8601f1db963b1866fdea336eb2cd399c"></a>
|
|
virtual <a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> * </td><td class="memItemRight" valign="bottom"><b>getTransportFactory</b> () noexcept=0</td></tr>
|
|
<tr class="separator:a8601f1db963b1866fdea336eb2cd399c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1aec452bb13f9183a2ebea03f730969f"><td class="memItemLeft" align="right" valign="top"><a id="a1aec452bb13f9183a2ebea03f730969f"></a>
|
|
virtual size_t </td><td class="memItemRight" valign="bottom"><b>getNumberOfMessages</b> () const noexcept=0</td></tr>
|
|
<tr class="separator:a1aec452bb13f9183a2ebea03f730969f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>All FairMQ related memory resources need to inherit from this interface class for the <a class="el" href="classfair_1_1mq_1_1FairMQMemoryResource.html#ac4af63a6341db214cc350b3270543584">getMessage()</a> api. </p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="ac4af63a6341db214cc350b3270543584"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac4af63a6341db214cc350b3270543584">◆ </a></span>getMessage()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual FairMQMessagePtr fair::mq::FairMQMemoryResource::getMessage </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>p</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>return the message containing data associated with the pointer (to start of buffer), e.g. pointer returned by std::vector::data() return nullptr if returning a message does not make sense! </p>
|
|
|
|
<p>Implemented in <a class="el" href="classfair_1_1mq_1_1ChannelResource.html#a86d96d680d0d8316665c8cd95b68a744">fair::mq::ChannelResource</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>fairmq/<a class="el" href="MemoryResources_8h_source.html">MemoryResources.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>
|