ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-20 11:05:54 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e1dae4fb62ce2d05ca34c66a26724e0568d0f75a
rippled/structripple_1_1RPC_1_1Request.html
bthomee e7f4ae8bed deploy: afc05659ed
2025-08-19 09:49:50 -07:00

349 lines
21 KiB
HTML
Raw 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: ripple::RPC::Request Struct 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="namespaceripple_1_1RPC.html">RPC</a></li><li class="navelem"><a class="el" href="structripple_1_1RPC_1_1Request.html">Request</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="structripple_1_1RPC_1_1Request-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::RPC::Request Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="Request_8h_source.html">Request.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ripple::RPC::Request:</div>
<div class="dyncontent">
<div class="center"><img src="structripple_1_1RPC_1_1Request__coll__graph.png" border="0" usemap="#aripple_1_1RPC_1_1Request_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1RPC_1_1Request_coll__map" id="aripple_1_1RPC_1_1Request_coll__map">
<area shape="rect" title=" " alt="" coords="1547,235,1701,260"/>
<area shape="rect" href="classbeast_1_1Journal.html" title="A generic endpoint for log messages." alt="" coords="1306,21,1417,47"/>
<area shape="poly" title=" " alt="" coords="1407,50,1447,73,1499,115,1547,160,1614,232,1610,236,1543,164,1496,119,1444,78,1405,55"/>
<area shape="rect" href="classbeast_1_1Journal_1_1Sink.html" title="Abstraction for the underlying message destination." alt="" coords="885,5,1031,31"/>
<area shape="poly" title=" " alt="" coords="1045,19,1306,29,1306,35,1045,24"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="620,235,707,260"/>
<area shape="poly" title=" " alt="" coords="721,245,1547,245,1547,250,721,250"/>
<area shape="rect" href="classripple_1_1Resource_1_1Charge.html" title="A consumption charge." alt="" coords="1072,287,1253,312"/>
<area shape="poly" title=" " alt="" coords="714,262,780,278,857,288,934,294,1072,298,1072,303,934,300,856,293,780,283,713,267"/>
<area shape="rect" href="classbeast_1_1PropertyStream_1_1Source.html" title="Subclasses can be called to write to a stream and have children." alt="" coords="874,143,1042,183"/>
<area shape="poly" title=" " alt="" coords="720,229,886,181,888,186,721,234"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="297,227,435,267"/>
<area shape="poly" title=" " alt="" coords="449,245,620,245,620,250,449,250"/>
<area shape="rect" href="classJson_1_1Value.html" title="Represents a JSON value." alt="" coords="1315,387,1408,412"/>
<area shape="poly" title=" " alt="" coords="1420,385,1471,369,1521,345,1549,325,1574,301,1611,259,1615,262,1578,305,1553,329,1524,350,1473,374,1422,390"/>
<area shape="poly" title=" " alt="" coords="1335,372,1343,363,1361,360,1377,362,1386,369,1389,378,1384,388,1380,385,1384,378,1382,372,1375,367,1361,365,1346,368,1339,375"/>
<area shape="rect" href="unionJson_1_1Value_1_1ValueHolder.html" title=" " alt="" coords="868,387,1048,412"/>
<area shape="poly" title=" " alt="" coords="1062,397,1314,397,1314,402,1062,402"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/map.html" title=" " alt="" coords="596,387,731,412"/>
<area shape="poly" title=" " alt="" coords="745,397,868,397,868,402,745,402"/>
<area shape="rect" title=" " alt="" coords="347,361,385,387"/>
<area shape="poly" title=" " alt="" coords="400,374,596,391,595,396,399,379"/>
<area shape="rect" title=" " alt="" coords="347,411,385,436"/>
<area shape="poly" title=" " alt="" coords="399,421,467,420,546,415,595,409,596,414,547,421,467,425,399,426"/>
<area shape="poly" title=" " alt="" coords="1267,293,1445,278,1564,257,1565,263,1446,283,1267,298"/>
<area shape="rect" href="classripple_1_1Application.html" title=" " alt="" coords="1291,184,1431,209"/>
<area shape="poly" title=" " alt="" coords="1442,209,1558,232,1557,237,1441,215"/>
<area shape="poly" title=" " alt="" coords="1056,174,1072,175,1291,191,1291,196,1072,181,1056,179"/>
<area shape="poly" title=" " alt="" coords="931,127,941,120,958,117,973,119,983,125,988,134,986,143,981,142,982,135,979,128,971,124,958,122,943,125,934,131"/>
<area shape="rect" href="classbeast_1_1PropertyStream_1_1Item.html" title=" " alt="" coords="1277,87,1445,127"/>
<area shape="poly" title=" " alt="" coords="1051,138,1072,134,1178,120,1277,110,1277,116,1179,125,1072,139,1052,143"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/thread/recursive_mutex.html" title=" " alt="" coords="584,95,743,120"/>
<area shape="poly" title=" " alt="" coords="745,120,874,145,873,150,744,125"/>
<area shape="poly" title=" " alt="" coords="1309,136,1254,154,1199,163,1144,168,1042,170,1042,165,1144,163,1199,158,1253,149,1307,131"/>
<area shape="rect" title=" " alt="" coords="885,55,1031,80"/>
<area shape="poly" title=" " alt="" coords="1045,68,1145,74,1254,85,1277,88,1276,93,1253,90,1145,79,1045,73"/>
<area shape="rect" href="classbeast_1_1List.html" title=" " alt="" coords="571,145,756,185"/>
<area shape="poly" title=" " alt="" coords="770,162,874,161,874,166,770,167"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="322,95,410,120"/>
<area shape="poly" title=" " alt="" coords="424,113,547,134,583,142,582,147,546,139,423,118"/>
<area shape="rect" href="classbeast_1_1detail_1_1ListNode.html" title=" " alt="" coords="275,144,457,199"/>
<area shape="poly" title=" " alt="" coords="471,166,570,164,571,169,471,172"/>
<area shape="rect" href="classbeast_1_1detail_1_1ListNode.html" title=" " alt="" coords="5,151,173,191"/>
<area shape="poly" title=" " alt="" coords="187,169,274,169,274,174,187,174"/>
<area shape="poly" title=" " alt="" coords="64,135,73,128,89,125,103,127,113,133,117,142,115,151,110,151,112,142,109,136,102,132,89,130,75,132,68,139"/>
</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:a1bb1813baac74d8882154cc0cb528b87" id="r_a1bb1813baac74d8882154cc0cb528b87"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1RPC_1_1Request.html#a1bb1813baac74d8882154cc0cb528b87">Request</a> (<a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> journal_, <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp;method_, <a class="el" href="classJson_1_1Value.html">Json::Value</a> &amp;params_, <a class="el" href="classripple_1_1Application.html">Application</a> &amp;app_)</td></tr>
<tr class="separator:a1bb1813baac74d8882154cc0cb528b87"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a5d32c433339bc19d0a683068f8cb3560" id="r_a5d32c433339bc19d0a683068f8cb3560"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1RPC_1_1Request.html#a5d32c433339bc19d0a683068f8cb3560">journal</a></td></tr>
<tr class="separator:a5d32c433339bc19d0a683068f8cb3560"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a118293dcc0507f0cf5170105b73d29cf" id="r_a118293dcc0507f0cf5170105b73d29cf"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1RPC_1_1Request.html#a118293dcc0507f0cf5170105b73d29cf">method</a></td></tr>
<tr class="separator:a118293dcc0507f0cf5170105b73d29cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3d94ffcaa73640e8131fec9596727f2" id="r_aa3d94ffcaa73640e8131fec9596727f2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classJson_1_1Value.html">Json::Value</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1RPC_1_1Request.html#aa3d94ffcaa73640e8131fec9596727f2">params</a></td></tr>
<tr class="separator:aa3d94ffcaa73640e8131fec9596727f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a201195475bd256d47d98efa53967ff8f" id="r_a201195475bd256d47d98efa53967ff8f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1Resource_1_1Charge.html">Resource::Charge</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1RPC_1_1Request.html#a201195475bd256d47d98efa53967ff8f">fee</a></td></tr>
<tr class="separator:a201195475bd256d47d98efa53967ff8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad3f7568eca724668e6a2562d3eff7ee9" id="r_ad3f7568eca724668e6a2562d3eff7ee9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classJson_1_1Value.html">Json::Value</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1RPC_1_1Request.html#ad3f7568eca724668e6a2562d3eff7ee9">result</a></td></tr>
<tr class="separator:ad3f7568eca724668e6a2562d3eff7ee9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa0675686695b0b1b9c8026c5df822324" id="r_aa0675686695b0b1b9c8026c5df822324"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1Application.html">Application</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1RPC_1_1Request.html#aa0675686695b0b1b9c8026c5df822324">app</a></td></tr>
<tr class="separator:aa0675686695b0b1b9c8026c5df822324"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-methods" name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:aa99bc05cd5c1a6129ad986d3e5a2c1b2" id="r_aa99bc05cd5c1a6129ad986d3e5a2c1b2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structripple_1_1RPC_1_1Request.html">Request</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1RPC_1_1Request.html#aa99bc05cd5c1a6129ad986d3e5a2c1b2">operator=</a> (<a class="el" href="structripple_1_1RPC_1_1Request.html">Request</a> const &amp;)</td></tr>
<tr class="separator:aa99bc05cd5c1a6129ad986d3e5a2c1b2"><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="Request_8h_source.html#l00034">34</a> of file <a class="el" href="Request_8h_source.html">Request.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a1bb1813baac74d8882154cc0cb528b87" name="a1bb1813baac74d8882154cc0cb528b87"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1bb1813baac74d8882154cc0cb528b87">&#9670;&#160;</a></span>Request()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::RPC::Request::Request </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a>&#160;</td>
<td class="paramname"><em>journal_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp;&#160;</td>
<td class="paramname"><em>method_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classJson_1_1Value.html">Json::Value</a> &amp;&#160;</td>
<td class="paramname"><em>params_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1Application.html">Application</a> &amp;&#160;</td>
<td class="paramname"><em>app_</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Request_8h_source.html#l00036">36</a> of file <a class="el" href="Request_8h_source.html">Request.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aa99bc05cd5c1a6129ad986d3e5a2c1b2" name="aa99bc05cd5c1a6129ad986d3e5a2c1b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa99bc05cd5c1a6129ad986d3e5a2c1b2">&#9670;&#160;</a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structripple_1_1RPC_1_1Request.html">Request</a> &amp; ripple::RPC::Request::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structripple_1_1RPC_1_1Request.html">Request</a> const &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a5d32c433339bc19d0a683068f8cb3560" name="a5d32c433339bc19d0a683068f8cb3560"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5d32c433339bc19d0a683068f8cb3560">&#9670;&#160;</a></span>journal</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> const ripple::RPC::Request::journal</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Request_8h_source.html#l00050">50</a> of file <a class="el" href="Request_8h_source.html">Request.h</a>.</p>
</div>
</div>
<a id="a118293dcc0507f0cf5170105b73d29cf" name="a118293dcc0507f0cf5170105b73d29cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a118293dcc0507f0cf5170105b73d29cf">&#9670;&#160;</a></span>method</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> ripple::RPC::Request::method</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Request_8h_source.html#l00053">53</a> of file <a class="el" href="Request_8h_source.html">Request.h</a>.</p>
</div>
</div>
<a id="aa3d94ffcaa73640e8131fec9596727f2" name="aa3d94ffcaa73640e8131fec9596727f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa3d94ffcaa73640e8131fec9596727f2">&#9670;&#160;</a></span>params</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classJson_1_1Value.html">Json::Value</a> ripple::RPC::Request::params</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Request_8h_source.html#l00056">56</a> of file <a class="el" href="Request_8h_source.html">Request.h</a>.</p>
</div>
</div>
<a id="a201195475bd256d47d98efa53967ff8f" name="a201195475bd256d47d98efa53967ff8f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a201195475bd256d47d98efa53967ff8f">&#9670;&#160;</a></span>fee</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1Resource_1_1Charge.html">Resource::Charge</a> ripple::RPC::Request::fee</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Request_8h_source.html#l00059">59</a> of file <a class="el" href="Request_8h_source.html">Request.h</a>.</p>
</div>
</div>
<a id="ad3f7568eca724668e6a2562d3eff7ee9" name="ad3f7568eca724668e6a2562d3eff7ee9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad3f7568eca724668e6a2562d3eff7ee9">&#9670;&#160;</a></span>result</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classJson_1_1Value.html">Json::Value</a> ripple::RPC::Request::result</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Request_8h_source.html#l00062">62</a> of file <a class="el" href="Request_8h_source.html">Request.h</a>.</p>
</div>
</div>
<a id="aa0675686695b0b1b9c8026c5df822324" name="aa0675686695b0b1b9c8026c5df822324"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa0675686695b0b1b9c8026c5df822324">&#9670;&#160;</a></span>app</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1Application.html">Application</a>&amp; ripple::RPC::Request::app</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Request_8h_source.html#l00065">65</a> of file <a class="el" href="Request_8h_source.html">Request.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>
Reference in New Issue View Git Blame Copy Permalink