mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 08:41:16 +00:00
232 lines
39 KiB
HTML
232 lines
39 KiB
HTML
<!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: fairmq/FairMQTransportFactory.h Source File</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.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&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&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"><a class="el" href="dir_d6b28f7731906a8cbc4171450df4b180.html">fairmq</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">FairMQTransportFactory.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/********************************************************************************</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (C) 2014-2018 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH *</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * *</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * This software is distributed under the terms of the *</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * GNU Lesser General Public Licence (LGPL) version 3, *</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * copied verbatim in the file "LICENSE" *</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> ********************************************************************************/</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>  </div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#ifndef FAIRMQTRANSPORTFACTORY_H_</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#define FAIRMQTRANSPORTFACTORY_H_</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  </div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include <FairMQMessage.h></span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <FairMQPoller.h></span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <FairMQSocket.h></span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <FairMQUnmanagedRegion.h></span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <fairmq/MemoryResources.h></span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <fairmq/Transports.h></span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  </div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <string></span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <memory></span> <span class="comment">// shared_ptr</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <vector></span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <unordered_map></span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <stdexcept></span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <cstddef></span> <span class="comment">// size_t</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">class </span><a class="code" href="classFairMQChannel.html">FairMQChannel</a>;</div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">namespace </span><a class="code" href="namespacefair_1_1mq.html">fair::mq</a> { <span class="keyword">class </span>ProgOptions; }</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="classFairMQTransportFactory.html"> 29</a></span> <span class="keyword">class </span><a class="code" href="classFairMQTransportFactory.html">FairMQTransportFactory</a></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> {</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keyword">const</span> std::string fkId;</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <a class="code" href="classfair_1_1mq_1_1ChannelResource.html">fair::mq::ChannelResource</a> fMemoryResource{<span class="keyword">this</span>};</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  </div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <a class="code" href="classFairMQTransportFactory.html#aafbb0f83fc97a50e96c7e6616bc215c9">FairMQTransportFactory</a>(<span class="keyword">const</span> std::string& <span class="keywordtype">id</span>);</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  </div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">auto</span> GetId() <span class="keyword">const</span> -> <span class="keyword">const</span> std::string { <span class="keywordflow">return</span> fkId; };</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  </div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="classFairMQTransportFactory.html#a4be5580ac0bb62cd891fc1f13f1b8a58"> 46</a></span>  <a class="code" href="classfair_1_1mq_1_1ChannelResource.html">fair::mq::ChannelResource</a>* <a class="code" href="classFairMQTransportFactory.html#a4be5580ac0bb62cd891fc1f13f1b8a58">GetMemoryResource</a>() { <span class="keywordflow">return</span> &fMemoryResource; }</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">operator</span> <a class="code" href="classfair_1_1mq_1_1ChannelResource.html">fair::mq::ChannelResource</a>*() { <span class="keywordflow">return</span> &fMemoryResource; }</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  </div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="classFairMQTransportFactory.html#abb42782c89c1b412051f4c448fbb7696"> 51</a></span>  <span class="keyword">virtual</span> FairMQMessagePtr <a class="code" href="classFairMQTransportFactory.html#abb42782c89c1b412051f4c448fbb7696">CreateMessage</a>() = 0;</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classFairMQTransportFactory.html#a9f794f9a073aaa6e0b2b623ad984a264"> 55</a></span>  <span class="keyword">virtual</span> FairMQMessagePtr <a class="code" href="classFairMQTransportFactory.html#a9f794f9a073aaa6e0b2b623ad984a264">CreateMessage</a>(<a class="code" href="structfair_1_1mq_1_1Alignment.html">fair::mq::Alignment</a> alignment) = 0;</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="classFairMQTransportFactory.html#a7cfe2327b906688096bea8854970c578"> 59</a></span>  <span class="keyword">virtual</span> FairMQMessagePtr <a class="code" href="classFairMQTransportFactory.html#a7cfe2327b906688096bea8854970c578">CreateMessage</a>(<span class="keyword">const</span> <span class="keywordtype">size_t</span> size) = 0;</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="classFairMQTransportFactory.html#ae4142711c309070b490d0e025eede5ab"> 64</a></span>  <span class="keyword">virtual</span> FairMQMessagePtr <a class="code" href="classFairMQTransportFactory.html#ae4142711c309070b490d0e025eede5ab">CreateMessage</a>(<span class="keyword">const</span> <span class="keywordtype">size_t</span> size, <a class="code" href="structfair_1_1mq_1_1Alignment.html">fair::mq::Alignment</a> alignment) = 0;</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="classFairMQTransportFactory.html#a9e3c89db0c9cd0414745d14dee0300d4"> 71</a></span>  <span class="keyword">virtual</span> FairMQMessagePtr <a class="code" href="classFairMQTransportFactory.html#a9e3c89db0c9cd0414745d14dee0300d4">CreateMessage</a>(<span class="keywordtype">void</span>* data, <span class="keyword">const</span> <span class="keywordtype">size_t</span> size, fairmq_free_fn* ffn, <span class="keywordtype">void</span>* hint = <span class="keyword">nullptr</span>) = 0;</div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="classFairMQTransportFactory.html#a8b427b161f32f83047885170457f98e6"> 77</a></span>  <span class="keyword">virtual</span> FairMQMessagePtr <a class="code" href="classFairMQTransportFactory.html#a8b427b161f32f83047885170457f98e6">CreateMessage</a>(FairMQUnmanagedRegionPtr& unmanagedRegion, <span class="keywordtype">void</span>* data, <span class="keyword">const</span> <span class="keywordtype">size_t</span> size, <span class="keywordtype">void</span>* hint = 0) = 0;</div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  </div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="classFairMQTransportFactory.html#ab38e3409319ed0d9055078a6e5bb3ef8"> 80</a></span>  <span class="keyword">virtual</span> FairMQSocketPtr <a class="code" href="classFairMQTransportFactory.html#ab38e3409319ed0d9055078a6e5bb3ef8">CreateSocket</a>(<span class="keyword">const</span> std::string& type, <span class="keyword">const</span> std::string& name) = 0;</div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  </div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"><a class="line" href="classFairMQTransportFactory.html#a6de98e1652b6ad68e4d78dd31eea40cc"> 83</a></span>  <span class="keyword">virtual</span> FairMQPollerPtr <a class="code" href="classFairMQTransportFactory.html#a6de98e1652b6ad68e4d78dd31eea40cc">CreatePoller</a>(<span class="keyword">const</span> std::vector<FairMQChannel>& channels) <span class="keyword">const</span> = 0;</div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="classFairMQTransportFactory.html#ae692f2e00d9804a5431b719e3004da59"> 85</a></span>  <span class="keyword">virtual</span> FairMQPollerPtr <a class="code" href="classFairMQTransportFactory.html#ae692f2e00d9804a5431b719e3004da59">CreatePoller</a>(<span class="keyword">const</span> std::vector<FairMQChannel*>& channels) <span class="keyword">const</span> = 0;</div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"><a class="line" href="classFairMQTransportFactory.html#a7fd308e4e5203814ca7012ef526d3fdf"> 87</a></span>  <span class="keyword">virtual</span> FairMQPollerPtr <a class="code" href="classFairMQTransportFactory.html#a7fd308e4e5203814ca7012ef526d3fdf">CreatePoller</a>(<span class="keyword">const</span> std::unordered_map<std::string, std::vector<FairMQChannel>>& channelsMap, <span class="keyword">const</span> std::vector<std::string>& channelList) <span class="keyword">const</span> = 0;</div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  </div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"><a class="line" href="classFairMQTransportFactory.html#ad1164b33d22d3b47fe3b1a45a743be5c"> 95</a></span>  <span class="keyword">virtual</span> FairMQUnmanagedRegionPtr <a class="code" href="classFairMQTransportFactory.html#ad1164b33d22d3b47fe3b1a45a743be5c">CreateUnmanagedRegion</a>(<span class="keyword">const</span> <span class="keywordtype">size_t</span> size, FairMQRegionCallback callback = <span class="keyword">nullptr</span>, <span class="keyword">const</span> std::string& path = <span class="stringliteral">""</span>, <span class="keywordtype">int</span> flags = 0) = 0;</div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keyword">virtual</span> FairMQUnmanagedRegionPtr <a class="code" href="classFairMQTransportFactory.html#ad1164b33d22d3b47fe3b1a45a743be5c">CreateUnmanagedRegion</a>(<span class="keyword">const</span> <span class="keywordtype">size_t</span> size, FairMQRegionBulkCallback callback = <span class="keyword">nullptr</span>, <span class="keyword">const</span> std::string& path = <span class="stringliteral">""</span>, <span class="keywordtype">int</span> flags = 0) = 0;</div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"><a class="line" href="classFairMQTransportFactory.html#af71fd47062ac63a595df93c459421724"> 104</a></span>  <span class="keyword">virtual</span> FairMQUnmanagedRegionPtr <a class="code" href="classFairMQTransportFactory.html#af71fd47062ac63a595df93c459421724">CreateUnmanagedRegion</a>(<span class="keyword">const</span> <span class="keywordtype">size_t</span> size, <span class="keyword">const</span> int64_t userFlags, FairMQRegionCallback callback = <span class="keyword">nullptr</span>, <span class="keyword">const</span> std::string& path = <span class="stringliteral">""</span>, <span class="keywordtype">int</span> flags = 0) = 0;</div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keyword">virtual</span> FairMQUnmanagedRegionPtr <a class="code" href="classFairMQTransportFactory.html#ad1164b33d22d3b47fe3b1a45a743be5c">CreateUnmanagedRegion</a>(<span class="keyword">const</span> <span class="keywordtype">size_t</span> size, <span class="keyword">const</span> int64_t userFlags, FairMQRegionBulkCallback callback = <span class="keyword">nullptr</span>, <span class="keyword">const</span> std::string& path = <span class="stringliteral">""</span>, <span class="keywordtype">int</span> flags = 0) = 0;</div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  </div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"><a class="line" href="classFairMQTransportFactory.html#a812d5a69199f1fe78a940c6767b89a84"> 109</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classFairMQTransportFactory.html#a812d5a69199f1fe78a940c6767b89a84">SubscribeToRegionEvents</a>(FairMQRegionEventCallback callback) = 0;</div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"><a class="line" href="classFairMQTransportFactory.html#a98280df275ac2da0d5c48c07259cd6a9"> 112</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classFairMQTransportFactory.html#a98280df275ac2da0d5c48c07259cd6a9">SubscribedToRegionEvents</a>() = 0;</div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"><a class="line" href="classFairMQTransportFactory.html#a10a586ccf137d371fded40035d16ac93"> 114</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classFairMQTransportFactory.html#a10a586ccf137d371fded40035d16ac93">UnsubscribeFromRegionEvents</a>() = 0;</div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  </div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keyword">virtual</span> std::vector<FairMQRegionInfo> GetRegionInfo() = 0;</div>
|
|
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  </div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"><a class="line" href="classFairMQTransportFactory.html#a5c62d8792229cf3eec74d75e15cc6cf4"> 119</a></span>  <span class="keyword">virtual</span> fair::mq::Transport <a class="code" href="classFairMQTransportFactory.html#a5c62d8792229cf3eec74d75e15cc6cf4">GetType</a>() <span class="keyword">const</span> = 0;</div>
|
|
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  </div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> Interrupt() = 0;</div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> Resume() = 0;</div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> Reset() = 0;</div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  </div>
|
|
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="keyword">virtual</span> ~<a class="code" href="classFairMQTransportFactory.html">FairMQTransportFactory</a>() {};</div>
|
|
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  </div>
|
|
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="keyword">static</span> <span class="keyword">auto</span> CreateTransportFactory(<span class="keyword">const</span> std::string& type, <span class="keyword">const</span> std::string& <span class="keywordtype">id</span> = <span class="stringliteral">""</span>, <span class="keyword">const</span> <a class="code" href="classfair_1_1mq_1_1ProgOptions.html">fair::mq::ProgOptions</a>* config = <span class="keyword">nullptr</span>) -> std::shared_ptr<FairMQTransportFactory>;</div>
|
|
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  </div>
|
|
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> FairMQNoCleanup(<span class="keywordtype">void</span>* <span class="comment">/*data*/</span>, <span class="keywordtype">void</span>* <span class="comment">/*obj*/</span>)</div>
|
|
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  {</div>
|
|
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  }</div>
|
|
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  </div>
|
|
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div>
|
|
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> FairMQSimpleMsgCleanup(<span class="keywordtype">void</span>* <span class="comment">/*data*/</span>, <span class="keywordtype">void</span>* obj)</div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  {</div>
|
|
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="keyword">delete</span> <span class="keyword">static_cast<</span>T*<span class="keyword">></span>(obj);</div>
|
|
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  }</div>
|
|
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  </div>
|
|
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div>
|
|
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  FairMQMessagePtr NewSimpleMessage(<span class="keyword">const</span> T& data)</div>
|
|
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  {</div>
|
|
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  <span class="comment">// todo: is_trivially_copyable not available on gcc < 5, workaround?</span></div>
|
|
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="comment">// static_assert(std::is_trivially_copyable<T>::value, "The argument type for NewSimpleMessage has to be trivially copyable!");</span></div>
|
|
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  T* dataCopy = <span class="keyword">new</span> T(data);</div>
|
|
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <span class="keywordflow">return</span> <a class="code" href="classFairMQTransportFactory.html#abb42782c89c1b412051f4c448fbb7696">CreateMessage</a>(dataCopy, <span class="keyword">sizeof</span>(T), FairMQSimpleMsgCleanup<T>, dataCopy);</div>
|
|
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  }</div>
|
|
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  </div>
|
|
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <span class="keyword">template</span><std::<span class="keywordtype">size_t</span> N></div>
|
|
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  FairMQMessagePtr NewSimpleMessage(<span class="keyword">const</span> <span class="keywordtype">char</span>(&data)[N])</div>
|
|
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  {</div>
|
|
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  std::string* msgStr = <span class="keyword">new</span> std::string(data);</div>
|
|
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  <span class="keywordflow">return</span> <a class="code" href="classFairMQTransportFactory.html#abb42782c89c1b412051f4c448fbb7696">CreateMessage</a>(<span class="keyword">const_cast<</span><span class="keywordtype">char</span>*<span class="keyword">></span>(msgStr->c_str()), msgStr->length(), FairMQSimpleMsgCleanup<std::string>, msgStr);</div>
|
|
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  }</div>
|
|
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  </div>
|
|
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  FairMQMessagePtr NewSimpleMessage(<span class="keyword">const</span> std::string& str)</div>
|
|
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  {</div>
|
|
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  </div>
|
|
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  std::string* msgStr = <span class="keyword">new</span> std::string(str);</div>
|
|
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  <span class="keywordflow">return</span> <a class="code" href="classFairMQTransportFactory.html#abb42782c89c1b412051f4c448fbb7696">CreateMessage</a>(<span class="keyword">const_cast<</span><span class="keywordtype">char</span>*<span class="keyword">></span>(msgStr->c_str()), msgStr->length(), FairMQSimpleMsgCleanup<std::string>, msgStr);</div>
|
|
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  }</div>
|
|
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  </div>
|
|
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  <span class="keyword">template</span><<span class="keyword">typename</span> T></div>
|
|
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  FairMQMessagePtr NewStaticMessage(<span class="keyword">const</span> T& data)</div>
|
|
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  {</div>
|
|
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  <span class="keywordflow">return</span> <a class="code" href="classFairMQTransportFactory.html#abb42782c89c1b412051f4c448fbb7696">CreateMessage</a>(data, <span class="keyword">sizeof</span>(T), FairMQNoCleanup, <span class="keyword">nullptr</span>);</div>
|
|
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  }</div>
|
|
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  </div>
|
|
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  FairMQMessagePtr NewStaticMessage(<span class="keyword">const</span> std::string& str)</div>
|
|
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  {</div>
|
|
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  <span class="keywordflow">return</span> <a class="code" href="classFairMQTransportFactory.html#abb42782c89c1b412051f4c448fbb7696">CreateMessage</a>(<span class="keyword">const_cast<</span><span class="keywordtype">char</span>*<span class="keyword">></span>(str.c_str()), str.length(), FairMQNoCleanup, <span class="keyword">nullptr</span>);</div>
|
|
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  }</div>
|
|
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> };</div>
|
|
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  </div>
|
|
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="keyword">namespace </span><a class="code" href="namespacefair_1_1mq.html">fair::mq</a></div>
|
|
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span> {</div>
|
|
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  </div>
|
|
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="keyword">using</span> TransportFactory = <a class="code" href="classFairMQTransportFactory.html">FairMQTransportFactory</a>;</div>
|
|
<div class="line"><a name="l00178"></a><span class="lineno"><a class="line" href="structfair_1_1mq_1_1TransportFactoryError.html"> 178</a></span> <span class="keyword">struct </span><a class="code" href="structfair_1_1mq_1_1TransportFactoryError.html">TransportFactoryError</a> : std::runtime_error { <span class="keyword">using</span> std::runtime_error::runtime_error; };</div>
|
|
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  </div>
|
|
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span> } <span class="comment">// namespace fair::mq</span></div>
|
|
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  </div>
|
|
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="preprocessor">#endif </span><span class="comment">/* FAIRMQTRANSPORTFACTORY_H_ */</span><span class="preprocessor"></span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="astructfair_1_1mq_1_1Alignment_html"><div class="ttname"><a href="structfair_1_1mq_1_1Alignment.html">fair::mq::Alignment</a></div><div class="ttdef"><b>Definition:</b> FairMQMessage.h:25</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1ProgOptions_html"><div class="ttname"><a href="classfair_1_1mq_1_1ProgOptions.html">fair::mq::ProgOptions</a></div><div class="ttdef"><b>Definition:</b> ProgOptions.h:41</div></div>
|
|
<div class="ttc" id="aclassFairMQTransportFactory_html_a10a586ccf137d371fded40035d16ac93"><div class="ttname"><a href="classFairMQTransportFactory.html#a10a586ccf137d371fded40035d16ac93">FairMQTransportFactory::UnsubscribeFromRegionEvents</a></div><div class="ttdeci">virtual void UnsubscribeFromRegionEvents()=0</div><div class="ttdoc">Unsubscribe from region events.</div></div>
|
|
<div class="ttc" id="aclassFairMQTransportFactory_html_a9f794f9a073aaa6e0b2b623ad984a264"><div class="ttname"><a href="classFairMQTransportFactory.html#a9f794f9a073aaa6e0b2b623ad984a264">FairMQTransportFactory::CreateMessage</a></div><div class="ttdeci">virtual FairMQMessagePtr CreateMessage(fair::mq::Alignment alignment)=0</div><div class="ttdoc">Create empty FairMQMessage (for receiving), align received buffer to specified alignment.</div></div>
|
|
<div class="ttc" id="aclassFairMQTransportFactory_html_a7fd308e4e5203814ca7012ef526d3fdf"><div class="ttname"><a href="classFairMQTransportFactory.html#a7fd308e4e5203814ca7012ef526d3fdf">FairMQTransportFactory::CreatePoller</a></div><div class="ttdeci">virtual FairMQPollerPtr CreatePoller(const std::unordered_map< std::string, std::vector< FairMQChannel >> &channelsMap, const std::vector< std::string > &channelList) const =0</div><div class="ttdoc">Create a poller for specific channels (all subchannels)</div></div>
|
|
<div class="ttc" id="anamespacefair_1_1mq_html"><div class="ttname"><a href="namespacefair_1_1mq.html">fair::mq</a></div><div class="ttdoc">Tools for interfacing containers to the transport via polymorphic allocators.</div><div class="ttdef"><b>Definition:</b> DeviceRunner.h:23</div></div>
|
|
<div class="ttc" id="aclassFairMQTransportFactory_html_a7cfe2327b906688096bea8854970c578"><div class="ttname"><a href="classFairMQTransportFactory.html#a7cfe2327b906688096bea8854970c578">FairMQTransportFactory::CreateMessage</a></div><div class="ttdeci">virtual FairMQMessagePtr CreateMessage(const size_t size)=0</div><div class="ttdoc">Create new FairMQMessage of specified size.</div></div>
|
|
<div class="ttc" id="aclassFairMQTransportFactory_html_ae4142711c309070b490d0e025eede5ab"><div class="ttname"><a href="classFairMQTransportFactory.html#ae4142711c309070b490d0e025eede5ab">FairMQTransportFactory::CreateMessage</a></div><div class="ttdeci">virtual FairMQMessagePtr CreateMessage(const size_t size, fair::mq::Alignment alignment)=0</div><div class="ttdoc">Create new FairMQMessage of specified size and alignment.</div></div>
|
|
<div class="ttc" id="aclassFairMQTransportFactory_html_a9e3c89db0c9cd0414745d14dee0300d4"><div class="ttname"><a href="classFairMQTransportFactory.html#a9e3c89db0c9cd0414745d14dee0300d4">FairMQTransportFactory::CreateMessage</a></div><div class="ttdeci">virtual FairMQMessagePtr CreateMessage(void *data, const size_t size, fairmq_free_fn *ffn, void *hint=nullptr)=0</div><div class="ttdoc">Create new FairMQMessage with user provided buffer and size.</div></div>
|
|
<div class="ttc" id="aclassFairMQTransportFactory_html_aafbb0f83fc97a50e96c7e6616bc215c9"><div class="ttname"><a href="classFairMQTransportFactory.html#aafbb0f83fc97a50e96c7e6616bc215c9">FairMQTransportFactory::FairMQTransportFactory</a></div><div class="ttdeci">FairMQTransportFactory(const std::string &id)</div><div class="ttdef"><b>Definition:</b> FairMQTransportFactory.cxx:26</div></div>
|
|
<div class="ttc" id="aclassFairMQTransportFactory_html_a8b427b161f32f83047885170457f98e6"><div class="ttname"><a href="classFairMQTransportFactory.html#a8b427b161f32f83047885170457f98e6">FairMQTransportFactory::CreateMessage</a></div><div class="ttdeci">virtual FairMQMessagePtr CreateMessage(FairMQUnmanagedRegionPtr &unmanagedRegion, void *data, const size_t size, void *hint=0)=0</div><div class="ttdoc">create a message with the buffer located within the corresponding unmanaged region</div></div>
|
|
<div class="ttc" id="aclassFairMQTransportFactory_html_a4be5580ac0bb62cd891fc1f13f1b8a58"><div class="ttname"><a href="classFairMQTransportFactory.html#a4be5580ac0bb62cd891fc1f13f1b8a58">FairMQTransportFactory::GetMemoryResource</a></div><div class="ttdeci">fair::mq::ChannelResource * GetMemoryResource()</div><div class="ttdoc">Get a pointer to the associated polymorphic memory resource.</div><div class="ttdef"><b>Definition:</b> FairMQTransportFactory.h:46</div></div>
|
|
<div class="ttc" id="aclassFairMQTransportFactory_html_ab38e3409319ed0d9055078a6e5bb3ef8"><div class="ttname"><a href="classFairMQTransportFactory.html#ab38e3409319ed0d9055078a6e5bb3ef8">FairMQTransportFactory::CreateSocket</a></div><div class="ttdeci">virtual FairMQSocketPtr CreateSocket(const std::string &type, const std::string &name)=0</div><div class="ttdoc">Create a socket.</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1ChannelResource_html"><div class="ttname"><a href="classfair_1_1mq_1_1ChannelResource.html">fair::mq::ChannelResource</a></div><div class="ttdef"><b>Definition:</b> MemoryResources.h:58</div></div>
|
|
<div class="ttc" id="aclassFairMQTransportFactory_html_a5c62d8792229cf3eec74d75e15cc6cf4"><div class="ttname"><a href="classFairMQTransportFactory.html#a5c62d8792229cf3eec74d75e15cc6cf4">FairMQTransportFactory::GetType</a></div><div class="ttdeci">virtual fair::mq::Transport GetType() const =0</div><div class="ttdoc">Get transport type.</div></div>
|
|
<div class="ttc" id="aclassFairMQTransportFactory_html_af71fd47062ac63a595df93c459421724"><div class="ttname"><a href="classFairMQTransportFactory.html#af71fd47062ac63a595df93c459421724">FairMQTransportFactory::CreateUnmanagedRegion</a></div><div class="ttdeci">virtual FairMQUnmanagedRegionPtr CreateUnmanagedRegion(const size_t size, const int64_t userFlags, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0)=0</div><div class="ttdoc">Create new UnmanagedRegion.</div></div>
|
|
<div class="ttc" id="aclassFairMQTransportFactory_html_ae692f2e00d9804a5431b719e3004da59"><div class="ttname"><a href="classFairMQTransportFactory.html#ae692f2e00d9804a5431b719e3004da59">FairMQTransportFactory::CreatePoller</a></div><div class="ttdeci">virtual FairMQPollerPtr CreatePoller(const std::vector< FairMQChannel * > &channels) const =0</div><div class="ttdoc">Create a poller for specific channels.</div></div>
|
|
<div class="ttc" id="aclassFairMQTransportFactory_html_a6de98e1652b6ad68e4d78dd31eea40cc"><div class="ttname"><a href="classFairMQTransportFactory.html#a6de98e1652b6ad68e4d78dd31eea40cc">FairMQTransportFactory::CreatePoller</a></div><div class="ttdeci">virtual FairMQPollerPtr CreatePoller(const std::vector< FairMQChannel > &channels) const =0</div><div class="ttdoc">Create a poller for a single channel (all subchannels)</div></div>
|
|
<div class="ttc" id="aclassFairMQTransportFactory_html_ad1164b33d22d3b47fe3b1a45a743be5c"><div class="ttname"><a href="classFairMQTransportFactory.html#ad1164b33d22d3b47fe3b1a45a743be5c">FairMQTransportFactory::CreateUnmanagedRegion</a></div><div class="ttdeci">virtual FairMQUnmanagedRegionPtr CreateUnmanagedRegion(const size_t size, FairMQRegionCallback callback=nullptr, const std::string &path="", int flags=0)=0</div><div class="ttdoc">Create new UnmanagedRegion.</div></div>
|
|
<div class="ttc" id="aclassFairMQChannel_html"><div class="ttname"><a href="classFairMQChannel.html">FairMQChannel</a></div><div class="ttdoc">Wrapper class for FairMQSocket and related methods.</div><div class="ttdef"><b>Definition:</b> FairMQChannel.h:35</div></div>
|
|
<div class="ttc" id="aclassFairMQTransportFactory_html_abb42782c89c1b412051f4c448fbb7696"><div class="ttname"><a href="classFairMQTransportFactory.html#abb42782c89c1b412051f4c448fbb7696">FairMQTransportFactory::CreateMessage</a></div><div class="ttdeci">virtual FairMQMessagePtr CreateMessage()=0</div><div class="ttdoc">Create empty FairMQMessage (for receiving)</div></div>
|
|
<div class="ttc" id="aclassFairMQTransportFactory_html_a812d5a69199f1fe78a940c6767b89a84"><div class="ttname"><a href="classFairMQTransportFactory.html#a812d5a69199f1fe78a940c6767b89a84">FairMQTransportFactory::SubscribeToRegionEvents</a></div><div class="ttdeci">virtual void SubscribeToRegionEvents(FairMQRegionEventCallback callback)=0</div><div class="ttdoc">Subscribe to region events (creation, destruction, ...)</div></div>
|
|
<div class="ttc" id="astructfair_1_1mq_1_1TransportFactoryError_html"><div class="ttname"><a href="structfair_1_1mq_1_1TransportFactoryError.html">fair::mq::TransportFactoryError</a></div><div class="ttdef"><b>Definition:</b> FairMQTransportFactory.h:178</div></div>
|
|
<div class="ttc" id="aclassFairMQTransportFactory_html"><div class="ttname"><a href="classFairMQTransportFactory.html">FairMQTransportFactory</a></div><div class="ttdef"><b>Definition:</b> FairMQTransportFactory.h:30</div></div>
|
|
<div class="ttc" id="aclassFairMQTransportFactory_html_a98280df275ac2da0d5c48c07259cd6a9"><div class="ttname"><a href="classFairMQTransportFactory.html#a98280df275ac2da0d5c48c07259cd6a9">FairMQTransportFactory::SubscribedToRegionEvents</a></div><div class="ttdeci">virtual bool SubscribedToRegionEvents()=0</div><div class="ttdoc">Check if there is an active subscription to region events.</div></div>
|
|
<p style="margin: 0 12px 10px 12px;"><a href="https://help.github.com/articles/github-privacy-statement/">privacy</a></p>
|