Files
rippled/structripple_1_1RPC_1_1Handler.html
2025-11-04 00:36:48 -08:00

243 lines
14 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" 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::Handler 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_1Handler.html">Handler</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structripple_1_1RPC_1_1Handler-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::RPC::Handler Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="Handler_8h_source.html">Handler.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ripple::RPC::Handler:</div>
<div class="dyncontent">
<div class="center"><img src="structripple_1_1RPC_1_1Handler__coll__graph.png" border="0" usemap="#aripple_1_1RPC_1_1Handler_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1RPC_1_1Handler_coll__map" id="aripple_1_1RPC_1_1Handler_coll__map">
<area shape="rect" title=" " alt="" coords="5,108,157,133"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/utility/functional/function.html" title=" " alt="" coords="9,5,154,45"/>
<area shape="poly" title=" " alt="" coords="84,59,84,108,79,108,79,59"/>
</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-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:ae4654d5b78aa373850325913a8dd6369" id="r_ae4654d5b78aa373850325913a8dd6369"><td class="memTemplParams" colspan="2">template&lt;class JsonValue &gt; </td></tr>
<tr class="memitem:ae4654d5b78aa373850325913a8dd6369"><td class="memTemplItemLeft" align="right" valign="top">using&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structripple_1_1RPC_1_1Handler.html#ae4654d5b78aa373850325913a8dd6369">Method</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>&lt; <a class="el" href="structripple_1_1RPC_1_1Status.html">Status</a>(<a class="el" href="structripple_1_1RPC_1_1JsonContext.html">JsonContext</a> &amp;, JsonValue &amp;)&gt;</td></tr>
<tr class="separator:ae4654d5b78aa373850325913a8dd6369"><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:a8a34bec561b75429790b75a180d76dd2" id="r_a8a34bec561b75429790b75a180d76dd2"><td class="memItemLeft" align="right" valign="top">char const *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1RPC_1_1Handler.html#a8a34bec561b75429790b75a180d76dd2">name_</a></td></tr>
<tr class="separator:a8a34bec561b75429790b75a180d76dd2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7ceaea57b7a15fb683925a5e9ee7222" id="r_ab7ceaea57b7a15fb683925a5e9ee7222"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structripple_1_1RPC_1_1Handler.html#ae4654d5b78aa373850325913a8dd6369">Method</a>&lt; <a class="el" href="classJson_1_1Value.html">Json::Value</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1RPC_1_1Handler.html#ab7ceaea57b7a15fb683925a5e9ee7222">valueMethod_</a></td></tr>
<tr class="separator:ab7ceaea57b7a15fb683925a5e9ee7222"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4d52f0713b55ef7417f3e53335efcf1" id="r_ac4d52f0713b55ef7417f3e53335efcf1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#ae08fe18f17b24699ce41d3898fbb8c2c">Role</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1RPC_1_1Handler.html#ac4d52f0713b55ef7417f3e53335efcf1">role_</a></td></tr>
<tr class="separator:ac4d52f0713b55ef7417f3e53335efcf1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a62bebddbaceedb3a0c554d2883cef2d7" id="r_a62bebddbaceedb3a0c554d2883cef2d7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple_1_1RPC.html#a1ea15d2823ab0dfcdedc8fbc31c6a782">RPC::Condition</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1RPC_1_1Handler.html#a62bebddbaceedb3a0c554d2883cef2d7">condition_</a></td></tr>
<tr class="separator:a62bebddbaceedb3a0c554d2883cef2d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff38a4cccbcb2ba16bd1a36bc8a2b196" id="r_aff38a4cccbcb2ba16bd1a36bc8a2b196"><td class="memItemLeft" align="right" valign="top">unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1RPC_1_1Handler.html#aff38a4cccbcb2ba16bd1a36bc8a2b196">minApiVer_</a> = <a class="el" href="namespaceripple_1_1RPC.html#ad9e8e104e82c67f071a254fa6849afe6">apiMinimumSupportedVersion</a></td></tr>
<tr class="separator:aff38a4cccbcb2ba16bd1a36bc8a2b196"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad978b4c819a44164f5f382cb5ee626b8" id="r_ad978b4c819a44164f5f382cb5ee626b8"><td class="memItemLeft" align="right" valign="top">unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1RPC_1_1Handler.html#ad978b4c819a44164f5f382cb5ee626b8">maxApiVer_</a> = <a class="el" href="namespaceripple_1_1RPC.html#a5cef6660176a48dd32d433358f579f09">apiMaximumValidVersion</a></td></tr>
<tr class="separator:ad978b4c819a44164f5f382cb5ee626b8"><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="Handler_8h_source.html#l00027">27</a> of file <a class="el" href="Handler_8h_source.html">Handler.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="ae4654d5b78aa373850325913a8dd6369" name="ae4654d5b78aa373850325913a8dd6369"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae4654d5b78aa373850325913a8dd6369">&#9670;&#160;</a></span>Method</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class JsonValue &gt; </div>
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="structripple_1_1RPC_1_1Handler.html#ae4654d5b78aa373850325913a8dd6369">ripple::RPC::Handler::Method</a> = <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>&lt;<a class="el" href="structripple_1_1RPC_1_1Status.html">Status</a>(<a class="el" href="structripple_1_1RPC_1_1JsonContext.html">JsonContext</a>&amp;, JsonValue&amp;)&gt;</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Handler_8h_source.html#l00030">30</a> of file <a class="el" href="Handler_8h_source.html">Handler.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a8a34bec561b75429790b75a180d76dd2" name="a8a34bec561b75429790b75a180d76dd2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8a34bec561b75429790b75a180d76dd2">&#9670;&#160;</a></span>name_</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char const* ripple::RPC::Handler::name_</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Handler_8h_source.html#l00032">32</a> of file <a class="el" href="Handler_8h_source.html">Handler.h</a>.</p>
</div>
</div>
<a id="ab7ceaea57b7a15fb683925a5e9ee7222" name="ab7ceaea57b7a15fb683925a5e9ee7222"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab7ceaea57b7a15fb683925a5e9ee7222">&#9670;&#160;</a></span>valueMethod_</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structripple_1_1RPC_1_1Handler.html#ae4654d5b78aa373850325913a8dd6369">Method</a>&lt;<a class="el" href="classJson_1_1Value.html">Json::Value</a>&gt; ripple::RPC::Handler::valueMethod_</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Handler_8h_source.html#l00033">33</a> of file <a class="el" href="Handler_8h_source.html">Handler.h</a>.</p>
</div>
</div>
<a id="ac4d52f0713b55ef7417f3e53335efcf1" name="ac4d52f0713b55ef7417f3e53335efcf1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4d52f0713b55ef7417f3e53335efcf1">&#9670;&#160;</a></span>role_</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceripple.html#ae08fe18f17b24699ce41d3898fbb8c2c">Role</a> ripple::RPC::Handler::role_</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Handler_8h_source.html#l00034">34</a> of file <a class="el" href="Handler_8h_source.html">Handler.h</a>.</p>
</div>
</div>
<a id="a62bebddbaceedb3a0c554d2883cef2d7" name="a62bebddbaceedb3a0c554d2883cef2d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a62bebddbaceedb3a0c554d2883cef2d7">&#9670;&#160;</a></span>condition_</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceripple_1_1RPC.html#a1ea15d2823ab0dfcdedc8fbc31c6a782">RPC::Condition</a> ripple::RPC::Handler::condition_</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Handler_8h_source.html#l00035">35</a> of file <a class="el" href="Handler_8h_source.html">Handler.h</a>.</p>
</div>
</div>
<a id="aff38a4cccbcb2ba16bd1a36bc8a2b196" name="aff38a4cccbcb2ba16bd1a36bc8a2b196"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff38a4cccbcb2ba16bd1a36bc8a2b196">&#9670;&#160;</a></span>minApiVer_</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned ripple::RPC::Handler::minApiVer_ = <a class="el" href="namespaceripple_1_1RPC.html#ad9e8e104e82c67f071a254fa6849afe6">apiMinimumSupportedVersion</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Handler_8h_source.html#l00037">37</a> of file <a class="el" href="Handler_8h_source.html">Handler.h</a>.</p>
</div>
</div>
<a id="ad978b4c819a44164f5f382cb5ee626b8" name="ad978b4c819a44164f5f382cb5ee626b8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad978b4c819a44164f5f382cb5ee626b8">&#9670;&#160;</a></span>maxApiVer_</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned ripple::RPC::Handler::maxApiVer_ = <a class="el" href="namespaceripple_1_1RPC.html#a5cef6660176a48dd32d433358f579f09">apiMaximumValidVersion</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Handler_8h_source.html#l00038">38</a> of file <a class="el" href="Handler_8h_source.html">Handler.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>