Files
rippled/WorkPlain_8h_source.html
2020-04-15 21:15:02 +00:00

172 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">
<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: 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 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_df9c78dcf3f59a33b12284f95992a64b.html">ripple</a></li><li class="navelem"><a class="el" href="dir_9f69212e4c6e2ca9ec5ab59cd7b6275c.html">app</a></li><li class="navelem"><a class="el" href="dir_29f79f6f29a0be0eebc6c46bea51c866.html">misc</a></li><li class="navelem"><a class="el" href="dir_abfa528e58ef38d4526b267cc83572ec.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 name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">//------------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> This file is part of rippled: https://github.com/ripple/rippled</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> Copyright (c) 2016 Ripple Labs Inc.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> Permission to use, copy, modify, and/or distribute this software for any</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> purpose with or without fee is hereby granted, provided that the above</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> copyright notice and this permission notice appear in all copies.</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment">*/</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment">//==============================================================================</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#ifndef RIPPLE_APP_MISC_DETAIL_WORKPLAIN_H_INCLUDED</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#define RIPPLE_APP_MISC_DETAIL_WORKPLAIN_H_INCLUDED</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &lt;ripple/app/misc/detail/WorkBase.h&gt;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="keyword">namespace </span>detail {</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="comment">// Work over TCP/IP</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="classripple_1_1detail_1_1WorkPlain.html"> 30</a></span>&#160;<span class="keyword">class </span><a class="code" href="classripple_1_1detail_1_1WorkPlain.html">WorkPlain</a> : <span class="keyword">public</span> <a class="code" href="classripple_1_1detail_1_1WorkBase.html">WorkBase</a>&lt;WorkPlain&gt;</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; , <span class="keyword">public</span> <a class="codeRef" 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 name="l00032"></a><span class="lineno"> 32</span>&#160;{</div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="classripple_1_1detail_1_1WorkPlain.html#a6d3fc293cb2be46731e6448e31437034"> 33</a></span>&#160; <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classripple_1_1detail_1_1WorkBase.html">WorkBase</a>&lt;<a class="code" href="classripple_1_1detail_1_1WorkPlain.html">WorkPlain</a>&gt;;</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <a class="code" href="classripple_1_1detail_1_1WorkPlain.html#a2d0776063c0dd9d2480bda0a8bca049f">WorkPlain</a>(</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; <a class="codeRef" 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 name="l00038"></a><span class="lineno"> 38</span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>&amp; path, <a class="codeRef" 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 name="l00039"></a><span class="lineno"> 39</span>&#160; boost::asio::io_service&amp; ios, <a class="code" href="classripple_1_1detail_1_1WorkBase.html#ae2e925a46808cc1943574245e25da832">callback_type</a> cb);</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <a class="code" href="classripple_1_1detail_1_1WorkPlain.html#a6e7d284433974163bf0f0d16212d452b">~WorkPlain</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; </div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordtype">void</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <a class="code" href="classripple_1_1detail_1_1WorkPlain.html#ac43a0bbf6dd983cae4b690940b50866f">onConnect</a>(<a class="code" href="classripple_1_1detail_1_1WorkBase.html#ab71e779cbf5260362f0e72b88e060449">error_code</a> <span class="keyword">const</span>&amp; ec);</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; </div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <a class="code" href="classripple_1_1detail_1_1WorkBase.html#a6bd2a88e6cf40c35b220d2171f662393">socket_type</a>&amp;</div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classripple_1_1detail_1_1WorkPlain.html#a9005b56165599a6be25685b357add58c"> 47</a></span>&#160; <a class="code" href="classripple_1_1detail_1_1WorkPlain.html#a9005b56165599a6be25685b357add58c">stream</a>()</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; {</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classripple_1_1detail_1_1WorkBase.html#a6d155e92ffdc4884c0afcc14b8ca8040">socket_</a>;</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; }</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;};</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;<span class="comment">//------------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; </div>
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="classripple_1_1detail_1_1WorkPlain.html#a2d0776063c0dd9d2480bda0a8bca049f"> 55</a></span>&#160;<a class="code" href="classripple_1_1detail_1_1WorkPlain.html#a2d0776063c0dd9d2480bda0a8bca049f">WorkPlain::WorkPlain</a>(</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <a class="codeRef" 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 name="l00057"></a><span class="lineno"> 57</span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>&amp; path, <a class="codeRef" 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 name="l00058"></a><span class="lineno"> 58</span>&#160; boost::asio::io_service&amp; ios, callback_type cb)</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; : <a class="code" href="classripple_1_1detail_1_1WorkBase.html">WorkBase</a> (host, path, port, ios, cb)</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;{</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;}</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;<span class="keywordtype">void</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="classripple_1_1detail_1_1WorkPlain.html#ac43a0bbf6dd983cae4b690940b50866f"> 64</a></span>&#160;<a class="code" href="classripple_1_1detail_1_1WorkPlain.html#ac43a0bbf6dd983cae4b690940b50866f">WorkPlain::onConnect</a>(error_code <span class="keyword">const</span>&amp; ec)</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160;{</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; <span class="keywordflow">if</span> (ec)</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classripple_1_1detail_1_1WorkBase.html#aea136a1e17ac0442a5f650104d1a8bc0">fail</a>(ec);</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; </div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; <a class="code" href="classripple_1_1detail_1_1WorkBase.html#aaeae0dce9809a37fc3ac02282a0c04ba">onStart</a> ();</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;}</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; </div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;} <span class="comment">// detail</span></div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; </div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;} <span class="comment">// ripple</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; </div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<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#l00030">WorkPlain.h:30</a></div></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 class="ttdoc">STL class.</div></div>
<div class="ttc" id="aclassripple_1_1detail_1_1WorkPlain_html_a2d0776063c0dd9d2480bda0a8bca049f"><div class="ttname"><a href="classripple_1_1detail_1_1WorkPlain.html#a2d0776063c0dd9d2480bda0a8bca049f">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_service &amp;ios, callback_type cb)</div><div class="ttdef"><b>Definition:</b> <a href="WorkPlain_8h_source.html#l00055">WorkPlain.h:55</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#l00155">WorkBase.h:155</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#l00060">WorkBase.h:60</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#l00178">WorkBase.h:178</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="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="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#l00036">WorkBase.h:36</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="RCLCensorshipDetector_8h_source.html#l00029">RCLCensorshipDetector.h:29</a></div></div>
<div class="ttc" id="aclassripple_1_1detail_1_1WorkBase_html_ae2e925a46808cc1943574245e25da832"><div class="ttname"><a href="classripple_1_1detail_1_1WorkBase.html#ae2e925a46808cc1943574245e25da832">ripple::detail::WorkBase&lt; WorkPlain &gt;::callback_type</a></div><div class="ttdeci">std::function&lt; void(error_code const &amp;, response_type &amp;&amp;)&gt; callback_type</div><div class="ttdef"><b>Definition:</b> <a href="WorkBase_8h_source.html#l00044">WorkBase.h:44</a></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#l00064">WorkPlain.h:64</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#l00040">WorkBase.h:40</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#l00046">WorkBase.h:46</a></div></div>
<div class="ttc" id="aclassripple_1_1detail_1_1WorkPlain_html_a9005b56165599a6be25685b357add58c"><div class="ttname"><a href="classripple_1_1detail_1_1WorkPlain.html#a9005b56165599a6be25685b357add58c">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#l00047">WorkPlain.h:47</a></div></div>
<!-- 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>