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
6d82d305b9
FairMQ/v1.4.33/classfair_1_1mq_1_1sdk_1_1AsioBase.html
Alexey Rybalchenko 6d82d305b9 Add API docs for v1.4.33
2021-03-23 14:11:44 +01:00

156 lines
12 KiB
HTML
Raw Blame History

<!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::AsioBase&lt; Executor, Allocator &gt; Class 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="classfair_1_1mq_1_1sdk_1_1AsioBase.html">AsioBase</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="classfair_1_1mq_1_1sdk_1_1AsioBase-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">fair::mq::sdk::AsioBase&lt; Executor, Allocator &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Base for creating Asio-enabled I/O objects.
<a href="classfair_1_1mq_1_1sdk_1_1AsioBase.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="AsioBase_8h_source.html">fairmq/sdk/AsioBase.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for fair::mq::sdk::AsioBase&lt; Executor, Allocator &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classfair_1_1mq_1_1sdk_1_1AsioBase__inherit__graph.png" border="0" usemap="#fair_1_1mq_1_1sdk_1_1AsioBase_3_01Executor_00_01Allocator_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="fair_1_1mq_1_1sdk_1_1AsioBase_3_01Executor_00_01Allocator_01_4_inherit__map" id="fair_1_1mq_1_1sdk_1_1AsioBase_3_01Executor_00_01Allocator_01_4_inherit__map">
<area shape="rect" title="Base for creating Asio&#45;enabled I/O objects." alt="" coords="21,5,195,47"/>
<area shape="rect" href="classfair_1_1mq_1_1sdk_1_1BasicTopology.html" title="Represents a FairMQ topology." alt="" coords="5,95,211,136"/>
</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:aea0e9ea2a6883595ee4a9170e7eb54a1"><td class="memItemLeft" align="right" valign="top"><a id="aea0e9ea2a6883595ee4a9170e7eb54a1"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html#aea0e9ea2a6883595ee4a9170e7eb54a1">ExecutorType</a> = Executor</td></tr>
<tr class="memdesc:aea0e9ea2a6883595ee4a9170e7eb54a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Member type of associated I/O executor. <br /></td></tr>
<tr class="separator:aea0e9ea2a6883595ee4a9170e7eb54a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae82b8f9a1053d039542074a6538f51a9"><td class="memItemLeft" align="right" valign="top"><a id="ae82b8f9a1053d039542074a6538f51a9"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html#ae82b8f9a1053d039542074a6538f51a9">AllocatorType</a> = Allocator</td></tr>
<tr class="memdesc:ae82b8f9a1053d039542074a6538f51a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Member type of associated default allocator. <br /></td></tr>
<tr class="separator:ae82b8f9a1053d039542074a6538f51a9"><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:aa4a40d98197b0ca731b855f811761741"><td class="memItemLeft" align="right" valign="top"><a id="aa4a40d98197b0ca731b855f811761741"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html#aa4a40d98197b0ca731b855f811761741">GetExecutor</a> () const noexcept -&gt; <a class="el" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html#aea0e9ea2a6883595ee4a9170e7eb54a1">ExecutorType</a></td></tr>
<tr class="memdesc:aa4a40d98197b0ca731b855f811761741"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get associated I/O executor. <br /></td></tr>
<tr class="separator:aa4a40d98197b0ca731b855f811761741"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10c8108cd520e7a1ec2bced4b80df69d"><td class="memItemLeft" align="right" valign="top"><a id="a10c8108cd520e7a1ec2bced4b80df69d"></a>
auto&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html#a10c8108cd520e7a1ec2bced4b80df69d">GetAllocator</a> () const noexcept -&gt; <a class="el" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html#ae82b8f9a1053d039542074a6538f51a9">AllocatorType</a></td></tr>
<tr class="memdesc:a10c8108cd520e7a1ec2bced4b80df69d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get associated default allocator. <br /></td></tr>
<tr class="separator:a10c8108cd520e7a1ec2bced4b80df69d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4321936e4a92d3e977dff807f0cb3d3f"><td class="memItemLeft" align="right" valign="top"><a id="a4321936e4a92d3e977dff807f0cb3d3f"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html#a4321936e4a92d3e977dff807f0cb3d3f">AsioBase</a> ()=delete</td></tr>
<tr class="memdesc:a4321936e4a92d3e977dff807f0cb3d3f"><td class="mdescLeft">&#160;</td><td class="mdescRight">NO default ctor. <br /></td></tr>
<tr class="separator:a4321936e4a92d3e977dff807f0cb3d3f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2711eada1efbf39cba390bdd39427e91"><td class="memItemLeft" align="right" valign="top"><a id="a2711eada1efbf39cba390bdd39427e91"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html#a2711eada1efbf39cba390bdd39427e91">AsioBase</a> (Executor ex, Allocator alloc)</td></tr>
<tr class="memdesc:a2711eada1efbf39cba390bdd39427e91"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct with associated I/O executor. <br /></td></tr>
<tr class="separator:a2711eada1efbf39cba390bdd39427e91"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a271de7ef84469fd2650cec9dc5098d75"><td class="memItemLeft" align="right" valign="top"><a id="a271de7ef84469fd2650cec9dc5098d75"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html#a271de7ef84469fd2650cec9dc5098d75">AsioBase</a> (const <a class="el" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html">AsioBase</a> &amp;)=delete</td></tr>
<tr class="memdesc:a271de7ef84469fd2650cec9dc5098d75"><td class="mdescLeft">&#160;</td><td class="mdescRight">NOT copyable. <br /></td></tr>
<tr class="separator:a271de7ef84469fd2650cec9dc5098d75"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a82ab8e2cc8133a7456fb8263044e671e"><td class="memItemLeft" align="right" valign="top"><a id="a82ab8e2cc8133a7456fb8263044e671e"></a>
<a class="el" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html">AsioBase</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html">AsioBase</a> &amp;)=delete</td></tr>
<tr class="separator:a82ab8e2cc8133a7456fb8263044e671e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a21170be420f2b42843736e497f10a692"><td class="memItemLeft" align="right" valign="top"><a id="a21170be420f2b42843736e497f10a692"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html#a21170be420f2b42843736e497f10a692">AsioBase</a> (<a class="el" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html">AsioBase</a> &amp;&amp;) noexcept=default</td></tr>
<tr class="memdesc:a21170be420f2b42843736e497f10a692"><td class="mdescLeft">&#160;</td><td class="mdescRight">movable <br /></td></tr>
<tr class="separator:a21170be420f2b42843736e497f10a692"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a368a535d60c3c11e06ac4e37d6afd1d3"><td class="memItemLeft" align="right" valign="top"><a id="a368a535d60c3c11e06ac4e37d6afd1d3"></a>
<a class="el" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html">AsioBase</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html">AsioBase</a> &amp;&amp;) noexcept=default</td></tr>
<tr class="separator:a368a535d60c3c11e06ac4e37d6afd1d3"><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 Executor, typename Allocator&gt;<br />
class fair::mq::sdk::AsioBase&lt; Executor, Allocator &gt;</h3>
<p>Base for creating Asio-enabled I/O objects. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">Executor</td><td>Associated I/O executor </td></tr>
<tr><td class="paramname">Allocator</td><td>Associated default allocator </td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt>Thread Safety</dt><dd><em>Distinct</em> <em>objects:</em> Safe.<br />
<em>Shared</em> <em>objects:</em> Unsafe. </dd></dl>
</div><hr/>The documentation for this class was generated from the following file:<ul>
<li>fairmq/sdk/<a class="el" href="AsioBase_8h_source.html">AsioBase.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>
Reference in New Issue View Git Blame Copy Permalink