mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 00:31:14 +00:00
88 lines
16 KiB
HTML
88 lines
16 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/zeromq/FairMQTransportFactoryZMQ.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.2.1</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_8fb42aac30d996c049163942ceee61d3.html">zeromq</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">FairMQTransportFactoryZMQ.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 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="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#ifndef FAIRMQTRANSPORTFACTORYZMQ_H_</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#define FAIRMQTRANSPORTFACTORYZMQ_H_</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="preprocessor">#include <vector></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> </div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include "FairMQTransportFactory.h"</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include "FairMQMessageZMQ.h"</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "FairMQSocketZMQ.h"</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "FairMQPollerZMQ.h"</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include "FairMQUnmanagedRegionZMQ.h"</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <options/FairMQProgOptions.h></span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div><div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="classFairMQTransportFactoryZMQ.html"> 28</a></span> <span class="keyword">class </span><a class="code" href="classFairMQTransportFactoryZMQ.html">FairMQTransportFactoryZMQ</a> : <span class="keyword">public</span> <a class="code" href="classFairMQTransportFactory.html">FairMQTransportFactory</a></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> {</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <a class="code" href="classFairMQTransportFactoryZMQ.html">FairMQTransportFactoryZMQ</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="classFairMQProgOptions.html">FairMQProgOptions</a>* config = <span class="keyword">nullptr</span>);</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <a class="code" href="classFairMQTransportFactoryZMQ.html">FairMQTransportFactoryZMQ</a>(<span class="keyword">const</span> <a class="code" href="classFairMQTransportFactoryZMQ.html">FairMQTransportFactoryZMQ</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <a class="code" href="classFairMQTransportFactoryZMQ.html">FairMQTransportFactoryZMQ</a> operator=(<span class="keyword">const</span> <a class="code" href="classFairMQTransportFactoryZMQ.html">FairMQTransportFactoryZMQ</a>&) = <span class="keyword">delete</span>;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  ~<a class="code" href="classFairMQTransportFactoryZMQ.html">FairMQTransportFactoryZMQ</a>() <span class="keyword">override</span>;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  FairMQMessagePtr <a class="code" href="classFairMQTransportFactoryZMQ.html#a66132dddeada9337588c12a80286e46d">CreateMessage</a>() <span class="keyword">const override</span>;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  FairMQMessagePtr <a class="code" href="classFairMQTransportFactoryZMQ.html#a66132dddeada9337588c12a80286e46d">CreateMessage</a>(<span class="keyword">const</span> <span class="keywordtype">size_t</span> size) <span class="keyword">const override</span>;</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  FairMQMessagePtr <a class="code" href="classFairMQTransportFactoryZMQ.html#a66132dddeada9337588c12a80286e46d">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>) <span class="keyword">const override</span>;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  FairMQMessagePtr <a class="code" href="classFairMQTransportFactoryZMQ.html#a66132dddeada9337588c12a80286e46d">CreateMessage</a>(FairMQUnmanagedRegionPtr& region, <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) <span class="keyword">const override</span>;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  FairMQSocketPtr <a class="code" href="classFairMQTransportFactoryZMQ.html#a7dfc12e5899282d075fd9288b427b16c">CreateSocket</a>(<span class="keyword">const</span> std::string& type, <span class="keyword">const</span> std::string& name) <span class="keyword">const override</span>;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  FairMQPollerPtr <a class="code" href="classFairMQTransportFactoryZMQ.html#a2c0b2cfc1244374b8c61f4fe4fb7344c">CreatePoller</a>(<span class="keyword">const</span> std::vector<FairMQChannel>& channels) <span class="keyword">const override</span>;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  FairMQPollerPtr <a class="code" href="classFairMQTransportFactoryZMQ.html#a2c0b2cfc1244374b8c61f4fe4fb7344c">CreatePoller</a>(<span class="keyword">const</span> std::vector<const FairMQChannel*>& channels) <span class="keyword">const override</span>;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  FairMQPollerPtr <a class="code" href="classFairMQTransportFactoryZMQ.html#a2c0b2cfc1244374b8c61f4fe4fb7344c">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 override</span>;</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  FairMQPollerPtr <a class="code" href="classFairMQTransportFactoryZMQ.html#a2c0b2cfc1244374b8c61f4fe4fb7344c">CreatePoller</a>(<span class="keyword">const</span> <a class="code" href="classFairMQSocket.html">FairMQSocket</a>& cmdSocket, <span class="keyword">const</span> <a class="code" href="classFairMQSocket.html">FairMQSocket</a>& dataSocket) <span class="keyword">const 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>  FairMQUnmanagedRegionPtr CreateUnmanagedRegion(<span class="keyword">const</span> <span class="keywordtype">size_t</span> size, FairMQRegionCallback callback) <span class="keyword">const override</span>;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  FairMQ::Transport <a class="code" href="classFairMQTransportFactoryZMQ.html#a3c760ca59d8b427423e0c73b55699c12">GetType</a>() <span class="keyword">const override</span>;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">void</span> Interrupt()<span class="keyword"> override </span>{ FairMQSocketZMQ::Interrupt(); }</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordtype">void</span> Resume()<span class="keyword"> override </span>{ FairMQSocketZMQ::Resume(); }</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">private</span>:</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keyword">static</span> FairMQ::Transport fTransportType;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordtype">void</span>* fContext;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> };</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="preprocessor">#endif </span><span class="comment">/* FAIRMQTRANSPORTFACTORYZMQ_H_ */</span><span class="preprocessor"></span></div><div class="ttc" id="classFairMQTransportFactoryZMQ_html"><div class="ttname"><a href="classFairMQTransportFactoryZMQ.html">FairMQTransportFactoryZMQ</a></div><div class="ttdef"><b>Definition:</b> FairMQTransportFactoryZMQ.h:28</div></div>
|
|
<div class="ttc" id="classFairMQTransportFactoryZMQ_html_a66132dddeada9337588c12a80286e46d"><div class="ttname"><a href="classFairMQTransportFactoryZMQ.html#a66132dddeada9337588c12a80286e46d">FairMQTransportFactoryZMQ::CreateMessage</a></div><div class="ttdeci">FairMQMessagePtr CreateMessage() const override</div><div class="ttdoc">Create empty FairMQMessage. </div><div class="ttdef"><b>Definition:</b> FairMQTransportFactoryZMQ.cxx: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:27</div></div>
|
|
<div class="ttc" id="classFairMQTransportFactoryZMQ_html_a7dfc12e5899282d075fd9288b427b16c"><div class="ttname"><a href="classFairMQTransportFactoryZMQ.html#a7dfc12e5899282d075fd9288b427b16c">FairMQTransportFactoryZMQ::CreateSocket</a></div><div class="ttdeci">FairMQSocketPtr CreateSocket(const std::string &type, const std::string &name) const override</div><div class="ttdoc">Create a socket. </div><div class="ttdef"><b>Definition:</b> FairMQTransportFactoryZMQ.cxx:72</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:41</div></div>
|
|
<div class="ttc" id="classFairMQSocket_html"><div class="ttname"><a href="classFairMQSocket.html">FairMQSocket</a></div><div class="ttdef"><b>Definition:</b> FairMQSocket.h:18</div></div>
|
|
<div class="ttc" id="classFairMQTransportFactoryZMQ_html_a3c760ca59d8b427423e0c73b55699c12"><div class="ttname"><a href="classFairMQTransportFactoryZMQ.html#a3c760ca59d8b427423e0c73b55699c12">FairMQTransportFactoryZMQ::GetType</a></div><div class="ttdeci">FairMQ::Transport GetType() const override</div><div class="ttdoc">Get transport type. </div><div class="ttdef"><b>Definition:</b> FairMQTransportFactoryZMQ.cxx:103</div></div>
|
|
<div class="ttc" id="classFairMQTransportFactoryZMQ_html_a2c0b2cfc1244374b8c61f4fe4fb7344c"><div class="ttname"><a href="classFairMQTransportFactoryZMQ.html#a2c0b2cfc1244374b8c61f4fe4fb7344c">FairMQTransportFactoryZMQ::CreatePoller</a></div><div class="ttdeci">FairMQPollerPtr CreatePoller(const std::vector< FairMQChannel > &channels) const override</div><div class="ttdoc">Create a poller for a single channel (all subchannels) </div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</body>
|
|
</html>
|