mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-22 12:05:53 +00:00
162 lines
20 KiB
HTML
162 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: utility.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_120ed4da3e3217b1e7fc0b4f48568e79.html">test</a></li><li class="navelem"><a class="el" href="dir_ffd09a46879067226d7ad9ce2abbf5ef.html">jtx</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">utility.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_TEST_JTX_UTILITY_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define RIPPLE_TEST_JTX_UTILITY_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/app/ledger/Ledger.h></span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <ripple/json/json_value.h></span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <ripple/protocol/STObject.h></span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <ripple/rpc/impl/RPCHelpers.h></span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/stdexcept.html">stdexcept</a>></span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include <test/jtx/Account.h></span></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">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">namespace </span>test {</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">namespace </span>jtx {</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  </div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="structripple_1_1test_1_1jtx_1_1parse__error.html"> 35</a></span> <span class="keyword">struct </span><a class="code" href="structripple_1_1test_1_1jtx_1_1parse__error.html">parse_error</a> : <a class="codeRef" href="http://en.cppreference.com/w/cpp/error/logic_error.html">std::logic_error</a></div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> {</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="keyword">template</span> <<span class="keyword">class</span> String></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="structripple_1_1test_1_1jtx_1_1parse__error.html#a331efe918052c83efea6ed80e41991bd"> 38</a></span>  <span class="keyword">explicit</span> <a class="code" href="structripple_1_1test_1_1jtx_1_1parse__error.html#a331efe918052c83efea6ed80e41991bd">parse_error</a>(String <span class="keyword">const</span>& s) : <a class="codeRef" href="http://en.cppreference.com/w/cpp/error/logic_error.html">logic_error</a>(s)</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  {</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  }</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> };</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  </div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <a class="code" href="classripple_1_1STObject.html">STObject</a></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <a class="code" href="namespaceripple_1_1test_1_1jtx.html#adebaab462b6c8ddf35410fb001d96256">parse</a>(<a class="code" href="classJson_1_1Value.html">Json::Value</a> <span class="keyword">const</span>& jv);</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  </div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="keywordtype">void</span></div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <a class="code" href="namespaceripple_1_1test_1_1jtx.html#adc60f69b0b87ebebf13420f40738ff97">sign</a>(<a class="code" href="classJson_1_1Value.html">Json::Value</a>& jv, <a class="code" href="classripple_1_1test_1_1jtx_1_1Account.html">Account</a> <span class="keyword">const</span>& account);</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="keywordtype">void</span></div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <a class="code" href="namespaceripple_1_1test_1_1jtx.html#af0d253b2a457f718afb2f60a08de91f7">fill_fee</a>(<a class="code" href="classJson_1_1Value.html">Json::Value</a>& jv, <a class="code" href="classripple_1_1ReadView.html">ReadView</a> <span class="keyword">const</span>& view);</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  </div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="keywordtype">void</span></div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <a class="code" href="namespaceripple_1_1test_1_1jtx.html#a3372cf5dcb5746304f6adfff517e746d">fill_seq</a>(<a class="code" href="classJson_1_1Value.html">Json::Value</a>& jv, <a class="code" href="classripple_1_1ReadView.html">ReadView</a> <span class="keyword">const</span>& view);</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  </div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <a class="code" href="classJson_1_1Value.html">Json::Value</a></div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <a class="code" href="namespaceripple_1_1test_1_1jtx.html#a145fb5e66071d636501a3aeae90f48f4">cmdToJSONRPC</a>(</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector<std::string></a> <span class="keyword">const</span>& args,</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <a class="code" href="classbeast_1_1Journal.html">beast::Journal</a> j,</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> apiVersion = <a class="code" href="namespaceripple_1_1RPC.html#a8c4c4528421d724a8a82db708b1a761b">RPC::apiMaximumSupportedVersion</a>);</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> } <span class="comment">// namespace jtx</span></div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> } <span class="comment">// namespace test</span></div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> } <span class="comment">// namespace ripple</span></div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  </div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="preprocessor">#endif</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="astructripple_1_1test_1_1jtx_1_1parse__error_html"><div class="ttname"><a href="structripple_1_1test_1_1jtx_1_1parse__error.html">ripple::test::jtx::parse_error</a></div><div class="ttdoc">Thrown when parse fails.</div><div class="ttdef"><b>Definition:</b> <a href="utility_8h_source.html#l00035">utility.h:35</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< std::string ></a></div></div>
|
|
<div class="ttc" id="anamespaceripple_1_1test_1_1jtx_html_a3372cf5dcb5746304f6adfff517e746d"><div class="ttname"><a href="namespaceripple_1_1test_1_1jtx.html#a3372cf5dcb5746304f6adfff517e746d">ripple::test::jtx::fill_seq</a></div><div class="ttdeci">void fill_seq(Json::Value &jv, ReadView const &view)</div><div class="ttdoc">Set the sequence number automatically.</div><div class="ttdef"><b>Definition:</b> <a href="utility_8cpp_source.html#l00065">utility.cpp:65</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_1_1test_1_1jtx_html_adc60f69b0b87ebebf13420f40738ff97"><div class="ttname"><a href="namespaceripple_1_1test_1_1jtx.html#adc60f69b0b87ebebf13420f40738ff97">ripple::test::jtx::sign</a></div><div class="ttdeci">void sign(Json::Value &jv, Account const &account)</div><div class="ttdoc">Sign automatically.</div><div class="ttdef"><b>Definition:</b> <a href="utility_8cpp_source.html#l00046">utility.cpp:46</a></div></div>
|
|
<div class="ttc" id="astdexcept_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/stdexcept.html">stdexcept</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_1_1test_1_1jtx_html_af0d253b2a457f718afb2f60a08de91f7"><div class="ttname"><a href="namespaceripple_1_1test_1_1jtx.html#af0d253b2a457f718afb2f60a08de91f7">ripple::test::jtx::fill_fee</a></div><div class="ttdeci">void fill_fee(Json::Value &jv, ReadView const &view)</div><div class="ttdoc">Set the fee automatically.</div><div class="ttdef"><b>Definition:</b> <a href="utility_8cpp_source.html#l00057">utility.cpp:57</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_1_1test_1_1jtx_html_a145fb5e66071d636501a3aeae90f48f4"><div class="ttname"><a href="namespaceripple_1_1test_1_1jtx.html#a145fb5e66071d636501a3aeae90f48f4">ripple::test::jtx::cmdToJSONRPC</a></div><div class="ttdeci">Json::Value cmdToJSONRPC(std::vector< std::string > const &args, beast::Journal j, unsigned int apiVersion)</div><div class="ttdoc">Given a rippled unit test rpc command, return the corresponding JSON.</div><div class="ttdef"><b>Definition:</b> <a href="utility_8cpp_source.html#l00079">utility.cpp:79</a></div></div>
|
|
<div class="ttc" id="alogic_error_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/error/logic_error.html">std::logic_error</a></div><div class="ttdoc">STL class.</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#l00058">Journal.h:58</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1STObject_html"><div class="ttname"><a href="classripple_1_1STObject.html">ripple::STObject</a></div><div class="ttdef"><b>Definition:</b> <a href="STObject_8h_source.html#l00052">STObject.h:52</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1ReadView_html"><div class="ttname"><a href="classripple_1_1ReadView.html">ripple::ReadView</a></div><div class="ttdoc">A view into a ledger.</div><div class="ttdef"><b>Definition:</b> <a href="ReadView_8h_source.html#l00054">ReadView.h:54</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="anamespaceripple_1_1RPC_html_a8c4c4528421d724a8a82db708b1a761b"><div class="ttname"><a href="namespaceripple_1_1RPC.html#a8c4c4528421d724a8a82db708b1a761b">ripple::RPC::apiMaximumSupportedVersion</a></div><div class="ttdeci">constexpr unsigned int apiMaximumSupportedVersion</div><div class="ttdef"><b>Definition:</b> <a href="RPCHelpers_8h_source.html#l00243">RPCHelpers.h:243</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1test_1_1jtx_1_1Account_html"><div class="ttname"><a href="classripple_1_1test_1_1jtx_1_1Account.html">ripple::test::jtx::Account</a></div><div class="ttdoc">Immutable cryptographic account descriptor.</div><div class="ttdef"><b>Definition:</b> <a href="Account_8h_source.html#l00037">Account.h:37</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_1_1test_1_1jtx_html_adebaab462b6c8ddf35410fb001d96256"><div class="ttname"><a href="namespaceripple_1_1test_1_1jtx.html#adebaab462b6c8ddf35410fb001d96256">ripple::test::jtx::parse</a></div><div class="ttdeci">STObject parse(Json::Value const &jv)</div><div class="ttdoc">Convert JSON to STObject.</div><div class="ttdef"><b>Definition:</b> <a href="utility_8cpp_source.html#l00037">utility.cpp:37</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#l00145">json_value.h:145</a></div></div>
|
|
<div class="ttc" id="astructripple_1_1test_1_1jtx_1_1parse__error_html_a331efe918052c83efea6ed80e41991bd"><div class="ttname"><a href="structripple_1_1test_1_1jtx_1_1parse__error.html#a331efe918052c83efea6ed80e41991bd">ripple::test::jtx::parse_error::parse_error</a></div><div class="ttdeci">parse_error(String const &s)</div><div class="ttdef"><b>Definition:</b> <a href="utility_8h_source.html#l00038">utility.h:38</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>
|