mirror of
https://github.com/FairRootGroup/FairMQ.git
synced 2025-10-13 08:41:16 +00:00
138 lines
16 KiB
HTML
138 lines
16 KiB
HTML
<!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: fairmq/sdk/AsioBase.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.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&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&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"><a class="el" href="dir_d6b28f7731906a8cbc4171450df4b180.html">fairmq</a></li><li class="navelem"><a class="el" href="dir_02bd51ad6cbd3c7b005f7a6d7cf0a7f8.html">sdk</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">AsioBase.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) 2019 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_SDK_ASIOBASE_H</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#define FAIR_MQ_SDK_ASIOBASE_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 <asio/any_io_executor.hpp></span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <fairmq/sdk/Traits.h></span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <memory></span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include <utility></span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  </div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">namespace </span>fair::mq::sdk</div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> {</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">using</span> DefaultExecutor = asio::any_io_executor;</div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">using</span> DefaultAllocator = std::allocator<int>;</div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">template</span><<span class="keyword">typename</span> Executor, <span class="keyword">typename</span> Allocator></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">class </span>AsioBase</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> {</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keyword">using</span> <a class="code" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html#aea0e9ea2a6883595ee4a9170e7eb54a1">ExecutorType</a> = Executor;</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html"> 40</a></span>  <span class="keyword">auto</span> <a class="code" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html#aa4a40d98197b0ca731b855f811761741">GetExecutor</a>() const noexcept -> <a class="code" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html#aea0e9ea2a6883595ee4a9170e7eb54a1">ExecutorType</a> { <span class="keywordflow">return</span> fExecutor; }</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  </div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keyword">using</span> <a class="code" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html#ae82b8f9a1053d039542074a6538f51a9">AllocatorType</a> = Allocator;</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_1sdk_1_1AsioBase.html#a10c8108cd520e7a1ec2bced4b80df69d">GetAllocator</a>() const noexcept -> <a class="code" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html#ae82b8f9a1053d039542074a6538f51a9">AllocatorType</a> { <span class="keywordflow">return</span> fAllocator; }</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html#aa4a40d98197b0ca731b855f811761741"> 46</a></span>  </div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <a class="code" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html#a4321936e4a92d3e977dff807f0cb3d3f">AsioBase</a>() = <span class="keyword">delete</span>;</div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html#ae82b8f9a1053d039542074a6538f51a9"> 49</a></span>  </div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html#a10c8108cd520e7a1ec2bced4b80df69d"> 51</a></span>  <span class="keyword">explicit</span> <a class="code" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html#a4321936e4a92d3e977dff807f0cb3d3f">AsioBase</a>(Executor ex, Allocator alloc)</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  : fExecutor(std::move(ex))</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  , fAllocator(std::move(alloc))</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html#a4321936e4a92d3e977dff807f0cb3d3f"> 54</a></span>  {}</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  </div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html#a2711eada1efbf39cba390bdd39427e91"> 57</a></span>  <a class="code" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html#a2711eada1efbf39cba390bdd39427e91">AsioBase</a>(<span class="keyword">const</span> <a class="code" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html">AsioBase</a>&) = <span class="keyword">delete</span>;</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <a class="code" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html">AsioBase</a>& operator=(<span class="keyword">const</span> <a class="code" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html">AsioBase</a>&) = <span class="keyword">delete</span>;</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  </div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <a class="code" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html#a4321936e4a92d3e977dff807f0cb3d3f">AsioBase</a>(<a class="code" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html">AsioBase</a>&&) noexcept = default;</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <a class="code" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html">AsioBase</a>& operator=(<a class="code" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html">AsioBase</a>&&) noexcept = default;</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html#a271de7ef84469fd2650cec9dc5098d75"> 63</a></span>  </div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  ~<a class="code" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html">AsioBase</a>() = default;</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  </div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  private:</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html#a21170be420f2b42843736e497f10a692"> 67</a></span>  <a class="code" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html#aea0e9ea2a6883595ee4a9170e7eb54a1">ExecutorType</a> fExecutor;</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <a class="code" href="classfair_1_1mq_1_1sdk_1_1AsioBase.html#ae82b8f9a1053d039542074a6538f51a9">AllocatorType</a> fAllocator;</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</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="comment">// namespace fair::mq::sdk</span></div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  </div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="preprocessor">#endif </span><span class="comment">/* FAIR_MQ_SDK_ASIOBASE_H */</span><span class="preprocessor"></span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1sdk_1_1AsioBase_html_a2711eada1efbf39cba390bdd39427e91"><div class="ttname"><a href="classfair_1_1mq_1_1sdk_1_1AsioBase.html#a2711eada1efbf39cba390bdd39427e91">fair::mq::sdk::AsioBase::AsioBase</a></div><div class="ttdeci">AsioBase(Executor ex, Allocator alloc)</div><div class="ttdoc">Construct with associated I/O executor.</div><div class="ttdef"><b>Definition:</b> AsioBase.h:57</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1sdk_1_1AsioBase_html"><div class="ttname"><a href="classfair_1_1mq_1_1sdk_1_1AsioBase.html">fair::mq::sdk::AsioBase</a></div><div class="ttdoc">Base for creating Asio-enabled I/O objects.</div><div class="ttdef"><b>Definition:</b> AsioBase.h:41</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1sdk_1_1AsioBase_html_aa4a40d98197b0ca731b855f811761741"><div class="ttname"><a href="classfair_1_1mq_1_1sdk_1_1AsioBase.html#aa4a40d98197b0ca731b855f811761741">fair::mq::sdk::AsioBase::GetExecutor</a></div><div class="ttdeci">auto GetExecutor() const noexcept -> ExecutorType</div><div class="ttdoc">Get associated I/O executor.</div><div class="ttdef"><b>Definition:</b> AsioBase.h:46</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1sdk_1_1AsioBase_html_a10c8108cd520e7a1ec2bced4b80df69d"><div class="ttname"><a href="classfair_1_1mq_1_1sdk_1_1AsioBase.html#a10c8108cd520e7a1ec2bced4b80df69d">fair::mq::sdk::AsioBase::GetAllocator</a></div><div class="ttdeci">auto GetAllocator() const noexcept -> AllocatorType</div><div class="ttdoc">Get associated default allocator.</div><div class="ttdef"><b>Definition:</b> AsioBase.h:51</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1sdk_1_1AsioBase_html_ae82b8f9a1053d039542074a6538f51a9"><div class="ttname"><a href="classfair_1_1mq_1_1sdk_1_1AsioBase.html#ae82b8f9a1053d039542074a6538f51a9">fair::mq::sdk::AsioBase::AllocatorType</a></div><div class="ttdeci">Allocator AllocatorType</div><div class="ttdoc">Member type of associated default allocator.</div><div class="ttdef"><b>Definition:</b> AsioBase.h:49</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1sdk_1_1AsioBase_html_a4321936e4a92d3e977dff807f0cb3d3f"><div class="ttname"><a href="classfair_1_1mq_1_1sdk_1_1AsioBase.html#a4321936e4a92d3e977dff807f0cb3d3f">fair::mq::sdk::AsioBase::AsioBase</a></div><div class="ttdeci">AsioBase()=delete</div><div class="ttdoc">NO default ctor.</div></div>
|
|
<div class="ttc" id="aclassfair_1_1mq_1_1sdk_1_1AsioBase_html_aea0e9ea2a6883595ee4a9170e7eb54a1"><div class="ttname"><a href="classfair_1_1mq_1_1sdk_1_1AsioBase.html#aea0e9ea2a6883595ee4a9170e7eb54a1">fair::mq::sdk::AsioBase::ExecutorType</a></div><div class="ttdeci">Executor ExecutorType</div><div class="ttdoc">Member type of associated I/O executor.</div><div class="ttdef"><b>Definition:</b> AsioBase.h:44</div></div>
|
|
<p style="margin: 0 12px 10px 12px;"><a href="https://help.github.com/articles/github-privacy-statement/">privacy</a></p>
|