Files
rippled/classBasicApp.html
2025-11-04 00:36:48 -08:00

267 lines
14 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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<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 id="projectrow">
<td id="projectalign">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</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">
<p><code>#include &lt;<a class="el" href="BasicApp_8h_source.html">BasicApp.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for BasicApp:</div>
<div class="dyncontent">
<div class="center"><img src="classBasicApp__inherit__graph.png" border="0" usemap="#aBasicApp_inherit__map" alt="Inheritance graph"/></div>
<map name="aBasicApp_inherit__map" id="aBasicApp_inherit__map">
<area shape="rect" title=" " alt="" coords="47,5,129,31"/>
<area shape="rect" href="classripple_1_1ApplicationImp.html" title=" " alt="" coords="5,79,171,104"/>
<area shape="poly" title=" " alt="" coords="91,44,91,79,85,79,85,44"/>
</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="#aBasicApp_coll__map" alt="Collaboration graph"/></div>
<map name="aBasicApp_coll__map" id="aBasicApp_coll__map">
<area shape="rect" title=" " alt="" coords="528,63,611,89"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/utility/optional.html" title=" " alt="" coords="211,5,419,75"/>
<area shape="poly" title=" " alt="" coords="433,54,528,68,528,73,432,59"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="219,99,410,125"/>
<area shape="poly" title=" " alt="" coords="423,95,504,84,527,80,528,86,504,89,424,101"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/thread/thread.html" title=" " alt="" coords="5,99,97,125"/>
<area shape="poly" title=" " alt="" coords="111,109,219,109,219,115,111,115"/>
</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 id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a68f281adabe9b58bf52f4c6dd7f8b560" id="r_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" id="r_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:aaa69bd0d77ffef925f10bd6876dee00b" id="r_aaa69bd0d77ffef925f10bd6876dee00b"><td class="memItemLeft" align="right" valign="top">boost::asio::io_context &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBasicApp.html#aaa69bd0d77ffef925f10bd6876dee00b">get_io_context</a> ()</td></tr>
<tr class="separator:aaa69bd0d77ffef925f10bd6876dee00b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:ae038d99c89beea5ca84e92db15d74fa9" id="r_ae038d99c89beea5ca84e92db15d74fa9"><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::executor_work_guard&lt; boost::asio::io_context::executor_type &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBasicApp.html#ae038d99c89beea5ca84e92db15d74fa9">work_</a></td></tr>
<tr class="separator:ae038d99c89beea5ca84e92db15d74fa9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a53ed855cfab7fb18f9a20854051f5592" id="r_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:a2b2b86b1db70fb2369c472d2477e0061" id="r_a2b2b86b1db70fb2369c472d2477e0061"><td class="memItemLeft" align="right" valign="top">boost::asio::io_context&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classBasicApp.html#a2b2b86b1db70fb2369c472d2477e0061">io_context_</a></td></tr>
<tr class="separator:a2b2b86b1db70fb2369c472d2477e0061"><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#l00011">11</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" name="a68f281adabe9b58bf52f4c6dd7f8b560"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68f281adabe9b58bf52f4c6dd7f8b560">&#9670;&#160;</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#l00007">7</a> of file <a class="el" href="BasicApp_8cpp_source.html">BasicApp.cpp</a>.</p>
</div>
</div>
<a id="a54b860eec04d8478bf684abe09ba03fd" name="a54b860eec04d8478bf684abe09ba03fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a54b860eec04d8478bf684abe09ba03fd">&#9670;&#160;</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#l00022">22</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="aaa69bd0d77ffef925f10bd6876dee00b" name="aaa69bd0d77ffef925f10bd6876dee00b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaa69bd0d77ffef925f10bd6876dee00b">&#9670;&#160;</a></span>get_io_context()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boost::asio::io_context &amp; BasicApp::get_io_context </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#l00025">25</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="ae038d99c89beea5ca84e92db15d74fa9" name="ae038d99c89beea5ca84e92db15d74fa9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae038d99c89beea5ca84e92db15d74fa9">&#9670;&#160;</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::executor_work_guard&lt; boost::asio::io_context::executor_type&gt; &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#l00016">16</a> of file <a class="el" href="BasicApp_8h_source.html">BasicApp.h</a>.</p>
</div>
</div>
<a id="a53ed855cfab7fb18f9a20854051f5592" name="a53ed855cfab7fb18f9a20854051f5592"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a53ed855cfab7fb18f9a20854051f5592">&#9670;&#160;</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#l00017">17</a> of file <a class="el" href="BasicApp_8h_source.html">BasicApp.h</a>.</p>
</div>
</div>
<a id="a2b2b86b1db70fb2369c472d2477e0061" name="a2b2b86b1db70fb2369c472d2477e0061"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b2b86b1db70fb2369c472d2477e0061">&#9670;&#160;</a></span>io_context_</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_context BasicApp::io_context_</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#l00018">18</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="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>