Mirror/FairMQ
1
0
Fork 0
mirror of https://github.com/FairRootGroup/FairMQ.git synced 2025-12-17 00:10:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add API docs for v1.4.33

Browse Source
This commit is contained in:
Alexey Rybalchenko
2021-03-23 14:11:44 +01:00
parent 6101a6678e
commit 6d82d305b9
1791 changed files with 88009 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

148
v1.4.33/structfair_1_1mq_1_1sdk_1_1AsioAsyncOpImpl.html Normal file
View File

@@ -0,0 +1,148 @@
<!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: fair::mq::sdk::AsioAsyncOpImpl&lt; Executor1, Allocator1, Handler, SignatureArgTypes &gt; Struct Template 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.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&amp;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&amp;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"><b>fair</b></li><li class="navelem"><a class="el" href="namespacefair_1_1mq.html">mq</a></li><li class="navelem"><b>sdk</b></li><li class="navelem"><a class="el" href="structfair_1_1mq_1_1sdk_1_1AsioAsyncOpImpl.html">AsioAsyncOpImpl</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="structfair_1_1mq_1_1sdk_1_1AsioAsyncOpImpl-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">fair::mq::sdk::AsioAsyncOpImpl&lt; Executor1, Allocator1, Handler, SignatureArgTypes &gt; Struct Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="AsioAsyncOp_8h_source.html">AsioAsyncOp.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for fair::mq::sdk::AsioAsyncOpImpl&lt; Executor1, Allocator1, Handler, SignatureArgTypes &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="structfair_1_1mq_1_1sdk_1_1AsioAsyncOpImpl__inherit__graph.png" border="0" usemap="#fair_1_1mq_1_1sdk_1_1AsioAsyncOpImpl_3_01Executor1_00_01Allocator1_00_01Handler_00_01SignatureArgTypes_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="fair_1_1mq_1_1sdk_1_1AsioAsyncOpImpl_3_01Executor1_00_01Allocator1_00_01Handler_00_01SignatureArgTypes_01_4_inherit__map" id="fair_1_1mq_1_1sdk_1_1AsioAsyncOpImpl_3_01Executor1_00_01Allocator1_00_01Handler_00_01SignatureArgTypes_01_4_inherit__map">
<area shape="rect" title=" " alt="" coords="24,95,251,151"/>
<area shape="rect" href="structfair_1_1mq_1_1sdk_1_1AsioAsyncOpImplBase.html" title=" " alt="" coords="5,5,269,47"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for fair::mq::sdk::AsioAsyncOpImpl&lt; Executor1, Allocator1, Handler, SignatureArgTypes &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="structfair_1_1mq_1_1sdk_1_1AsioAsyncOpImpl__coll__graph.png" border="0" usemap="#fair_1_1mq_1_1sdk_1_1AsioAsyncOpImpl_3_01Executor1_00_01Allocator1_00_01Handler_00_01SignatureArgTypes_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="fair_1_1mq_1_1sdk_1_1AsioAsyncOpImpl_3_01Executor1_00_01Allocator1_00_01Handler_00_01SignatureArgTypes_01_4_coll__map" id="fair_1_1mq_1_1sdk_1_1AsioAsyncOpImpl_3_01Executor1_00_01Allocator1_00_01Handler_00_01SignatureArgTypes_01_4_coll__map">
<area shape="rect" title=" " alt="" coords="24,95,251,151"/>
<area shape="rect" href="structfair_1_1mq_1_1sdk_1_1AsioAsyncOpImplBase.html" title=" " alt="" coords="5,5,269,47"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a820a239d34fbcf405ba17a34ad1f44ed"><td class="memItemLeft" align="right" valign="top"><a id="a820a239d34fbcf405ba17a34ad1f44ed"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfair_1_1mq_1_1sdk_1_1AsioAsyncOpImpl.html#a820a239d34fbcf405ba17a34ad1f44ed">Allocator2</a> = typename asio::associated_allocator&lt; Handler, Allocator1 &gt;::type</td></tr>
<tr class="memdesc:a820a239d34fbcf405ba17a34ad1f44ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">See <a href="https://www.boost.org/doc/libs/1_70_0/doc/html/boost_asio/reference/asynchronous_operations.html#boost_asio.reference.asynchronous_operations.allocation_of_intermediate_storage">https://www.boost.org/doc/libs/1_70_0/doc/html/boost_asio/reference/asynchronous_operations.html#boost_asio.reference.asynchronous_operations.allocation_of_intermediate_storage</a>. <br /></td></tr>
<tr class="separator:a820a239d34fbcf405ba17a34ad1f44ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4b1a39b8b234928a75c78d71a3c29774"><td class="memItemLeft" align="right" valign="top"><a id="a4b1a39b8b234928a75c78d71a3c29774"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfair_1_1mq_1_1sdk_1_1AsioAsyncOpImpl.html#a4b1a39b8b234928a75c78d71a3c29774">Executor2</a> = typename asio::associated_executor&lt; Handler, Executor1 &gt;::type</td></tr>
<tr class="memdesc:a4b1a39b8b234928a75c78d71a3c29774"><td class="mdescLeft">&#160;</td><td class="mdescRight">See <a href="https://www.boost.org/doc/libs/1_70_0/doc/html/boost_asio/reference/asynchronous_operations.html#boost_asio.reference.asynchronous_operations.associated_completion_handler_executor">https://www.boost.org/doc/libs/1_70_0/doc/html/boost_asio/reference/asynchronous_operations.html#boost_asio.reference.asynchronous_operations.associated_completion_handler_executor</a>. <br /></td></tr>
<tr class="separator:a4b1a39b8b234928a75c78d71a3c29774"><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:a26eb6b7a6579693bd95fa1feff298a78"><td class="memItemLeft" align="right" valign="top"><a id="a26eb6b7a6579693bd95fa1feff298a78"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfair_1_1mq_1_1sdk_1_1AsioAsyncOpImpl.html#a26eb6b7a6579693bd95fa1feff298a78">AsioAsyncOpImpl</a> (const Executor1 &amp;ex1, Allocator1 alloc1, Handler &amp;&amp;handler)</td></tr>
<tr class="memdesc:a26eb6b7a6579693bd95fa1feff298a78"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ctor. <br /></td></tr>
<tr class="separator:a26eb6b7a6579693bd95fa1feff298a78"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aefe64ad58193e65be6ce0493de7b4151"><td class="memItemLeft" align="right" valign="top"><a id="aefe64ad58193e65be6ce0493de7b4151"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>GetAlloc2</b> () const -&gt; <a class="el" href="structfair_1_1mq_1_1sdk_1_1AsioAsyncOpImpl.html#a820a239d34fbcf405ba17a34ad1f44ed">Allocator2</a></td></tr>
<tr class="separator:aefe64ad58193e65be6ce0493de7b4151"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3e43c423573bdc9f71f09e87376b3aa4"><td class="memItemLeft" align="right" valign="top"><a id="a3e43c423573bdc9f71f09e87376b3aa4"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>GetEx2</b> () const -&gt; <a class="el" href="structfair_1_1mq_1_1sdk_1_1AsioAsyncOpImpl.html#a4b1a39b8b234928a75c78d71a3c29774">Executor2</a></td></tr>
<tr class="separator:a3e43c423573bdc9f71f09e87376b3aa4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a188865f444be4d2ceae9da8e74f8b2c5"><td class="memItemLeft" align="right" valign="top"><a id="a188865f444be4d2ceae9da8e74f8b2c5"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>Complete</b> (std::error_code ec, SignatureArgTypes... args) -&gt; void override</td></tr>
<tr class="separator:a188865f444be4d2ceae9da8e74f8b2c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07c582464152fee73ab254cbf4eb4eb0"><td class="memItemLeft" align="right" valign="top"><a id="a07c582464152fee73ab254cbf4eb4eb0"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><b>IsCompleted</b> () const -&gt; bool override</td></tr>
<tr class="separator:a07c582464152fee73ab254cbf4eb4eb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_structfair_1_1mq_1_1sdk_1_1AsioAsyncOpImplBase"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structfair_1_1mq_1_1sdk_1_1AsioAsyncOpImplBase')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="structfair_1_1mq_1_1sdk_1_1AsioAsyncOpImplBase.html">fair::mq::sdk::AsioAsyncOpImplBase&lt; SignatureArgTypes... &gt;</a></td></tr>
<tr class="memitem:a5fc647e83fbe4f78339d4beaf24b789d inherit pub_methods_structfair_1_1mq_1_1sdk_1_1AsioAsyncOpImplBase"><td class="memItemLeft" align="right" valign="top"><a id="a5fc647e83fbe4f78339d4beaf24b789d"></a>
virtual auto&#160;</td><td class="memItemRight" valign="bottom"><b>IsCompleted</b> () const -&gt; bool=0</td></tr>
<tr class="separator:a5fc647e83fbe4f78339d4beaf24b789d inherit pub_methods_structfair_1_1mq_1_1sdk_1_1AsioAsyncOpImplBase"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename Executor1, typename Allocator1, typename Handler, typename... SignatureArgTypes&gt;<br />
struct fair::mq::sdk::AsioAsyncOpImpl&lt; Executor1, Allocator1, Handler, SignatureArgTypes &gt;</h3>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Executor1</td><td>Associated I/O executor, see <a href="https://www.boost.org/doc/libs/1_70_0/doc/html/boost_asio/reference/asynchronous_operations.html#boost_asio.reference.asynchronous_operations.associated_i_o_executor">https://www.boost.org/doc/libs/1_70_0/doc/html/boost_asio/reference/asynchronous_operations.html#boost_asio.reference.asynchronous_operations.associated_i_o_executor</a> </td></tr>
<tr><td class="paramname">Allocator1</td><td>Default allocation strategy, see <a href="https://www.boost.org/doc/libs/1_70_0/doc/html/boost_asio/reference/asynchronous_operations.html#boost_asio.reference.asynchronous_operations.allocation_of_intermediate_storage">https://www.boost.org/doc/libs/1_70_0/doc/html/boost_asio/reference/asynchronous_operations.html#boost_asio.reference.asynchronous_operations.allocation_of_intermediate_storage</a> </td></tr>
</table>
</dd>
</dl>
</div><hr/>The documentation for this struct was generated from the following file:<ul>
<li>fairmq/sdk/<a class="el" href="AsioAsyncOp_8h_source.html">AsioAsyncOp.h</a></li>
</ul>
</div><!-- contents -->
<p style="margin: 0 12px 10px 12px;"><a href="https://help.github.com/articles/github-privacy-statement/">privacy</a></p>