Mirror/FairMQ
1
0
Fork 0
mirror of https://github.com/FairRootGroup/FairMQ.git synced 2025-10-13 00:31:14 +00:00
Code Issues Packages Projects Releases Wiki Activity
03aba17be8
FairMQ/v1.2.0/classfair_1_1mq_1_1ofi_1_1Context.html
Dennis Klein 03aba17be8
Add API docs for 1.2.0
2018-05-03 19:53:50 +02:00

157 lines
11 KiB
HTML
Raw 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: fair::mq::ofi::Context Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">FairMQ
&#160;<span id="projectnumber">1.2.0</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="namespacefair.html">fair</a></li><li class="navelem"><b>mq</b></li><li class="navelem"><b>ofi</b></li><li class="navelem"><a class="el" href="classfair_1_1mq_1_1ofi_1_1Context.html">Context</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classfair_1_1mq_1_1ofi_1_1Context-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">fair::mq::ofi::Context Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Transport-wide context.
<a href="classfair_1_1mq_1_1ofi_1_1Context.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="Context_8h_source.html">fairmq/ofi/Context.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfair_1_1mq_1_1ofi_1_1Context_1_1Address.html">Address</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a98dc4c87c3a72834996a1763678b212f"><td class="memItemLeft" align="right" valign="top"><a id="a98dc4c87c3a72834996a1763678b212f"></a>
&#160;</td><td class="memItemRight" valign="bottom"><b>Context</b> (int numberIoThreads=2)</td></tr>
<tr class="separator:a98dc4c87c3a72834996a1763678b212f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6daae532e8f45233466394ea6453cab5"><td class="memItemLeft" align="right" valign="top"><a id="a6daae532e8f45233466394ea6453cab5"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>CreateOfiEndpoint</b> () -&gt; fid_ep *</td></tr>
<tr class="separator:a6daae532e8f45233466394ea6453cab5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6012cd359415fe320820a305a5fcdf6f"><td class="memItemLeft" align="right" valign="top"><a id="a6012cd359415fe320820a305a5fcdf6f"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>CreateOfiCompletionQueue</b> (Direction dir) -&gt; fid_cq *</td></tr>
<tr class="separator:a6012cd359415fe320820a305a5fcdf6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7049d176c66929cb11c65ac79253da7c"><td class="memItemLeft" align="right" valign="top"><a id="a7049d176c66929cb11c65ac79253da7c"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>GetZmqVersion</b> () const -&gt; std::string</td></tr>
<tr class="separator:a7049d176c66929cb11c65ac79253da7c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2de1a4d75877c4bf70ea9134134189f9"><td class="memItemLeft" align="right" valign="top"><a id="a2de1a4d75877c4bf70ea9134134189f9"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>GetOfiApiVersion</b> () const -&gt; std::string</td></tr>
<tr class="separator:a2de1a4d75877c4bf70ea9134134189f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f2156e8647ca095cec84d9e18a6380f"><td class="memItemLeft" align="right" valign="top"><a id="a8f2156e8647ca095cec84d9e18a6380f"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>GetPbVersion</b> () const -&gt; std::string</td></tr>
<tr class="separator:a8f2156e8647ca095cec84d9e18a6380f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf3e3482f4f3957d5fc2af978861f785"><td class="memItemLeft" align="right" valign="top"><a id="aaf3e3482f4f3957d5fc2af978861f785"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>GetBoostVersion</b> () const -&gt; std::string</td></tr>
<tr class="separator:aaf3e3482f4f3957d5fc2af978861f785"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab88619640c7d0e51491d01776a3cc9a9"><td class="memItemLeft" align="right" valign="top"><a id="ab88619640c7d0e51491d01776a3cc9a9"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>GetZmqContext</b> () const -&gt; void *</td></tr>
<tr class="separator:ab88619640c7d0e51491d01776a3cc9a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a45291aefff993bc43eaab0098846b935"><td class="memItemLeft" align="right" valign="top"><a id="a45291aefff993bc43eaab0098846b935"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>GetIoContext</b> () -&gt; boost::asio::io_service &amp;</td></tr>
<tr class="separator:a45291aefff993bc43eaab0098846b935"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a734222d465b2908ed11e670660b5510b"><td class="memItemLeft" align="right" valign="top"><a id="a734222d465b2908ed11e670660b5510b"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>InsertAddressVector</b> (sockaddr_in address) -&gt; fi_addr_t</td></tr>
<tr class="separator:a734222d465b2908ed11e670660b5510b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a72f06e65b52f5f9c98d462e93feb1a97"><td class="memItemLeft" align="right" valign="top"><a id="a72f06e65b52f5f9c98d462e93feb1a97"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>AddressVectorLookup</b> (fi_addr_t address) -&gt; sockaddr_in</td></tr>
<tr class="separator:a72f06e65b52f5f9c98d462e93feb1a97"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adbd203259bc269cb13f35111d09d93a6"><td class="memItemLeft" align="right" valign="top"><a id="adbd203259bc269cb13f35111d09d93a6"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>InitOfi</b> (ConnectionType type, <a class="el" href="structfair_1_1mq_1_1ofi_1_1Context_1_1Address.html">Address</a> address) -&gt; void</td></tr>
<tr class="separator:adbd203259bc269cb13f35111d09d93a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ad4f82f1bcc8d342d60228af1d17d896d"><td class="memItemLeft" align="right" valign="top"><a id="ad4f82f1bcc8d342d60228af1d17d896d"></a>
static auto&#160;</td><td class="memItemRight" valign="bottom"><b>ConvertAddress</b> (std::string address) -&gt; <a class="el" href="structfair_1_1mq_1_1ofi_1_1Context_1_1Address.html">Address</a></td></tr>
<tr class="separator:ad4f82f1bcc8d342d60228af1d17d896d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6a0f5a04ddef003ab999533a94d50c84"><td class="memItemLeft" align="right" valign="top"><a id="a6a0f5a04ddef003ab999533a94d50c84"></a>
static auto&#160;</td><td class="memItemRight" valign="bottom"><b>ConvertAddress</b> (<a class="el" href="structfair_1_1mq_1_1ofi_1_1Context_1_1Address.html">Address</a> address) -&gt; sockaddr_in</td></tr>
<tr class="separator:a6a0f5a04ddef003ab999533a94d50c84"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0bb0dcb06e94c7d587040c81a165cd6"><td class="memItemLeft" align="right" valign="top"><a id="ae0bb0dcb06e94c7d587040c81a165cd6"></a>
static auto&#160;</td><td class="memItemRight" valign="bottom"><b>ConvertAddress</b> (sockaddr_in address) -&gt; <a class="el" href="structfair_1_1mq_1_1ofi_1_1Context_1_1Address.html">Address</a></td></tr>
<tr class="separator:ae0bb0dcb06e94c7d587040c81a165cd6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b1eb8f3e378f317d82748b7b845cac2"><td class="memItemLeft" align="right" valign="top"><a id="a6b1eb8f3e378f317d82748b7b845cac2"></a>
static auto&#160;</td><td class="memItemRight" valign="bottom"><b>VerifyAddress</b> (const std::string &amp;address) -&gt; <a class="el" href="structfair_1_1mq_1_1ofi_1_1Context_1_1Address.html">Address</a></td></tr>
<tr class="separator:a6b1eb8f3e378f317d82748b7b845cac2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Transport-wide context. </p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd>TODO insert long description </dd></dl>
</div><hr/>The documentation for this class was generated from the following files:<ul>
<li>fairmq/ofi/<a class="el" href="Context_8h_source.html">Context.h</a></li>
<li>fairmq/ofi/Context.cxx</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink