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

316 lines
17 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: 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 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="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">
<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="#ripple_1_1RPC_1_1Request_coll__map" alt="Collaboration graph"/></div>
<map name="ripple_1_1RPC_1_1Request_coll__map" id="ripple_1_1RPC_1_1Request_coll__map">
<area shape="rect" title=" " alt="" coords="1545,244,1699,271"/>
<area shape="rect" href="classripple_1_1Application.html" title=" " alt="" coords="1290,141,1430,168"/>
<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,95,1042,137"/>
<area shape="rect" href="classbeast_1_1PropertyStream_1_1Item.html" title=" " alt="" coords="1276,45,1444,86"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/thread/recursive_mutex.html" title="STL class." alt="" coords="584,51,743,77"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title="STL class." alt="" coords="620,192,707,219"/>
<area shape="rect" href="classripple_1_1Resource_1_1Charge.html" title="A consumption charge." alt="" coords="1072,244,1252,271"/>
<area shape="rect" href="classbeast_1_1List.html" title=" " alt="" coords="571,102,756,143"/>
<area shape="rect" href="classbeast_1_1detail_1_1ListNode.html" title=" " alt="" coords="275,61,457,117"/>
<area shape="rect" href="classbeast_1_1detail_1_1ListNode.html" title=" " alt="" coords="5,69,173,110"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="322,141,410,168"/>
<area shape="rect" title=" " alt="" coords="885,5,1031,32"/>
<area shape="rect" href="classJson_1_1Value.html" title="Represents a JSON value." alt="" coords="1313,344,1407,371"/>
<area shape="rect" href="unionJson_1_1Value_1_1ValueHolder.html" title=" " alt="" coords="868,344,1048,371"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/map.html" title="STL class." alt="" coords="596,344,731,371"/>
<area shape="rect" title=" " alt="" coords="347,319,385,345"/>
<area shape="rect" title=" " alt="" coords="347,369,385,396"/>
<area shape="rect" href="classbeast_1_1Journal.html" title="A generic endpoint for log messages." alt="" coords="1305,395,1415,421"/>
<area shape="rect" href="classbeast_1_1Journal_1_1Sink.html" title="Abstraction for the underlying message destination." alt="" coords="885,395,1031,421"/>
</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 name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem: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 name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a82b4c91f38a81476b39f3bbab2f8fa57"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classbeast_1_1Journal.html">beast::Journal</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1RPC_1_1Request.html#a82b4c91f38a81476b39f3bbab2f8fa57">journal</a></td></tr>
<tr class="separator:a82b4c91f38a81476b39f3bbab2f8fa57"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem: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"><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"><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"><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"><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 name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:a9460b3a85563b0fda15819db5207f07c"><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#a9460b3a85563b0fda15819db5207f07c">operator=</a> (<a class="el" href="structripple_1_1RPC_1_1Request.html">Request</a> const &amp;)</td></tr>
<tr class="separator:a9460b3a85563b0fda15819db5207f07c"><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"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1bb1813baac74d8882154cc0cb528b87">&#9670;&nbsp;</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="a9460b3a85563b0fda15819db5207f07c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9460b3a85563b0fda15819db5207f07c">&#9670;&nbsp;</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="a82b4c91f38a81476b39f3bbab2f8fa57"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a82b4c91f38a81476b39f3bbab2f8fa57">&#9670;&nbsp;</a></span>journal</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> 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"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a118293dcc0507f0cf5170105b73d29cf">&#9670;&nbsp;</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"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa3d94ffcaa73640e8131fec9596727f2">&#9670;&nbsp;</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"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a201195475bd256d47d98efa53967ff8f">&#9670;&nbsp;</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"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad3f7568eca724668e6a2562d3eff7ee9">&#9670;&nbsp;</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"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa0675686695b0b1b9c8026c5df822324">&#9670;&nbsp;</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="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>