mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 16:46:47 +00:00
211 lines
13 KiB
HTML
211 lines
13 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::ChannelResource 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.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"><a class="el" href="classfair_1_1mq_1_1ChannelResource.html">ChannelResource</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pro-methods">Protected Member Functions</a> |
|
|
<a href="#pro-attribs">Protected Attributes</a> |
|
|
<a href="classfair_1_1mq_1_1ChannelResource-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">fair::mq::ChannelResource Class Reference</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::ChannelResource:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classfair_1_1mq_1_1ChannelResource__inherit__graph.png" border="0" usemap="#fair_1_1mq_1_1ChannelResource_inherit__map" alt="Inheritance graph"/></div>
|
|
<map name="fair_1_1mq_1_1ChannelResource_inherit__map" id="fair_1_1mq_1_1ChannelResource_inherit__map">
|
|
<area shape="rect" id="node2" href="classfair_1_1mq_1_1FairMQMemoryResource.html" title="fair::mq::FairMQMemoryResource" alt="" coords="5,80,225,107"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<div class="dynheader">
|
|
Collaboration diagram for fair::mq::ChannelResource:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classfair_1_1mq_1_1ChannelResource__coll__graph.png" border="0" usemap="#fair_1_1mq_1_1ChannelResource_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="fair_1_1mq_1_1ChannelResource_coll__map" id="fair_1_1mq_1_1ChannelResource_coll__map">
|
|
<area shape="rect" id="node2" href="classfair_1_1mq_1_1FairMQMemoryResource.html" title="fair::mq::FairMQMemoryResource" alt="" coords="5,81,225,108"/>
|
|
<area shape="rect" id="node4" href="classFairMQTransportFactory.html" title="FairMQTransportFactory" alt="" coords="249,81,413,108"/>
|
|
</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:ac242f51a36e682cf6ece54b3e8f9c8ed"><td class="memItemLeft" align="right" valign="top"><a id="ac242f51a36e682cf6ece54b3e8f9c8ed"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>ChannelResource</b> (<a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> *_factory)</td></tr>
|
|
<tr class="separator:ac242f51a36e682cf6ece54b3e8f9c8ed"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a86d96d680d0d8316665c8cd95b68a744"><td class="memItemLeft" align="right" valign="top">FairMQMessagePtr </td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1ChannelResource.html#a86d96d680d0d8316665c8cd95b68a744">getMessage</a> (void *p) override</td></tr>
|
|
<tr class="separator:a86d96d680d0d8316665c8cd95b68a744"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac02c493e8d43d70beced93adc7a8fde8"><td class="memItemLeft" align="right" valign="top"><a id="ac02c493e8d43d70beced93adc7a8fde8"></a>
|
|
void * </td><td class="memItemRight" valign="bottom"><b>setMessage</b> (FairMQMessagePtr message) override</td></tr>
|
|
<tr class="separator:ac02c493e8d43d70beced93adc7a8fde8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1e13ba20809198fa3490fd83724b878f"><td class="memItemLeft" align="right" valign="top"><a id="a1e13ba20809198fa3490fd83724b878f"></a>
|
|
<a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> * </td><td class="memItemRight" valign="bottom"><b>getTransportFactory</b> () noexcept override</td></tr>
|
|
<tr class="separator:a1e13ba20809198fa3490fd83724b878f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8959986ba22c616578a3c6c5be6e257e"><td class="memItemLeft" align="right" valign="top"><a id="a8959986ba22c616578a3c6c5be6e257e"></a>
|
|
size_t </td><td class="memItemRight" valign="bottom"><b>getNumberOfMessages</b> () const noexcept override</td></tr>
|
|
<tr class="separator:a8959986ba22c616578a3c6c5be6e257e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
|
|
Protected Member Functions</h2></td></tr>
|
|
<tr class="memitem:acf72b1b6279db959ae3b3acef4b7dc48"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1ChannelResource.html#acf72b1b6279db959ae3b3acef4b7dc48">do_allocate</a> (std::size_t bytes, std::size_t alignment) override</td></tr>
|
|
<tr class="memdesc:acf72b1b6279db959ae3b3acef4b7dc48"><td class="mdescLeft"> </td><td class="mdescRight">Memory allocators and interfaces related to managing memory via the trasport layer. <a href="#acf72b1b6279db959ae3b3acef4b7dc48">More...</a><br /></td></tr>
|
|
<tr class="separator:acf72b1b6279db959ae3b3acef4b7dc48"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac47673ffd605612dc00596d1f4953f1c"><td class="memItemLeft" align="right" valign="top"><a id="ac47673ffd605612dc00596d1f4953f1c"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>do_deallocate</b> (void *p, std::size_t, std::size_t) override</td></tr>
|
|
<tr class="separator:ac47673ffd605612dc00596d1f4953f1c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5cc6cabab5d7abdbaccf639aa978d375"><td class="memItemLeft" align="right" valign="top"><a id="a5cc6cabab5d7abdbaccf639aa978d375"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>do_is_equal</b> (const pmr::memory_resource &other) const noexcept override</td></tr>
|
|
<tr class="separator:a5cc6cabab5d7abdbaccf639aa978d375"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
|
|
Protected Attributes</h2></td></tr>
|
|
<tr class="memitem:a25f3eac947187192d57d37c5bc573283"><td class="memItemLeft" align="right" valign="top"><a id="a25f3eac947187192d57d37c5bc573283"></a>
|
|
<a class="el" href="classFairMQTransportFactory.html">FairMQTransportFactory</a> * </td><td class="memItemRight" valign="bottom"><b>factory</b> {nullptr}</td></tr>
|
|
<tr class="separator:a25f3eac947187192d57d37c5bc573283"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2a11d45b3839ca4da0be782b1f86c602"><td class="memItemLeft" align="right" valign="top"><a id="a2a11d45b3839ca4da0be782b1f86c602"></a>
|
|
boost::container::flat_map< void *, FairMQMessagePtr > </td><td class="memItemRight" valign="bottom"><b>messageMap</b></td></tr>
|
|
<tr class="separator:a2a11d45b3839ca4da0be782b1f86c602"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>This is the allocator that interfaces to FairMQ memory management. All allocations are delegated to FairMQ so standard (e.g. STL) containers can construct their stuff in memory regions appropriate for the data channel configuration. </p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="acf72b1b6279db959ae3b3acef4b7dc48"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acf72b1b6279db959ae3b3acef4b7dc48">◆ </a></span>do_allocate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void * fair::mq::ChannelResource::do_allocate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">std::size_t </td>
|
|
<td class="paramname"><em>bytes</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">std::size_t </td>
|
|
<td class="paramname"><em>alignment</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">override</span><span class="mlabel">protected</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Memory allocators and interfaces related to managing memory via the trasport layer. </p>
|
|
<dl class="section author"><dt>Author</dt><dd>Mikolaj Krzewicki, <a href="#" onclick="location.href='mai'+'lto:'+'mkr'+'ze'+'wic'+'@c'+'ern'+'.c'+'h'; return false;">mkrze<span style="display: none;">.nosp@m.</span>wic@<span style="display: none;">.nosp@m.</span>cern.<span style="display: none;">.nosp@m.</span>ch</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a86d96d680d0d8316665c8cd95b68a744"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a86d96d680d0d8316665c8cd95b68a744">◆ </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">FairMQMessagePtr fair::mq::ChannelResource::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">inline</span><span class="mlabel">override</span><span class="mlabel">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>Implements <a class="el" href="classfair_1_1mq_1_1FairMQMemoryResource.html#ac4af63a6341db214cc350b3270543584">fair::mq::FairMQMemoryResource</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>fairmq/<a class="el" href="MemoryResources_8h_source.html">MemoryResources.h</a></li>
|
|
<li>fairmq/MemoryResources.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>
|