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

180 lines
21 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: WorkPlain.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 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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_a62226f9e3a6c7c5a3be455e2f87ae01.html">xrpld</a></li><li class="navelem"><a class="el" href="dir_c69db3203fa08a9ff994909ba6ee9783.html">app</a></li><li class="navelem"><a class="el" href="dir_2860c73e71f9ef894ba4acb1eeae5483.html">misc</a></li><li class="navelem"><a class="el" href="dir_c80815dbdc2122d1b16ef343a4cf0d47.html">detail</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">WorkPlain.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef XRPL_APP_MISC_DETAIL_WORKPLAIN_H_INCLUDED</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XRPL_APP_MISC_DETAIL_WORKPLAIN_H_INCLUDED</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;xrpld/app/misc/detail/WorkBase.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="keyword">namespace </span>detail {</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment">// Work over TCP/IP</span></div>
<div class="foldopen" id="foldopen00011" data-start="{" data-end="};">
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"><a class="line" href="classripple_1_1detail_1_1WorkPlain.html"> 11</a></span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1detail_1_1WorkPlain.html">WorkPlain</a> : <span class="keyword">public</span> <a class="code hl_class" href="classripple_1_1detail_1_1WorkBase.html">WorkBase</a>&lt;WorkPlain&gt;,</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> <span class="keyword">public</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/enable_shared_from_this.html">std::enable_shared_from_this</a>&lt;WorkPlain&gt;</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span>{</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code hl_class" href="classripple_1_1detail_1_1WorkBase.html">WorkBase</a>&lt;<a class="code hl_class" href="classripple_1_1detail_1_1WorkPlain.html">WorkPlain</a>&gt;;</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> <a class="code hl_class" href="classripple_1_1detail_1_1WorkPlain.html">WorkPlain</a>(</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>&amp; host,</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>&amp; path,</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>&amp; port,</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> boost::asio::io_context&amp; ios,</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <a class="code hl_typedef" href="classripple_1_1detail_1_1WorkBase.html#aa0dc5c38ff210dd957ab4a2b9e5b21b6">endpoint_type</a> <span class="keyword">const</span>&amp; lastEndpoint,</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="keywordtype">bool</span> lastStatus,</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">callback_type</a> cb);</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="classripple_1_1detail_1_1WorkPlain.html#a6e7d284433974163bf0f0d16212d452b"> 25</a></span> <a class="code hl_function" href="classripple_1_1detail_1_1WorkPlain.html#a6e7d284433974163bf0f0d16212d452b">~WorkPlain</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <a class="code hl_function" href="classripple_1_1detail_1_1WorkPlain.html#ac43a0bbf6dd983cae4b690940b50866f">onConnect</a>(<a class="code hl_typedef" href="classripple_1_1detail_1_1WorkBase.html#ab71e779cbf5260362f0e72b88e060449">error_code</a> <span class="keyword">const</span>&amp; ec);</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <a class="code hl_typedef" href="classripple_1_1detail_1_1WorkBase.html#a6bd2a88e6cf40c35b220d2171f662393">socket_type</a>&amp;</div>
<div class="foldopen" id="foldopen00032" data-start="{" data-end="}">
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="classripple_1_1detail_1_1WorkPlain.html#a4163535f2fbadbabe4d49d53bf5433c8"> 32</a></span> <a class="code hl_function" href="classripple_1_1detail_1_1WorkPlain.html#a4163535f2fbadbabe4d49d53bf5433c8">stream</a>()</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> {</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classripple_1_1detail_1_1WorkBase.html#a6d155e92ffdc4884c0afcc14b8ca8040">socket_</a>;</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> }</div>
</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span>};</div>
</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="comment">//------------------------------------------------------------------------------</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="foldopen" id="foldopen00040" data-start="{" data-end="}">
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="classripple_1_1detail_1_1WorkPlain.html#ad9dc6d02348fe0f44f21ec274ccbfc06"> 40</a></span><a class="code hl_function" href="classripple_1_1detail_1_1WorkPlain.html#ad9dc6d02348fe0f44f21ec274ccbfc06">WorkPlain::WorkPlain</a>(</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>&amp; host,</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>&amp; path,</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>&amp; port,</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> boost::asio::io_context&amp; ios,</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <a class="code hl_typedef" href="classripple_1_1detail_1_1WorkBase.html#aa0dc5c38ff210dd957ab4a2b9e5b21b6">endpoint_type</a> <span class="keyword">const</span>&amp; lastEndpoint,</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="keywordtype">bool</span> lastStatus,</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">callback_type</a> cb)</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> : <a class="code hl_class" href="classripple_1_1detail_1_1WorkBase.html">WorkBase</a>(host, path, port, ios, lastEndpoint, lastStatus, cb)</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span>{</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span>}</div>
</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="keywordtype">void</span></div>
<div class="foldopen" id="foldopen00053" data-start="{" data-end="}">
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="classripple_1_1detail_1_1WorkPlain.html#ac43a0bbf6dd983cae4b690940b50866f"> 53</a></span><a class="code hl_function" href="classripple_1_1detail_1_1WorkPlain.html#ac43a0bbf6dd983cae4b690940b50866f">WorkPlain::onConnect</a>(<a class="code hl_typedef" href="classripple_1_1detail_1_1WorkBase.html#ab71e779cbf5260362f0e72b88e060449">error_code</a> <span class="keyword">const</span>&amp; ec)</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span>{</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keywordflow">if</span> (ec)</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="keywordflow">return</span> <a class="code hl_function" href="classripple_1_1detail_1_1WorkBase.html#aea136a1e17ac0442a5f650104d1a8bc0">fail</a>(ec);</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <a class="code hl_function" href="classripple_1_1detail_1_1WorkBase.html#aaeae0dce9809a37fc3ac02282a0c04ba">onStart</a>();</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span>}</div>
</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span>} <span class="comment">// namespace detail</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> </div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> </div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="abasic_string_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div></div>
<div class="ttc" id="aclassripple_1_1detail_1_1WorkBase_html"><div class="ttname"><a href="classripple_1_1detail_1_1WorkBase.html">ripple::detail::WorkBase</a></div><div class="ttdef"><b>Definition</b> <a href="WorkBase_8h_source.html#l00021">WorkBase.h:22</a></div></div>
<div class="ttc" id="aclassripple_1_1detail_1_1WorkBase_html_a6bd2a88e6cf40c35b220d2171f662393"><div class="ttname"><a href="classripple_1_1detail_1_1WorkBase.html#a6bd2a88e6cf40c35b220d2171f662393">ripple::detail::WorkBase&lt; WorkPlain &gt;::socket_type</a></div><div class="ttdeci">boost::asio::ip::tcp::socket socket_type</div><div class="ttdef"><b>Definition</b> <a href="WorkBase_8h_source.html#l00032">WorkBase.h:32</a></div></div>
<div class="ttc" id="aclassripple_1_1detail_1_1WorkBase_html_a6d155e92ffdc4884c0afcc14b8ca8040"><div class="ttname"><a href="classripple_1_1detail_1_1WorkBase.html#a6d155e92ffdc4884c0afcc14b8ca8040">ripple::detail::WorkBase&lt; WorkPlain &gt;::socket_</a></div><div class="ttdeci">socket_type socket_</div><div class="ttdef"><b>Definition</b> <a href="WorkBase_8h_source.html#l00045">WorkBase.h:45</a></div></div>
<div class="ttc" id="aclassripple_1_1detail_1_1WorkBase_html_aa0dc5c38ff210dd957ab4a2b9e5b21b6"><div class="ttname"><a href="classripple_1_1detail_1_1WorkBase.html#aa0dc5c38ff210dd957ab4a2b9e5b21b6">ripple::detail::WorkBase&lt; WorkPlain &gt;::endpoint_type</a></div><div class="ttdeci">boost::asio::ip::tcp::endpoint endpoint_type</div><div class="ttdef"><b>Definition</b> <a href="WorkBase_8h_source.html#l00025">WorkBase.h:25</a></div></div>
<div class="ttc" id="aclassripple_1_1detail_1_1WorkBase_html_aaeae0dce9809a37fc3ac02282a0c04ba"><div class="ttname"><a href="classripple_1_1detail_1_1WorkBase.html#aaeae0dce9809a37fc3ac02282a0c04ba">ripple::detail::WorkBase&lt; WorkPlain &gt;::onStart</a></div><div class="ttdeci">void onStart()</div><div class="ttdef"><b>Definition</b> <a href="WorkBase_8h_source.html#l00085">WorkBase.h:217</a></div></div>
<div class="ttc" id="aclassripple_1_1detail_1_1WorkBase_html_ab71e779cbf5260362f0e72b88e060449"><div class="ttname"><a href="classripple_1_1detail_1_1WorkBase.html#ab71e779cbf5260362f0e72b88e060449">ripple::detail::WorkBase&lt; WorkPlain &gt;::error_code</a></div><div class="ttdeci">boost::system::error_code error_code</div><div class="ttdef"><b>Definition</b> <a href="WorkBase_8h_source.html#l00024">WorkBase.h:24</a></div></div>
<div class="ttc" id="aclassripple_1_1detail_1_1WorkBase_html_aea136a1e17ac0442a5f650104d1a8bc0"><div class="ttname"><a href="classripple_1_1detail_1_1WorkBase.html#aea136a1e17ac0442a5f650104d1a8bc0">ripple::detail::WorkBase&lt; WorkPlain &gt;::fail</a></div><div class="ttdeci">void fail(error_code const &amp;ec)</div><div class="ttdef"><b>Definition</b> <a href="WorkBase_8h_source.html#l00076">WorkBase.h:175</a></div></div>
<div class="ttc" id="aclassripple_1_1detail_1_1WorkPlain_html"><div class="ttname"><a href="classripple_1_1detail_1_1WorkPlain.html">ripple::detail::WorkPlain</a></div><div class="ttdef"><b>Definition</b> <a href="WorkPlain_8h_source.html#l00011">WorkPlain.h:13</a></div></div>
<div class="ttc" id="aclassripple_1_1detail_1_1WorkPlain_html_a4163535f2fbadbabe4d49d53bf5433c8"><div class="ttname"><a href="classripple_1_1detail_1_1WorkPlain.html#a4163535f2fbadbabe4d49d53bf5433c8">ripple::detail::WorkPlain::stream</a></div><div class="ttdeci">socket_type &amp; stream()</div><div class="ttdef"><b>Definition</b> <a href="WorkPlain_8h_source.html#l00032">WorkPlain.h:32</a></div></div>
<div class="ttc" id="aclassripple_1_1detail_1_1WorkPlain_html_a6e7d284433974163bf0f0d16212d452b"><div class="ttname"><a href="classripple_1_1detail_1_1WorkPlain.html#a6e7d284433974163bf0f0d16212d452b">ripple::detail::WorkPlain::~WorkPlain</a></div><div class="ttdeci">~WorkPlain()=default</div></div>
<div class="ttc" id="aclassripple_1_1detail_1_1WorkPlain_html_ac43a0bbf6dd983cae4b690940b50866f"><div class="ttname"><a href="classripple_1_1detail_1_1WorkPlain.html#ac43a0bbf6dd983cae4b690940b50866f">ripple::detail::WorkPlain::onConnect</a></div><div class="ttdeci">void onConnect(error_code const &amp;ec)</div><div class="ttdef"><b>Definition</b> <a href="WorkPlain_8h_source.html#l00053">WorkPlain.h:53</a></div></div>
<div class="ttc" id="aclassripple_1_1detail_1_1WorkPlain_html_ad9dc6d02348fe0f44f21ec274ccbfc06"><div class="ttname"><a href="classripple_1_1detail_1_1WorkPlain.html#ad9dc6d02348fe0f44f21ec274ccbfc06">ripple::detail::WorkPlain::WorkPlain</a></div><div class="ttdeci">WorkPlain(std::string const &amp;host, std::string const &amp;path, std::string const &amp;port, boost::asio::io_context &amp;ios, endpoint_type const &amp;lastEndpoint, bool lastStatus, callback_type cb)</div><div class="ttdef"><b>Definition</b> <a href="WorkPlain_8h_source.html#l00040">WorkPlain.h:40</a></div></div>
<div class="ttc" id="aenable_shared_from_this_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/memory/enable_shared_from_this.html">std::enable_shared_from_this</a></div></div>
<div class="ttc" id="afunction_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function&lt; void(error_code const &amp;, endpoint_type const &amp;, response_type &amp;&amp;)&gt;</a></div></div>
<div class="ttc" id="anamespaceripple_html"><div class="ttname"><a href="namespaceripple.html">ripple</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition</b> <a href="algorithm_8h_source.html#l00006">algorithm.h:6</a></div></div>
</div><!-- fragment --></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>