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

239 lines
39 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: LedgerHandler.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><li class="navelem"><a class="el" href="dir_202f05fcc82d395fac3f43e301f5a49f.html">handlers</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">LedgerHandler.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_HANDLERS_LEDGER_H_INCLUDED</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XRPL_RPC_HANDLERS_LEDGER_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;xrpld/app/ledger/LedgerMaster.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;xrpld/app/ledger/LedgerToJson.h&gt;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &lt;xrpld/app/main/Application.h&gt;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &lt;xrpld/rpc/Context.h&gt;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &lt;xrpld/rpc/Role.h&gt;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &lt;xrpld/rpc/Status.h&gt;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &lt;xrpld/rpc/detail/Handler.h&gt;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#include &lt;xrpl/json/Object.h&gt;</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#include &lt;xrpl/ledger/ReadView.h&gt;</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#include &lt;xrpl/protocol/ApiVersion.h&gt;</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#include &lt;xrpl/protocol/jss.h&gt;</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceJson.html">Json</a> {</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="keyword">class </span>Object;</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span>}</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="keyword">namespace </span>RPC {</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="keyword">struct </span>JsonContext;</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="comment">// ledger [id|index|current|closed] [full]</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="comment">// {</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="comment">// ledger: &#39;current&#39; | &#39;closed&#39; | &lt;uint256&gt; | &lt;number&gt;, // optional</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="comment">// full: true | false // optional, defaults to false.</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="comment">// }</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="foldopen" id="foldopen00032" data-start="{" data-end="};">
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="classripple_1_1RPC_1_1LedgerHandler.html"> 32</a></span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1RPC_1_1LedgerHandler.html">LedgerHandler</a></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span>{</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">explicit</span> <a class="code hl_class" href="classripple_1_1RPC_1_1LedgerHandler.html">LedgerHandler</a>(<a class="code hl_struct" href="structripple_1_1RPC_1_1JsonContext.html">JsonContext</a>&amp;);</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <a class="code hl_struct" href="structripple_1_1RPC_1_1Status.html">Status</a></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <a class="code hl_function" href="classripple_1_1RPC_1_1LedgerHandler.html#a4332b1dcd33d8b86a6fde7334627cced">check</a>();</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">template</span> &lt;<span class="keyword">class</span> Object&gt;</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <a class="code hl_function" href="classripple_1_1RPC_1_1LedgerHandler.html#aaff3c4c8d1a8acc66eca3017595f6688">writeResult</a>(Object&amp;);</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="classripple_1_1RPC_1_1LedgerHandler.html#a5e5ae5f4b6c68f248c32026546963c67"> 44</a></span> <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keywordtype">char</span> <a class="code hl_variable" href="classripple_1_1RPC_1_1LedgerHandler.html#a5e5ae5f4b6c68f248c32026546963c67">name</a>[] = <span class="stringliteral">&quot;ledger&quot;</span>;</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="classripple_1_1RPC_1_1LedgerHandler.html#a2740ea15064a4b06e3d08e0ddfde0b07"> 46</a></span> <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keywordtype">unsigned</span> <a class="code hl_variable" href="classripple_1_1RPC_1_1LedgerHandler.html#a2740ea15064a4b06e3d08e0ddfde0b07">minApiVer</a> = <a class="code hl_variable" href="namespaceripple_1_1RPC.html#ad9e8e104e82c67f071a254fa6849afe6">RPC::apiMinimumSupportedVersion</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"><a class="line" href="classripple_1_1RPC_1_1LedgerHandler.html#a15790c40d70054f39e93b7557ec48bd5"> 48</a></span> <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keywordtype">unsigned</span> <a class="code hl_variable" href="classripple_1_1RPC_1_1LedgerHandler.html#a15790c40d70054f39e93b7557ec48bd5">maxApiVer</a> = <a class="code hl_variable" href="namespaceripple_1_1RPC.html#a5cef6660176a48dd32d433358f579f09">RPC::apiMaximumValidVersion</a>;</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="classripple_1_1RPC_1_1LedgerHandler.html#acd0e3619810c4b6e344e012854130329"> 50</a></span> <span class="keyword">static</span> <span class="keyword">constexpr</span> <a class="code hl_enumeration" href="namespaceripple.html#ae08fe18f17b24699ce41d3898fbb8c2c">Role</a> <a class="code hl_variable" href="classripple_1_1RPC_1_1LedgerHandler.html#acd0e3619810c4b6e344e012854130329">role</a> = <a class="code hl_enumvalue" href="namespaceripple.html#ae08fe18f17b24699ce41d3898fbb8c2ca2e40ad879e955201df4dedbf8d479a12">Role::USER</a>;</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="classripple_1_1RPC_1_1LedgerHandler.html#a16d81ac8125f3f918739537821ba64d3"> 52</a></span> <span class="keyword">static</span> <span class="keyword">constexpr</span> <a class="code hl_enumeration" href="namespaceripple_1_1RPC.html#a1ea15d2823ab0dfcdedc8fbc31c6a782">Condition</a> <a class="code hl_variable" href="classripple_1_1RPC_1_1LedgerHandler.html#a16d81ac8125f3f918739537821ba64d3">condition</a> = <a class="code hl_enumvalue" href="namespaceripple_1_1RPC.html#a1ea15d2823ab0dfcdedc8fbc31c6a782aad9e51b9527da26b5ab60319afc7d041">NO_CONDITION</a>;</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"><a class="line" href="classripple_1_1RPC_1_1LedgerHandler.html#af7147e206b4440a32e5e27ef90c08ad5"> 55</a></span> <a class="code hl_struct" href="structripple_1_1RPC_1_1JsonContext.html">JsonContext</a>&amp; <a class="code hl_variable" href="classripple_1_1RPC_1_1LedgerHandler.html#af7147e206b4440a32e5e27ef90c08ad5">context_</a>;</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"><a class="line" href="classripple_1_1RPC_1_1LedgerHandler.html#a2bf0ee84650228777feb6f6fe271072b"> 56</a></span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr&lt;ReadView const&gt;</a> <a class="code hl_variable" href="classripple_1_1RPC_1_1LedgerHandler.html#a2bf0ee84650228777feb6f6fe271072b">ledger_</a>;</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="classripple_1_1RPC_1_1LedgerHandler.html#ab8bc221b51aee2a9f33fc8b6e99ca7c0"> 57</a></span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector&lt;TxQ::TxDetails&gt;</a> <a class="code hl_variable" href="classripple_1_1RPC_1_1LedgerHandler.html#ab8bc221b51aee2a9f33fc8b6e99ca7c0">queueTxs_</a>;</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"><a class="line" href="classripple_1_1RPC_1_1LedgerHandler.html#a8a84274c1ce5b6d4401f633f26055e92"> 58</a></span> <a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a> <a class="code hl_variable" href="classripple_1_1RPC_1_1LedgerHandler.html#a8a84274c1ce5b6d4401f633f26055e92">result_</a>;</div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"><a class="line" href="classripple_1_1RPC_1_1LedgerHandler.html#a910ec136ae3a13af7551dd1ebaa6f509"> 59</a></span> <span class="keywordtype">int</span> <a class="code hl_variable" href="classripple_1_1RPC_1_1LedgerHandler.html#a910ec136ae3a13af7551dd1ebaa6f509">options_</a> = 0;</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span>};</div>
</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="comment">//</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><span class="comment">// Implementation.</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> </div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span><span class="keyword">template</span> &lt;<span class="keyword">class</span> Object&gt;</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span><span class="keywordtype">void</span></div>
<div class="foldopen" id="foldopen00069" data-start="{" data-end="}">
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"><a class="line" href="classripple_1_1RPC_1_1LedgerHandler.html#aaff3c4c8d1a8acc66eca3017595f6688"> 69</a></span><a class="code hl_function" href="classripple_1_1RPC_1_1LedgerHandler.html#aaff3c4c8d1a8acc66eca3017595f6688">LedgerHandler::writeResult</a>(Object&amp; value)</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span>{</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> <span class="keywordflow">if</span> (<a class="code hl_variable" href="classripple_1_1RPC_1_1LedgerHandler.html#a2bf0ee84650228777feb6f6fe271072b">ledger_</a>)</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> {</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <a class="code hl_function" href="namespaceJson.html#adfd466283386e0735202bb99ef4362a1">Json::copyFrom</a>(value, <a class="code hl_variable" href="classripple_1_1RPC_1_1LedgerHandler.html#a8a84274c1ce5b6d4401f633f26055e92">result_</a>);</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> <a class="code hl_function" href="namespaceripple.html#a76c03032f9f754bf4659c3e18ede1510">addJson</a>(value, {*<a class="code hl_variable" href="classripple_1_1RPC_1_1LedgerHandler.html#a2bf0ee84650228777feb6f6fe271072b">ledger_</a>, &amp;<a class="code hl_variable" href="classripple_1_1RPC_1_1LedgerHandler.html#af7147e206b4440a32e5e27ef90c08ad5">context_</a>, <a class="code hl_variable" href="classripple_1_1RPC_1_1LedgerHandler.html#a910ec136ae3a13af7551dd1ebaa6f509">options_</a>, <a class="code hl_variable" href="classripple_1_1RPC_1_1LedgerHandler.html#ab8bc221b51aee2a9f33fc8b6e99ca7c0">queueTxs_</a>});</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> }</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> <span class="keywordflow">else</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> {</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> <span class="keyword">auto</span>&amp; master = <a class="code hl_variable" href="classripple_1_1RPC_1_1LedgerHandler.html#af7147e206b4440a32e5e27ef90c08ad5">context_</a>.<a class="code hl_variable" href="structripple_1_1RPC_1_1Context.html#a7878751d68ed7fd43c385913c5e6ff04">app</a>.<a class="code hl_function" href="classripple_1_1Application.html#aa303fb1c72786fc008ef52079dee4fe3">getLedgerMaster</a>();</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> {</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> <span class="keyword">auto</span>&amp;&amp; closed = <a class="code hl_function" href="namespaceJson.html#abb848a3f8224f260eb73b028026995c8">Json::addObject</a>(value, jss::closed);</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> <a class="code hl_function" href="namespaceripple.html#a76c03032f9f754bf4659c3e18ede1510">addJson</a>(closed, {*master.getClosedLedger(), &amp;<a class="code hl_variable" href="classripple_1_1RPC_1_1LedgerHandler.html#af7147e206b4440a32e5e27ef90c08ad5">context_</a>, 0});</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> }</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> {</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <span class="keyword">auto</span>&amp;&amp; <a class="code hl_enumvalue" href="namespaceripple.html#a77adb10ef53a2e25195ccd38b46bfe9ba7cef8a734855777c2a9d0caf42666e69">open</a> = <a class="code hl_function" href="namespaceJson.html#abb848a3f8224f260eb73b028026995c8">Json::addObject</a>(value, jss::open);</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> <a class="code hl_function" href="namespaceripple.html#a76c03032f9f754bf4659c3e18ede1510">addJson</a>(<a class="code hl_enumvalue" href="namespaceripple.html#a77adb10ef53a2e25195ccd38b46bfe9ba7cef8a734855777c2a9d0caf42666e69">open</a>, {*master.getCurrentLedger(), &amp;<a class="code hl_variable" href="classripple_1_1RPC_1_1LedgerHandler.html#af7147e206b4440a32e5e27ef90c08ad5">context_</a>, 0});</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> }</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> }</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> </div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> <a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a> warnings{<a class="code hl_enumvalue" href="namespaceJson.html#a7d654b75c16a57007925868e38212b4eadc8f264f36b55b063c78126b335415f4">Json::arrayValue</a>};</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> <span class="keywordflow">if</span> (<a class="code hl_variable" href="classripple_1_1RPC_1_1LedgerHandler.html#af7147e206b4440a32e5e27ef90c08ad5">context_</a>.<a class="code hl_variable" href="structripple_1_1RPC_1_1JsonContext.html#a036b2c14552fbca49011c3d0e78017fa">params</a>.<a class="code hl_function" href="classJson_1_1Value.html#abfa90c81f6aee7877bd5fb4c8445994f">isMember</a>(jss::type))</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> {</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> <a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a>&amp; w = warnings.<a class="code hl_function" href="classJson_1_1Value.html#a21526b61dea2a1771030473e6248621e">append</a>(<a class="code hl_enumvalue" href="namespaceJson.html#a7d654b75c16a57007925868e38212b4eae8386dcfc36d1ae897745f7b4f77a1f6">Json::objectValue</a>);</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> w[jss::id] = <a class="code hl_enumvalue" href="namespaceripple.html#a53248e40c0a268c7c59fbe4a6e1179d9a60e4f4d040e75e1cb8723f9b4c7f22cb">warnRPC_FIELDS_DEPRECATED</a>;</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> w[jss::message] =</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> <span class="stringliteral">&quot;Some fields from your request are deprecated. Please check the &quot;</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> <span class="stringliteral">&quot;documentation at &quot;</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> <span class="stringliteral">&quot;https://xrpl.org/docs/references/http-websocket-apis/ &quot;</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <span class="stringliteral">&quot;and update your request. Field `type` is deprecated.&quot;</span>;</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> }</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> </div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> <span class="keywordflow">if</span> (warnings.size())</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> value[jss::warnings] = std::move(warnings);</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span>}</div>
</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> </div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span>} <span class="comment">// namespace RPC</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> </div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span><span class="preprocessor">#endif</span></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="aclassJson_1_1Value_html_a21526b61dea2a1771030473e6248621e"><div class="ttname"><a href="classJson_1_1Value.html#a21526b61dea2a1771030473e6248621e">Json::Value::append</a></div><div class="ttdeci">Value &amp; append(Value const &amp;value)</div><div class="ttdoc">Append value to array at the end.</div><div class="ttdef"><b>Definition</b> <a href="json__value_8cpp_source.html#l00978">json_value.cpp:978</a></div></div>
<div class="ttc" id="aclassJson_1_1Value_html_abfa90c81f6aee7877bd5fb4c8445994f"><div class="ttname"><a href="classJson_1_1Value.html#abfa90c81f6aee7877bd5fb4c8445994f">Json::Value::isMember</a></div><div class="ttdeci">bool isMember(char const *key) const</div><div class="ttdoc">Return true if the object has a member named key.</div><div class="ttdef"><b>Definition</b> <a href="json__value_8cpp_source.html#l01030">json_value.cpp:1030</a></div></div>
<div class="ttc" id="aclassripple_1_1Application_html_aa303fb1c72786fc008ef52079dee4fe3"><div class="ttname"><a href="classripple_1_1Application.html#aa303fb1c72786fc008ef52079dee4fe3">ripple::Application::getLedgerMaster</a></div><div class="ttdeci">virtual LedgerMaster &amp; getLedgerMaster()=0</div></div>
<div class="ttc" id="aclassripple_1_1RPC_1_1LedgerHandler_html"><div class="ttname"><a href="classripple_1_1RPC_1_1LedgerHandler.html">ripple::RPC::LedgerHandler</a></div><div class="ttdef"><b>Definition</b> <a href="LedgerHandler_8h_source.html#l00032">LedgerHandler.h:33</a></div></div>
<div class="ttc" id="aclassripple_1_1RPC_1_1LedgerHandler_html_a15790c40d70054f39e93b7557ec48bd5"><div class="ttname"><a href="classripple_1_1RPC_1_1LedgerHandler.html#a15790c40d70054f39e93b7557ec48bd5">ripple::RPC::LedgerHandler::maxApiVer</a></div><div class="ttdeci">static constexpr unsigned maxApiVer</div><div class="ttdef"><b>Definition</b> <a href="LedgerHandler_8h_source.html#l00048">LedgerHandler.h:48</a></div></div>
<div class="ttc" id="aclassripple_1_1RPC_1_1LedgerHandler_html_a16d81ac8125f3f918739537821ba64d3"><div class="ttname"><a href="classripple_1_1RPC_1_1LedgerHandler.html#a16d81ac8125f3f918739537821ba64d3">ripple::RPC::LedgerHandler::condition</a></div><div class="ttdeci">static constexpr Condition condition</div><div class="ttdef"><b>Definition</b> <a href="LedgerHandler_8h_source.html#l00052">LedgerHandler.h:52</a></div></div>
<div class="ttc" id="aclassripple_1_1RPC_1_1LedgerHandler_html_a2740ea15064a4b06e3d08e0ddfde0b07"><div class="ttname"><a href="classripple_1_1RPC_1_1LedgerHandler.html#a2740ea15064a4b06e3d08e0ddfde0b07">ripple::RPC::LedgerHandler::minApiVer</a></div><div class="ttdeci">static constexpr unsigned minApiVer</div><div class="ttdef"><b>Definition</b> <a href="LedgerHandler_8h_source.html#l00046">LedgerHandler.h:46</a></div></div>
<div class="ttc" id="aclassripple_1_1RPC_1_1LedgerHandler_html_a2bf0ee84650228777feb6f6fe271072b"><div class="ttname"><a href="classripple_1_1RPC_1_1LedgerHandler.html#a2bf0ee84650228777feb6f6fe271072b">ripple::RPC::LedgerHandler::ledger_</a></div><div class="ttdeci">std::shared_ptr&lt; ReadView const &gt; ledger_</div><div class="ttdef"><b>Definition</b> <a href="LedgerHandler_8h_source.html#l00056">LedgerHandler.h:56</a></div></div>
<div class="ttc" id="aclassripple_1_1RPC_1_1LedgerHandler_html_a4332b1dcd33d8b86a6fde7334627cced"><div class="ttname"><a href="classripple_1_1RPC_1_1LedgerHandler.html#a4332b1dcd33d8b86a6fde7334627cced">ripple::RPC::LedgerHandler::check</a></div><div class="ttdeci">Status check()</div><div class="ttdef"><b>Definition</b> <a href="LedgerHandler_8cpp_source.html#l00021">LedgerHandler.cpp:21</a></div></div>
<div class="ttc" id="aclassripple_1_1RPC_1_1LedgerHandler_html_a5e5ae5f4b6c68f248c32026546963c67"><div class="ttname"><a href="classripple_1_1RPC_1_1LedgerHandler.html#a5e5ae5f4b6c68f248c32026546963c67">ripple::RPC::LedgerHandler::name</a></div><div class="ttdeci">static constexpr char name[]</div><div class="ttdef"><b>Definition</b> <a href="LedgerHandler_8h_source.html#l00044">LedgerHandler.h:44</a></div></div>
<div class="ttc" id="aclassripple_1_1RPC_1_1LedgerHandler_html_a8a84274c1ce5b6d4401f633f26055e92"><div class="ttname"><a href="classripple_1_1RPC_1_1LedgerHandler.html#a8a84274c1ce5b6d4401f633f26055e92">ripple::RPC::LedgerHandler::result_</a></div><div class="ttdeci">Json::Value result_</div><div class="ttdef"><b>Definition</b> <a href="LedgerHandler_8h_source.html#l00058">LedgerHandler.h:58</a></div></div>
<div class="ttc" id="aclassripple_1_1RPC_1_1LedgerHandler_html_a910ec136ae3a13af7551dd1ebaa6f509"><div class="ttname"><a href="classripple_1_1RPC_1_1LedgerHandler.html#a910ec136ae3a13af7551dd1ebaa6f509">ripple::RPC::LedgerHandler::options_</a></div><div class="ttdeci">int options_</div><div class="ttdef"><b>Definition</b> <a href="LedgerHandler_8h_source.html#l00059">LedgerHandler.h:59</a></div></div>
<div class="ttc" id="aclassripple_1_1RPC_1_1LedgerHandler_html_aaff3c4c8d1a8acc66eca3017595f6688"><div class="ttname"><a href="classripple_1_1RPC_1_1LedgerHandler.html#aaff3c4c8d1a8acc66eca3017595f6688">ripple::RPC::LedgerHandler::writeResult</a></div><div class="ttdeci">void writeResult(Object &amp;)</div><div class="ttdef"><b>Definition</b> <a href="LedgerHandler_8h_source.html#l00069">LedgerHandler.h:69</a></div></div>
<div class="ttc" id="aclassripple_1_1RPC_1_1LedgerHandler_html_ab8bc221b51aee2a9f33fc8b6e99ca7c0"><div class="ttname"><a href="classripple_1_1RPC_1_1LedgerHandler.html#ab8bc221b51aee2a9f33fc8b6e99ca7c0">ripple::RPC::LedgerHandler::queueTxs_</a></div><div class="ttdeci">std::vector&lt; TxQ::TxDetails &gt; queueTxs_</div><div class="ttdef"><b>Definition</b> <a href="LedgerHandler_8h_source.html#l00057">LedgerHandler.h:57</a></div></div>
<div class="ttc" id="aclassripple_1_1RPC_1_1LedgerHandler_html_acd0e3619810c4b6e344e012854130329"><div class="ttname"><a href="classripple_1_1RPC_1_1LedgerHandler.html#acd0e3619810c4b6e344e012854130329">ripple::RPC::LedgerHandler::role</a></div><div class="ttdeci">static constexpr Role role</div><div class="ttdef"><b>Definition</b> <a href="LedgerHandler_8h_source.html#l00050">LedgerHandler.h:50</a></div></div>
<div class="ttc" id="aclassripple_1_1RPC_1_1LedgerHandler_html_af7147e206b4440a32e5e27ef90c08ad5"><div class="ttname"><a href="classripple_1_1RPC_1_1LedgerHandler.html#af7147e206b4440a32e5e27ef90c08ad5">ripple::RPC::LedgerHandler::context_</a></div><div class="ttdeci">JsonContext &amp; context_</div><div class="ttdef"><b>Definition</b> <a href="LedgerHandler_8h_source.html#l00055">LedgerHandler.h:55</a></div></div>
<div class="ttc" id="anamespaceJson_html"><div class="ttname"><a href="namespaceJson.html">Json</a></div><div class="ttdoc">JSON (JavaScript Object Notation).</div><div class="ttdef"><b>Definition</b> <a href="json__errors_8h_source.html#l00006">json_errors.h:6</a></div></div>
<div class="ttc" id="anamespaceJson_html_a7d654b75c16a57007925868e38212b4eadc8f264f36b55b063c78126b335415f4"><div class="ttname"><a href="namespaceJson.html#a7d654b75c16a57007925868e38212b4eadc8f264f36b55b063c78126b335415f4">Json::arrayValue</a></div><div class="ttdeci">@ arrayValue</div><div class="ttdoc">array value (ordered list)</div><div class="ttdef"><b>Definition</b> <a href="json__value_8h_source.html#l00026">json_value.h:26</a></div></div>
<div class="ttc" id="anamespaceJson_html_a7d654b75c16a57007925868e38212b4eae8386dcfc36d1ae897745f7b4f77a1f6"><div class="ttname"><a href="namespaceJson.html#a7d654b75c16a57007925868e38212b4eae8386dcfc36d1ae897745f7b4f77a1f6">Json::objectValue</a></div><div class="ttdeci">@ objectValue</div><div class="ttdoc">object value (collection of name/value pairs).</div><div class="ttdef"><b>Definition</b> <a href="json__value_8h_source.html#l00028">json_value.h:27</a></div></div>
<div class="ttc" id="anamespaceJson_html_abb848a3f8224f260eb73b028026995c8"><div class="ttname"><a href="namespaceJson.html#abb848a3f8224f260eb73b028026995c8">Json::addObject</a></div><div class="ttdeci">Json::Value &amp; addObject(Json::Value &amp;, Json::StaticString const &amp;key)</div><div class="ttdoc">Add a new subobject at a named key in a Json object.</div><div class="ttdef"><b>Definition</b> <a href="Object_8h_source.html#l00408">Object.h:408</a></div></div>
<div class="ttc" id="anamespaceJson_html_adfd466283386e0735202bb99ef4362a1"><div class="ttname"><a href="namespaceJson.html#adfd466283386e0735202bb99ef4362a1">Json::copyFrom</a></div><div class="ttdeci">void copyFrom(Json::Value &amp;to, Json::Value const &amp;from)</div><div class="ttdoc">Copy all the keys and values from one object into another.</div><div class="ttdef"><b>Definition</b> <a href="Object_8cpp_source.html#l00213">Object.cpp:213</a></div></div>
<div class="ttc" id="anamespaceripple_1_1RPC_html_a1ea15d2823ab0dfcdedc8fbc31c6a782"><div class="ttname"><a href="namespaceripple_1_1RPC.html#a1ea15d2823ab0dfcdedc8fbc31c6a782">ripple::RPC::Condition</a></div><div class="ttdeci">Condition</div><div class="ttdef"><b>Definition</b> <a href="Handler_8h_source.html#l00020">Handler.h:20</a></div></div>
<div class="ttc" id="anamespaceripple_1_1RPC_html_a1ea15d2823ab0dfcdedc8fbc31c6a782aad9e51b9527da26b5ab60319afc7d041"><div class="ttname"><a href="namespaceripple_1_1RPC.html#a1ea15d2823ab0dfcdedc8fbc31c6a782aad9e51b9527da26b5ab60319afc7d041">ripple::RPC::NO_CONDITION</a></div><div class="ttdeci">@ NO_CONDITION</div><div class="ttdef"><b>Definition</b> <a href="Handler_8h_source.html#l00021">Handler.h:21</a></div></div>
<div class="ttc" id="anamespaceripple_1_1RPC_html_a5cef6660176a48dd32d433358f579f09"><div class="ttname"><a href="namespaceripple_1_1RPC.html#a5cef6660176a48dd32d433358f579f09">ripple::RPC::apiMaximumValidVersion</a></div><div class="ttdeci">static constexpr auto apiMaximumValidVersion</div><div class="ttdef"><b>Definition</b> <a href="ApiVersion_8h_source.html#l00048">ApiVersion.h:48</a></div></div>
<div class="ttc" id="anamespaceripple_1_1RPC_html_ad9e8e104e82c67f071a254fa6849afe6"><div class="ttname"><a href="namespaceripple_1_1RPC.html#ad9e8e104e82c67f071a254fa6849afe6">ripple::RPC::apiMinimumSupportedVersion</a></div><div class="ttdeci">static constexpr auto apiMinimumSupportedVersion</div><div class="ttdef"><b>Definition</b> <a href="ApiVersion_8h_source.html#l00042">ApiVersion.h:42</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="anamespaceripple_html_a53248e40c0a268c7c59fbe4a6e1179d9a60e4f4d040e75e1cb8723f9b4c7f22cb"><div class="ttname"><a href="namespaceripple.html#a53248e40c0a268c7c59fbe4a6e1179d9a60e4f4d040e75e1cb8723f9b4c7f22cb">ripple::warnRPC_FIELDS_DEPRECATED</a></div><div class="ttdeci">@ warnRPC_FIELDS_DEPRECATED</div><div class="ttdef"><b>Definition</b> <a href="ErrorCodes_8h_source.html#l00158">ErrorCodes.h:158</a></div></div>
<div class="ttc" id="anamespaceripple_html_a76c03032f9f754bf4659c3e18ede1510"><div class="ttname"><a href="namespaceripple.html#a76c03032f9f754bf4659c3e18ede1510">ripple::addJson</a></div><div class="ttdeci">void addJson(Json::Value &amp;json, LedgerFill const &amp;fill)</div><div class="ttdoc">Given a Ledger and options, fill a Json::Object or Json::Value with a description of the ledger.</div><div class="ttdef"><b>Definition</b> <a href="LedgerToJson_8cpp_source.html#l00328">LedgerToJson.cpp:328</a></div></div>
<div class="ttc" id="anamespaceripple_html_a77adb10ef53a2e25195ccd38b46bfe9ba7cef8a734855777c2a9d0caf42666e69"><div class="ttname"><a href="namespaceripple.html#a77adb10ef53a2e25195ccd38b46bfe9ba7cef8a734855777c2a9d0caf42666e69">ripple::ConsensusPhase::open</a></div><div class="ttdeci">@ open</div><div class="ttdoc">We haven't closed our ledger yet, but others might have.</div></div>
<div class="ttc" id="anamespaceripple_html_ae08fe18f17b24699ce41d3898fbb8c2c"><div class="ttname"><a href="namespaceripple.html#ae08fe18f17b24699ce41d3898fbb8c2c">ripple::Role</a></div><div class="ttdeci">Role</div><div class="ttdoc">Indicates the level of administrative permission to grant.</div><div class="ttdef"><b>Definition</b> <a href="Role_8h_source.html#l00025">Role.h:25</a></div></div>
<div class="ttc" id="anamespaceripple_html_ae08fe18f17b24699ce41d3898fbb8c2ca2e40ad879e955201df4dedbf8d479a12"><div class="ttname"><a href="namespaceripple.html#ae08fe18f17b24699ce41d3898fbb8c2ca2e40ad879e955201df4dedbf8d479a12">ripple::Role::USER</a></div><div class="ttdeci">@ USER</div></div>
<div class="ttc" id="ashared_ptr_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a></div></div>
<div class="ttc" id="astructripple_1_1RPC_1_1Context_html_a7878751d68ed7fd43c385913c5e6ff04"><div class="ttname"><a href="structripple_1_1RPC_1_1Context.html#a7878751d68ed7fd43c385913c5e6ff04">ripple::RPC::Context::app</a></div><div class="ttdeci">Application &amp; app</div><div class="ttdef"><b>Definition</b> <a href="Context_8h_source.html#l00022">Context.h:22</a></div></div>
<div class="ttc" id="astructripple_1_1RPC_1_1JsonContext_html"><div class="ttname"><a href="structripple_1_1RPC_1_1JsonContext.html">ripple::RPC::JsonContext</a></div><div class="ttdef"><b>Definition</b> <a href="Context_8h_source.html#l00033">Context.h:34</a></div></div>
<div class="ttc" id="astructripple_1_1RPC_1_1JsonContext_html_a036b2c14552fbca49011c3d0e78017fa"><div class="ttname"><a href="structripple_1_1RPC_1_1JsonContext.html#a036b2c14552fbca49011c3d0e78017fa">ripple::RPC::JsonContext::params</a></div><div class="ttdeci">Json::Value params</div><div class="ttdef"><b>Definition</b> <a href="Context_8h_source.html#l00044">Context.h:44</a></div></div>
<div class="ttc" id="astructripple_1_1RPC_1_1Status_html"><div class="ttname"><a href="structripple_1_1RPC_1_1Status.html">ripple::RPC::Status</a></div><div class="ttdoc">Status represents the results of an operation that might fail.</div><div class="ttdef"><b>Definition</b> <a href="Status_8h_source.html#l00020">Status.h:21</a></div></div>
<div class="ttc" id="avector_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</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