ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-21 11:35:53 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
rippled/Request_8h_source.html
bthomee 7ca054b7d3 deploy: 3b810c305a
2025-11-10 09:36:27 -08:00

166 lines
18 KiB
HTML
Raw Permalink Blame History

<!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: Request.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_42b876eb66f74e25995e23a7c0222dc7.html">rpc</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">Request.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_RPC_REQUEST_H_INCLUDED</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XRPL_RPC_REQUEST_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;xrpl/beast/utility/Journal.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;xrpl/json/json_value.h&gt;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &lt;xrpl/resource/Charge.h&gt;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &lt;xrpl/resource/Fees.h&gt;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="keyword">class </span>Application;</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="keyword">namespace </span>RPC {</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
<div class="foldopen" id="foldopen00015" data-start="{" data-end="};">
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="structripple_1_1RPC_1_1Request.html"> 15</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structripple_1_1RPC_1_1Request.html">Request</a></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span>{</div>
<div class="foldopen" id="foldopen00017" data-start="{" data-end="}">
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="structripple_1_1RPC_1_1Request.html#a1bb1813baac74d8882154cc0cb528b87"> 17</a></span> <span class="keyword">explicit</span> <a class="code hl_function" href="structripple_1_1RPC_1_1Request.html#a1bb1813baac74d8882154cc0cb528b87">Request</a>(</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> <a class="code hl_class" href="classbeast_1_1Journal.html">beast::Journal</a> journal_,</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; method_,</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a>&amp; params_,</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <a class="code hl_class" href="classripple_1_1Application.html">Application</a>&amp; app_)</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> : <a class="code hl_variable" href="structripple_1_1RPC_1_1Request.html#a5d32c433339bc19d0a683068f8cb3560">journal</a>(journal_)</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> , <a class="code hl_variable" href="structripple_1_1RPC_1_1Request.html#a118293dcc0507f0cf5170105b73d29cf">method</a>(method_)</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> , <a class="code hl_variable" href="structripple_1_1RPC_1_1Request.html#aa3d94ffcaa73640e8131fec9596727f2">params</a>(params_)</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> , <a class="code hl_variable" href="structripple_1_1RPC_1_1Request.html#a201195475bd256d47d98efa53967ff8f">fee</a>(Resource::feeReferenceRPC)</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> , <a class="code hl_variable" href="structripple_1_1RPC_1_1Request.html#aa0675686695b0b1b9c8026c5df822324">app</a>(app_)</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> {</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> }</div>
</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <span class="comment">// [in] The Journal for logging</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="structripple_1_1RPC_1_1Request.html#a5d32c433339bc19d0a683068f8cb3560"> 31</a></span> <a class="code hl_class" href="classbeast_1_1Journal.html">beast::Journal</a> <span class="keyword">const</span> <a class="code hl_variable" href="structripple_1_1RPC_1_1Request.html#a5d32c433339bc19d0a683068f8cb3560">journal</a>;</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="comment">// [in] The JSON-RPC method</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="structripple_1_1RPC_1_1Request.html#a118293dcc0507f0cf5170105b73d29cf"> 34</a></span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <a class="code hl_variable" href="structripple_1_1RPC_1_1Request.html#a118293dcc0507f0cf5170105b73d29cf">method</a>;</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="comment">// [in] The Ripple-specific &quot;params&quot; object</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="structripple_1_1RPC_1_1Request.html#aa3d94ffcaa73640e8131fec9596727f2"> 37</a></span> <a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a> <a class="code hl_variable" href="structripple_1_1RPC_1_1Request.html#aa3d94ffcaa73640e8131fec9596727f2">params</a>;</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="comment">// [in, out] The resource cost for the command</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="structripple_1_1RPC_1_1Request.html#a201195475bd256d47d98efa53967ff8f"> 40</a></span> <a class="code hl_class" href="classripple_1_1Resource_1_1Charge.html">Resource::Charge</a> <a class="code hl_variable" href="structripple_1_1RPC_1_1Request.html#a201195475bd256d47d98efa53967ff8f">fee</a>;</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="comment">// [out] The JSON-RPC response</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="structripple_1_1RPC_1_1Request.html#ad3f7568eca724668e6a2562d3eff7ee9"> 43</a></span> <a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a> <a class="code hl_variable" href="structripple_1_1RPC_1_1Request.html#ad3f7568eca724668e6a2562d3eff7ee9">result</a>;</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="comment">// [in] The Application instance</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="structripple_1_1RPC_1_1Request.html#aa0675686695b0b1b9c8026c5df822324"> 46</a></span> <a class="code hl_class" href="classripple_1_1Application.html">Application</a>&amp; <a class="code hl_variable" href="structripple_1_1RPC_1_1Request.html#aa0675686695b0b1b9c8026c5df822324">app</a>;</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <a class="code hl_struct" href="structripple_1_1RPC_1_1Request.html">Request</a>&amp;</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="structripple_1_1RPC_1_1Request.html#aa99bc05cd5c1a6129ad986d3e5a2c1b2"> 50</a></span> <a class="code hl_function" href="structripple_1_1RPC_1_1Request.html#aa99bc05cd5c1a6129ad986d3e5a2c1b2">operator=</a>(<a class="code hl_struct" href="structripple_1_1RPC_1_1Request.html">Request</a> <span class="keyword">const</span>&amp;);</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span>};</div>
</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> </div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span>} <span class="comment">// namespace RPC</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</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="aclassJson_1_1Value_html"><div class="ttname"><a href="classJson_1_1Value.html">Json::Value</a></div><div class="ttdoc">Represents a JSON value.</div><div class="ttdef"><b>Definition</b> <a href="json__value_8h_source.html#l00130">json_value.h:131</a></div></div>
<div class="ttc" id="aclassbeast_1_1Journal_html"><div class="ttname"><a href="classbeast_1_1Journal.html">beast::Journal</a></div><div class="ttdoc">A generic endpoint for log messages.</div><div class="ttdef"><b>Definition</b> <a href="Journal_8h_source.html#l00040">Journal.h:41</a></div></div>
<div class="ttc" id="aclassripple_1_1Application_html"><div class="ttname"><a href="classripple_1_1Application.html">ripple::Application</a></div><div class="ttdef"><b>Definition</b> <a href="Application_8h_source.html#l00094">Application.h:95</a></div></div>
<div class="ttc" id="aclassripple_1_1Resource_1_1Charge_html"><div class="ttname"><a href="classripple_1_1Resource_1_1Charge.html">ripple::Resource::Charge</a></div><div class="ttdoc">A consumption charge.</div><div class="ttdef"><b>Definition</b> <a href="Charge_8h_source.html#l00010">Charge.h:11</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 class="ttc" id="astructripple_1_1RPC_1_1Request_html"><div class="ttname"><a href="structripple_1_1RPC_1_1Request.html">ripple::RPC::Request</a></div><div class="ttdef"><b>Definition</b> <a href="Request_8h_source.html#l00015">Request.h:16</a></div></div>
<div class="ttc" id="astructripple_1_1RPC_1_1Request_html_a118293dcc0507f0cf5170105b73d29cf"><div class="ttname"><a href="structripple_1_1RPC_1_1Request.html#a118293dcc0507f0cf5170105b73d29cf">ripple::RPC::Request::method</a></div><div class="ttdeci">std::string method</div><div class="ttdef"><b>Definition</b> <a href="Request_8h_source.html#l00034">Request.h:34</a></div></div>
<div class="ttc" id="astructripple_1_1RPC_1_1Request_html_a1bb1813baac74d8882154cc0cb528b87"><div class="ttname"><a href="structripple_1_1RPC_1_1Request.html#a1bb1813baac74d8882154cc0cb528b87">ripple::RPC::Request::Request</a></div><div class="ttdeci">Request(beast::Journal journal_, std::string const &amp;method_, Json::Value &amp;params_, Application &amp;app_)</div><div class="ttdef"><b>Definition</b> <a href="Request_8h_source.html#l00017">Request.h:17</a></div></div>
<div class="ttc" id="astructripple_1_1RPC_1_1Request_html_a201195475bd256d47d98efa53967ff8f"><div class="ttname"><a href="structripple_1_1RPC_1_1Request.html#a201195475bd256d47d98efa53967ff8f">ripple::RPC::Request::fee</a></div><div class="ttdeci">Resource::Charge fee</div><div class="ttdef"><b>Definition</b> <a href="Request_8h_source.html#l00040">Request.h:40</a></div></div>
<div class="ttc" id="astructripple_1_1RPC_1_1Request_html_a5d32c433339bc19d0a683068f8cb3560"><div class="ttname"><a href="structripple_1_1RPC_1_1Request.html#a5d32c433339bc19d0a683068f8cb3560">ripple::RPC::Request::journal</a></div><div class="ttdeci">beast::Journal const journal</div><div class="ttdef"><b>Definition</b> <a href="Request_8h_source.html#l00031">Request.h:31</a></div></div>
<div class="ttc" id="astructripple_1_1RPC_1_1Request_html_aa0675686695b0b1b9c8026c5df822324"><div class="ttname"><a href="structripple_1_1RPC_1_1Request.html#aa0675686695b0b1b9c8026c5df822324">ripple::RPC::Request::app</a></div><div class="ttdeci">Application &amp; app</div><div class="ttdef"><b>Definition</b> <a href="Request_8h_source.html#l00046">Request.h:46</a></div></div>
<div class="ttc" id="astructripple_1_1RPC_1_1Request_html_aa3d94ffcaa73640e8131fec9596727f2"><div class="ttname"><a href="structripple_1_1RPC_1_1Request.html#aa3d94ffcaa73640e8131fec9596727f2">ripple::RPC::Request::params</a></div><div class="ttdeci">Json::Value params</div><div class="ttdef"><b>Definition</b> <a href="Request_8h_source.html#l00037">Request.h:37</a></div></div>
<div class="ttc" id="astructripple_1_1RPC_1_1Request_html_aa99bc05cd5c1a6129ad986d3e5a2c1b2"><div class="ttname"><a href="structripple_1_1RPC_1_1Request.html#aa99bc05cd5c1a6129ad986d3e5a2c1b2">ripple::RPC::Request::operator=</a></div><div class="ttdeci">Request &amp; operator=(Request const &amp;)</div></div>
<div class="ttc" id="astructripple_1_1RPC_1_1Request_html_ad3f7568eca724668e6a2562d3eff7ee9"><div class="ttname"><a href="structripple_1_1RPC_1_1Request.html#ad3f7568eca724668e6a2562d3eff7ee9">ripple::RPC::Request::result</a></div><div class="ttdeci">Json::Value result</div><div class="ttdef"><b>Definition</b> <a href="Request_8h_source.html#l00043">Request.h:43</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>
Reference in New Issue View Git Blame Copy Permalink