Files
rippled/classBasicApp.html
2021-03-12 22:34:28 +00:00

256 lines
12 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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: BasicApp 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">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<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><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classBasicApp-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">BasicApp Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for BasicApp:</div>
<div class="dyncontent">
<div class="center"><img src="classBasicApp__inherit__graph.png" border="0" usemap="#BasicApp_inherit__map" alt="Inheritance graph"/></div>
<map name="BasicApp_inherit__map" id="BasicApp_inherit__map">
<area shape="rect" title=" " alt="" coords="47,5,129,32"/>
<area shape="rect" href="classripple_1_1ApplicationImp.html" title=" " alt="" coords="5,80,171,107"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for BasicApp:</div>
<div class="dyncontent">
<div class="center"><img src="classBasicApp__coll__graph.png" border="0" usemap="#BasicApp_coll__map" alt="Collaboration graph"/></div>
<map name="BasicApp_coll__map" id="BasicApp_coll__map">
<area shape="rect" title=" " alt="" coords="95,199,177,225"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/utility/optional.html" title=" " alt="" coords="5,95,192,136"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="217,102,407,129"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/thread/thread.html" title="STL class." alt="" coords="266,5,358,32"/>
</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-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a68f281adabe9b58bf52f4c6dd7f8b560"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBasicApp.html#a68f281adabe9b58bf52f4c6dd7f8b560">BasicApp</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> numberOfThreads)</td></tr>
<tr class="separator:a68f281adabe9b58bf52f4c6dd7f8b560"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54b860eec04d8478bf684abe09ba03fd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBasicApp.html#a54b860eec04d8478bf684abe09ba03fd">~BasicApp</a> ()</td></tr>
<tr class="separator:a54b860eec04d8478bf684abe09ba03fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a33e6eb1c0774a3cd6ca8a6a5069e363d"><td class="memItemLeft" align="right" valign="top">boost::asio::io_service &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBasicApp.html#a33e6eb1c0774a3cd6ca8a6a5069e363d">get_io_service</a> ()</td></tr>
<tr class="separator:a33e6eb1c0774a3cd6ca8a6a5069e363d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:acbe2bef2634f792a29c2b462cd4a9ff8"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt; boost::asio::io_service::work &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBasicApp.html#acbe2bef2634f792a29c2b462cd4a9ff8">work_</a></td></tr>
<tr class="separator:acbe2bef2634f792a29c2b462cd4a9ff8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a53ed855cfab7fb18f9a20854051f5592"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt; <a class="elRef" href="http://en.cppreference.com/w/cpp/thread/thread.html">std::thread</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBasicApp.html#a53ed855cfab7fb18f9a20854051f5592">threads_</a></td></tr>
<tr class="separator:a53ed855cfab7fb18f9a20854051f5592"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7653bf5f56f12d87d7fd81b6261ad5c"><td class="memItemLeft" align="right" valign="top">boost::asio::io_service&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBasicApp.html#ac7653bf5f56f12d87d7fd81b6261ad5c">io_service_</a></td></tr>
<tr class="separator:ac7653bf5f56f12d87d7fd81b6261ad5c"><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 class="definition">Definition at line <a class="el" href="BasicApp_8h_source.html#l00029">29</a> of file <a class="el" href="BasicApp_8h_source.html">BasicApp.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a68f281adabe9b58bf52f4c6dd7f8b560"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68f281adabe9b58bf52f4c6dd7f8b560">&#9670;&nbsp;</a></span>BasicApp()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">BasicApp::BasicApp </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>&#160;</td>
<td class="paramname"><em>numberOfThreads</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="BasicApp_8cpp_source.html#l00023">23</a> of file <a class="el" href="BasicApp_8cpp_source.html">BasicApp.cpp</a>.</p>
</div>
</div>
<a id="a54b860eec04d8478bf684abe09ba03fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a54b860eec04d8478bf684abe09ba03fd">&#9670;&nbsp;</a></span>~BasicApp()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">BasicApp::~BasicApp </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="BasicApp_8cpp_source.html#l00038">38</a> of file <a class="el" href="BasicApp_8cpp_source.html">BasicApp.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a33e6eb1c0774a3cd6ca8a6a5069e363d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a33e6eb1c0774a3cd6ca8a6a5069e363d">&#9670;&nbsp;</a></span>get_io_service()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boost::asio::io_service&amp; BasicApp::get_io_service </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="BasicApp_8h_source.html#l00041">41</a> of file <a class="el" href="BasicApp_8h_source.html">BasicApp.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="acbe2bef2634f792a29c2b462cd4a9ff8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acbe2bef2634f792a29c2b462cd4a9ff8">&#9670;&nbsp;</a></span>work_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt;boost::asio::io_service::work&gt; BasicApp::work_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="BasicApp_8h_source.html#l00032">32</a> of file <a class="el" href="BasicApp_8h_source.html">BasicApp.h</a>.</p>
</div>
</div>
<a id="a53ed855cfab7fb18f9a20854051f5592"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a53ed855cfab7fb18f9a20854051f5592">&#9670;&nbsp;</a></span>threads_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt;<a class="elRef" href="http://en.cppreference.com/w/cpp/thread/thread.html">std::thread</a>&gt; BasicApp::threads_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="BasicApp_8h_source.html#l00033">33</a> of file <a class="el" href="BasicApp_8h_source.html">BasicApp.h</a>.</p>
</div>
</div>
<a id="ac7653bf5f56f12d87d7fd81b6261ad5c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac7653bf5f56f12d87d7fd81b6261ad5c">&#9670;&nbsp;</a></span>io_service_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">boost::asio::io_service BasicApp::io_service_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="BasicApp_8h_source.html#l00034">34</a> of file <a class="el" href="BasicApp_8h_source.html">BasicApp.h</a>.</p>
</div>
</div>
</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.17
</small></address>
</body>
</html>