mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-21 19:45:53 +00:00
170 lines
20 KiB
HTML
170 lines
20 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: 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 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&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&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_f4afb74df24474efa0cc7e8ea3ddd5ce.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 name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//------------------------------------------------------------------------------</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <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> <span class="comment"> Copyright (c) 2012, 2013 Ripple Labs Inc.</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <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> <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> <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> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <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> <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> <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> <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> <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> <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> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">//==============================================================================</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#ifndef RIPPLE_RPC_REQUEST_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define RIPPLE_RPC_REQUEST_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <ripple/resource/Charge.h></span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <ripple/resource/Fees.h></span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <ripple/json/json_value.h></span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <beast/utility/Journal.h></span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">class </span>Application;</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  </div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">namespace </span>RPC {</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  </div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="structripple_1_1RPC_1_1Request.html"> 34</a></span> <span class="keyword">struct </span><a class="code" href="structripple_1_1RPC_1_1Request.html">Request</a></div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> {</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="structripple_1_1RPC_1_1Request.html#a1bb1813baac74d8882154cc0cb528b87"> 36</a></span>  <span class="keyword">explicit</span> <a class="code" href="structripple_1_1RPC_1_1Request.html#a1bb1813baac74d8882154cc0cb528b87">Request</a> (</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <a class="code" href="classbeast_1_1Journal.html">beast::Journal</a> journal_,</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>& method_,</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <a class="code" href="classJson_1_1Value.html">Json::Value</a>& params_,</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <a class="code" href="classripple_1_1Application.html">Application</a>& app_)</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  : <a class="code" href="structripple_1_1RPC_1_1Request.html#a82b4c91f38a81476b39f3bbab2f8fa57">journal</a> (journal_)</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  , <a class="code" href="structripple_1_1RPC_1_1Request.html#a118293dcc0507f0cf5170105b73d29cf">method</a> (method_)</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  , <a class="code" href="structripple_1_1RPC_1_1Request.html#aa3d94ffcaa73640e8131fec9596727f2">params</a> (params_)</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  , <a class="code" href="structripple_1_1RPC_1_1Request.html#a201195475bd256d47d98efa53967ff8f">fee</a> (Resource::feeReferenceRPC)</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  , <a class="code" href="structripple_1_1RPC_1_1Request.html#aa0675686695b0b1b9c8026c5df822324">app</a> (app_)</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  {</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  }</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  </div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="comment">// [in] The Journal for logging</span></div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="structripple_1_1RPC_1_1Request.html#a82b4c91f38a81476b39f3bbab2f8fa57"> 50</a></span>  <a class="code" href="classbeast_1_1Journal.html">beast::Journal</a> <span class="keyword">const</span> <a class="code" href="structripple_1_1RPC_1_1Request.html#a82b4c91f38a81476b39f3bbab2f8fa57">journal</a>;</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  </div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="comment">// [in] The JSON-RPC method</span></div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="structripple_1_1RPC_1_1Request.html#a118293dcc0507f0cf5170105b73d29cf"> 53</a></span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <a class="code" href="structripple_1_1RPC_1_1Request.html#a118293dcc0507f0cf5170105b73d29cf">method</a>;</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="comment">// [in] The Ripple-specific "params" object</span></div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="structripple_1_1RPC_1_1Request.html#aa3d94ffcaa73640e8131fec9596727f2"> 56</a></span>  <a class="code" href="classJson_1_1Value.html">Json::Value</a> <a class="code" href="structripple_1_1RPC_1_1Request.html#aa3d94ffcaa73640e8131fec9596727f2">params</a>;</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  </div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="comment">// [in, out] The resource cost for the command</span></div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="structripple_1_1RPC_1_1Request.html#a201195475bd256d47d98efa53967ff8f"> 59</a></span>  <a class="code" href="classripple_1_1Resource_1_1Charge.html">Resource::Charge</a> <a class="code" href="structripple_1_1RPC_1_1Request.html#a201195475bd256d47d98efa53967ff8f">fee</a>;</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  </div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="comment">// [out] The JSON-RPC response</span></div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="structripple_1_1RPC_1_1Request.html#ad3f7568eca724668e6a2562d3eff7ee9"> 62</a></span>  <a class="code" href="classJson_1_1Value.html">Json::Value</a> <a class="code" href="structripple_1_1RPC_1_1Request.html#ad3f7568eca724668e6a2562d3eff7ee9">result</a>;</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="comment">// [in] The Application instance</span></div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="structripple_1_1RPC_1_1Request.html#aa0675686695b0b1b9c8026c5df822324"> 65</a></span>  <a class="code" href="classripple_1_1Application.html">Application</a>& <a class="code" href="structripple_1_1RPC_1_1Request.html#aa0675686695b0b1b9c8026c5df822324">app</a>;</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  </div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <a class="code" href="structripple_1_1RPC_1_1Request.html">Request</a>& <a class="code" href="structripple_1_1RPC_1_1Request.html#a9460b3a85563b0fda15819db5207f07c">operator= </a>(<a class="code" href="structripple_1_1RPC_1_1Request.html">Request</a> <span class="keyword">const</span>&);</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> };</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  </div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> }</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> }</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  </div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="preprocessor">#endif</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<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#l00085">Application.h:85</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="astructripple_1_1RPC_1_1Request_html_a9460b3a85563b0fda15819db5207f07c"><div class="ttname"><a href="structripple_1_1RPC_1_1Request.html#a9460b3a85563b0fda15819db5207f07c">ripple::RPC::Request::operator=</a></div><div class="ttdeci">Request & operator=(Request const &)</div></div>
|
|
<div class="ttc" id="astructripple_1_1RPC_1_1Request_html_a82b4c91f38a81476b39f3bbab2f8fa57"><div class="ttname"><a href="structripple_1_1RPC_1_1Request.html#a82b4c91f38a81476b39f3bbab2f8fa57">ripple::RPC::Request::journal</a></div><div class="ttdeci">const beast::Journal journal</div><div class="ttdef"><b>Definition:</b> <a href="Request_8h_source.html#l00050">Request.h:50</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 &method_, Json::Value &params_, Application &app_)</div><div class="ttdef"><b>Definition:</b> <a href="Request_8h_source.html#l00036">Request.h:36</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#l00056">Request.h:56</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#l00060">Journal.h:60</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#l00053">Request.h:53</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="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 & app</div><div class="ttdef"><b>Definition:</b> <a href="Request_8h_source.html#l00065">Request.h:65</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#l00034">Request.h:34</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#l00030">Charge.h:30</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#l00059">Request.h:59</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#l00141">json_value.h:141</a></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#l00062">Request.h:62</a></div></div>
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|