mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 08:41:16 +00:00
85 lines
22 KiB
HTML
85 lines
22 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: 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
|
|
 <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="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> <span class="comment">/********************************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <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> <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 FAIR_MQ_OFI_TRANSPORTFACTORY_H</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#define FAIR_MQ_OFI_TRANSPORTFACTORY_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 <FairMQTransportFactory.h></span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <fairmq/ProgOptions.h></span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <fairmq/ofi/Context.h></span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <asiofi.hpp></span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">namespace </span><a class="code" href="namespacefair.html">fair</a></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> {</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">namespace </span>mq</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> {</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">namespace </span>ofi</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> {</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div><div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1ofi_1_1TransportFactory.html"> 31</a></span> <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="l00032"></a><span class="lineno"> 32</span> {</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <a class="code" href="classfair_1_1mq_1_1ofi_1_1TransportFactory.html">TransportFactory</a>(<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>);</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <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>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <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>&) = <span class="keyword">delete</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">auto</span> <a class="code" href="classfair_1_1mq_1_1ofi_1_1TransportFactory.html#a44e235e05b1d7631de000efb4a7087e0">CreateMessage</a>() -> MessagePtr <span class="keyword">override</span>;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1ofi_1_1TransportFactory.html#a44e235e05b1d7631de000efb4a7087e0">CreateMessage</a>(<span class="keyword">const</span> std::size_t size) -> MessagePtr <span class="keyword">override</span>;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1ofi_1_1TransportFactory.html#a44e235e05b1d7631de000efb4a7087e0">CreateMessage</a>(<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>) -> MessagePtr <span class="keyword">override</span>;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1ofi_1_1TransportFactory.html#a44e235e05b1d7631de000efb4a7087e0">CreateMessage</a>(UnmanagedRegionPtr& 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>) -> MessagePtr <span class="keyword">override</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> <a class="code" href="classfair_1_1mq_1_1ofi_1_1TransportFactory.html#aa4db6debc0f80b20c00318ca7a898bbd">CreateSocket</a>(<span class="keyword">const</span> std::string& type, <span class="keyword">const</span> std::string& name) -> SocketPtr <span class="keyword">override</span>;</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <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<FairMQChannel>& channels) <span class="keyword">const</span> -> PollerPtr <span class="keyword">override</span>;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <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<FairMQChannel*>& channels) <span class="keyword">const</span> -> PollerPtr <span class="keyword">override</span>;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <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<std::string, std::vector<FairMQChannel>>& channelsMap, <span class="keyword">const</span> std::vector<std::string>& channelList) <span class="keyword">const</span> -> PollerPtr <span class="keyword">override</span>;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1ofi_1_1TransportFactory.html#acc4ccf3512db553e99ce4b6b5ad0430f">CreateUnmanagedRegion</a>(<span class="keyword">const</span> <span class="keywordtype">size_t</span> size, RegionCallback 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) <span class="keyword">const</span> -> UnmanagedRegionPtr <span class="keyword">override</span>;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1ofi_1_1TransportFactory.html#acc4ccf3512db553e99ce4b6b5ad0430f">CreateUnmanagedRegion</a>(<span class="keyword">const</span> <span class="keywordtype">size_t</span> size, int64_t userFlags, RegionCallback 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) <span class="keyword">const</span> -> UnmanagedRegionPtr <span class="keyword">override</span>;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1ofi_1_1TransportFactory.html#ab8b470d8716cb847499102b76fef5c86"> 52</a></span>  <span class="keywordtype">void</span> <a class="code" href="classfair_1_1mq_1_1ofi_1_1TransportFactory.html#ab8b470d8716cb847499102b76fef5c86">SubscribeToRegionEvents</a>(RegionEventCallback <span class="comment">/* callback */</span>)<span class="keyword"> override </span>{ LOG(error) << <span class="stringliteral">"SubscribeToRegionEvents not yet implemented for OFI"</span>; }</div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1ofi_1_1TransportFactory.html#a44ef02f35b0a381e61a6492fcd3c9925"> 53</a></span>  <span class="keywordtype">void</span> <a class="code" href="classfair_1_1mq_1_1ofi_1_1TransportFactory.html#a44ef02f35b0a381e61a6492fcd3c9925">UnsubscribeFromRegionEvents</a>()<span class="keyword"> override </span>{ LOG(error) << <span class="stringliteral">"UnsubscribeFromRegionEvents not yet implemented for OFI"</span>; }</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  std::vector<FairMQRegionInfo> GetRegionInfo()<span class="keyword"> override </span>{ LOG(error) << <span class="stringliteral">"GetRegionInfo not yet implemented for OFI, returning empty vector"</span>; <span class="keywordflow">return</span> std::vector<FairMQRegionInfo>(); }</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> </div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <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> -> Transport <span class="keyword">override</span>;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordtype">void</span> Interrupt()<span class="keyword"> override </span>{ fContext.Interrupt(); }</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordtype">void</span> Resume()<span class="keyword"> override </span>{ fContext.Resume(); }</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordtype">void</span> Reset()<span class="keyword"> override </span>{ fContext.Reset(); }</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <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="l00064"></a><span class="lineno"> 64</span>  asiofi::allocated_pool_resource fMemoryResource;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> }; <span class="comment">/* class TransportFactory */</span> </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> } <span class="comment">/* namespace ofi */</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> } <span class="comment">/* namespace mq */</span></div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> } <span class="comment">/* namespace fair */</span></div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <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:56</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 &type, const std::string &name) -> SocketPtr override</div><div class="ttdoc">Create a socket. </div></div>
|
|
<div class="ttc" id="classfair_1_1mq_1_1ofi_1_1TransportFactory_html_a44e235e05b1d7631de000efb4a7087e0"><div class="ttname"><a href="classfair_1_1mq_1_1ofi_1_1TransportFactory.html#a44e235e05b1d7631de000efb4a7087e0">fair::mq::ofi::TransportFactory::CreateMessage</a></div><div class="ttdeci">auto CreateMessage() -> MessagePtr override</div><div class="ttdoc">Create empty FairMQMessage. </div><div class="ttdef"><b>Definition:</b> TransportFactory.cxx:39</div></div>
|
|
<div class="ttc" id="classfair_1_1mq_1_1ofi_1_1TransportFactory_html_ab8b470d8716cb847499102b76fef5c86"><div class="ttname"><a href="classfair_1_1mq_1_1ofi_1_1TransportFactory.html#ab8b470d8716cb847499102b76fef5c86">fair::mq::ofi::TransportFactory::SubscribeToRegionEvents</a></div><div class="ttdeci">void SubscribeToRegionEvents(RegionEventCallback) override</div><div class="ttdoc">Subscribe to region events (creation, destruction, ...) </div><div class="ttdef"><b>Definition:</b> TransportFactory.h:52</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:30</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 -> Transport override</div><div class="ttdoc">Get transport type. </div><div class="ttdef"><b>Definition:</b> TransportFactory.cxx:98</div></div>
|
|
<div class="ttc" id="classfair_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:36</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. </div><div class="ttdef"><b>Definition:</b> TransportFactory.h:31</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< FairMQChannel > &channels) const -> PollerPtr override</div><div class="ttdoc">Create a poller for a single channel (all subchannels) </div></div>
|
|
<div class="ttc" id="classfair_1_1mq_1_1ofi_1_1TransportFactory_html_a44ef02f35b0a381e61a6492fcd3c9925"><div class="ttname"><a href="classfair_1_1mq_1_1ofi_1_1TransportFactory.html#a44ef02f35b0a381e61a6492fcd3c9925">fair::mq::ofi::TransportFactory::UnsubscribeFromRegionEvents</a></div><div class="ttdeci">void UnsubscribeFromRegionEvents() override</div><div class="ttdoc">Unsubscribe from region events. </div><div class="ttdef"><b>Definition:</b> TransportFactory.h:53</div></div>
|
|
<div class="ttc" id="classfair_1_1mq_1_1ofi_1_1TransportFactory_html_acc4ccf3512db553e99ce4b6b5ad0430f"><div class="ttname"><a href="classfair_1_1mq_1_1ofi_1_1TransportFactory.html#acc4ccf3512db553e99ce4b6b5ad0430f">fair::mq::ofi::TransportFactory::CreateUnmanagedRegion</a></div><div class="ttdeci">auto CreateUnmanagedRegion(const size_t size, RegionCallback callback=nullptr, const std::string &path="", int flags=0) const -> UnmanagedRegionPtr override</div><div class="ttdoc">Create new UnmanagedRegion. </div><div class="ttdef"><b>Definition:</b> TransportFactory.cxx:88</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>
|