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/TransportFactory_8h_source.html
Alexey Rybalchenko eb43855b10 Add API docs for 1.3.7
2018-11-29 13:31:29 +01:00

81 lines
17 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: fairmq/ofi/TransportFactory.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
&#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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d6b28f7731906a8cbc4171450df4b180.html">fairmq</a></li><li class="navelem"><a class="el" href="dir_5bbe8f428ccaffea9370922019c81a71.html">ofi</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">TransportFactory.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/********************************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Copyright (C) 2018 GSI Helmholtzzentrum fuer Schwerionenforschung GmbH *</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * *</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<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>&#160;<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>&#160;<span class="comment"> * copied verbatim in the file &quot;LICENSE&quot; *</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> ********************************************************************************/</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="preprocessor">#ifndef FAIR_MQ_OFI_TRANSPORTFACTORY_H</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#define FAIR_MQ_OFI_TRANSPORTFACTORY_H</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#include &lt;FairMQTransportFactory.h&gt;</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#include &lt;options/FairMQProgOptions.h&gt;</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#include &lt;fairmq/ofi/Context.h&gt;</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacefair.html">fair</a></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;{</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="keyword">namespace </span>mq</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;{</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="keyword">namespace </span>ofi</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;{</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div><div class="line"><a name="l00029"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1ofi_1_1TransportFactory.html"> 29</a></span>&#160;<span class="keyword">class </span><a class="code" href="classfair_1_1mq_1_1ofi_1_1TransportFactory.html">TransportFactory</a> final : <span class="keyword">public</span> <a class="code" href="classFairMQTransportFactory.html">FairMQTransportFactory</a></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;{</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <a class="code" href="classfair_1_1mq_1_1ofi_1_1TransportFactory.html">TransportFactory</a>(<span class="keyword">const</span> std::string&amp; <span class="keywordtype">id</span> = <span class="stringliteral">&quot;&quot;</span>, <span class="keyword">const</span> <a class="code" href="classFairMQProgOptions.html">FairMQProgOptions</a>* config = <span class="keyword">nullptr</span>);</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <a class="code" href="classfair_1_1mq_1_1ofi_1_1TransportFactory.html">TransportFactory</a>(<span class="keyword">const</span> <a class="code" href="classfair_1_1mq_1_1ofi_1_1TransportFactory.html">TransportFactory</a>&amp;) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <a class="code" href="classfair_1_1mq_1_1ofi_1_1TransportFactory.html">TransportFactory</a> operator=(<span class="keyword">const</span> <a class="code" href="classfair_1_1mq_1_1ofi_1_1TransportFactory.html">TransportFactory</a>&amp;) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <span class="keyword">auto</span> CreateMessage() <span class="keyword">const</span> -&gt; MessagePtr <span class="keyword">override</span>;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <span class="keyword">auto</span> CreateMessage(<span class="keyword">const</span> std::size_t size) <span class="keyword">const</span> -&gt; MessagePtr <span class="keyword">override</span>;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; <span class="keyword">auto</span> CreateMessage(<span class="keywordtype">void</span>* data, <span class="keyword">const</span> std::size_t size, fairmq_free_fn* ffn, <span class="keywordtype">void</span>* hint = <span class="keyword">nullptr</span>) <span class="keyword">const</span> -&gt; MessagePtr <span class="keyword">override</span>;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="keyword">auto</span> CreateMessage(UnmanagedRegionPtr&amp; region, <span class="keywordtype">void</span>* data, <span class="keyword">const</span> std::size_t size, <span class="keywordtype">void</span>* hint = <span class="keyword">nullptr</span>) <span class="keyword">const</span> -&gt; MessagePtr <span class="keyword">override</span>;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1ofi_1_1TransportFactory.html#aa4db6debc0f80b20c00318ca7a898bbd">CreateSocket</a>(<span class="keyword">const</span> std::string&amp; type, <span class="keyword">const</span> std::string&amp; name) -&gt; SocketPtr <span class="keyword">override</span>;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1ofi_1_1TransportFactory.html#a816c6514f13ba600753dd707a51b62e0">CreatePoller</a>(<span class="keyword">const</span> std::vector&lt;FairMQChannel&gt;&amp; channels) <span class="keyword">const</span> -&gt; PollerPtr <span class="keyword">override</span>;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1ofi_1_1TransportFactory.html#a816c6514f13ba600753dd707a51b62e0">CreatePoller</a>(<span class="keyword">const</span> std::vector&lt;const FairMQChannel*&gt;&amp; channels) <span class="keyword">const</span> -&gt; PollerPtr <span class="keyword">override</span>;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1ofi_1_1TransportFactory.html#a816c6514f13ba600753dd707a51b62e0">CreatePoller</a>(<span class="keyword">const</span> std::unordered_map&lt;std::string, std::vector&lt;FairMQChannel&gt;&gt;&amp; channelsMap, <span class="keyword">const</span> std::vector&lt;std::string&gt;&amp; channelList) <span class="keyword">const</span> -&gt; PollerPtr <span class="keyword">override</span>;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; <span class="keyword">auto</span> CreateUnmanagedRegion(<span class="keyword">const</span> <span class="keywordtype">size_t</span> size, FairMQRegionCallback callback = <span class="keyword">nullptr</span>) <span class="keyword">const</span> -&gt; UnmanagedRegionPtr <span class="keyword">override</span>;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1ofi_1_1TransportFactory.html#ac30e0e075da46bb411e9f7d0f7b62015">GetType</a>() <span class="keyword">const</span> -&gt; Transport <span class="keyword">override</span>;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordtype">void</span> Interrupt()<span class="keyword"> override </span>{}</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordtype">void</span> Resume()<span class="keyword"> override </span>{}</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keywordtype">void</span> Reset()<span class="keyword"> override </span>{}</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keyword">mutable</span> <a class="code" href="classfair_1_1mq_1_1ofi_1_1Context.html">Context</a> fContext;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;}; <span class="comment">/* class TransportFactory */</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;} <span class="comment">/* namespace ofi */</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;} <span class="comment">/* namespace mq */</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;} <span class="comment">/* namespace fair */</span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* FAIR_MQ_OFI_TRANSPORTFACTORY_H */</span><span class="preprocessor"></span></div><div class="ttc" id="classfair_1_1mq_1_1ofi_1_1Context_html"><div class="ttname"><a href="classfair_1_1mq_1_1ofi_1_1Context.html">fair::mq::ofi::Context</a></div><div class="ttdoc">Transport-wide context. </div><div class="ttdef"><b>Definition:</b> Context.h:38</div></div>
<div class="ttc" id="classfair_1_1mq_1_1ofi_1_1TransportFactory_html_aa4db6debc0f80b20c00318ca7a898bbd"><div class="ttname"><a href="classfair_1_1mq_1_1ofi_1_1TransportFactory.html#aa4db6debc0f80b20c00318ca7a898bbd">fair::mq::ofi::TransportFactory::CreateSocket</a></div><div class="ttdeci">auto CreateSocket(const std::string &amp;type, const std::string &amp;name) -&gt; SocketPtr override</div><div class="ttdoc">Create a socket. </div><div class="ttdef"><b>Definition:</b> TransportFactory.cxx:59</div></div>
<div class="ttc" id="classFairMQTransportFactory_html"><div class="ttname"><a href="classFairMQTransportFactory.html">FairMQTransportFactory</a></div><div class="ttdef"><b>Definition:</b> FairMQTransportFactory.h:28</div></div>
<div class="ttc" id="classfair_1_1mq_1_1ofi_1_1TransportFactory_html_ac30e0e075da46bb411e9f7d0f7b62015"><div class="ttname"><a href="classfair_1_1mq_1_1ofi_1_1TransportFactory.html#ac30e0e075da46bb411e9f7d0f7b62015">fair::mq::ofi::TransportFactory::GetType</a></div><div class="ttdeci">auto GetType() const -&gt; Transport override</div><div class="ttdoc">Get transport type. </div><div class="ttdef"><b>Definition:</b> TransportFactory.cxx:84</div></div>
<div class="ttc" id="classFairMQProgOptions_html"><div class="ttname"><a href="classFairMQProgOptions.html">FairMQProgOptions</a></div><div class="ttdef"><b>Definition:</b> FairMQProgOptions.h:37</div></div>
<div class="ttc" id="classfair_1_1mq_1_1ofi_1_1TransportFactory_html"><div class="ttname"><a href="classfair_1_1mq_1_1ofi_1_1TransportFactory.html">fair::mq::ofi::TransportFactory</a></div><div class="ttdoc">FairMQ transport factory for the ofi transport (implemented with ZeroMQ + libfabric) ...</div><div class="ttdef"><b>Definition:</b> TransportFactory.h:29</div></div>
<div class="ttc" id="classfair_1_1mq_1_1ofi_1_1TransportFactory_html_a816c6514f13ba600753dd707a51b62e0"><div class="ttname"><a href="classfair_1_1mq_1_1ofi_1_1TransportFactory.html#a816c6514f13ba600753dd707a51b62e0">fair::mq::ofi::TransportFactory::CreatePoller</a></div><div class="ttdeci">auto CreatePoller(const std::vector&lt; FairMQChannel &gt; &amp;channels) const -&gt; PollerPtr override</div><div class="ttdoc">Create a poller for a single channel (all subchannels) </div></div>
<div class="ttc" id="namespacefair_html"><div class="ttname"><a href="namespacefair.html">fair</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><!-- fragment --></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