Files
rippled/delegate_8h_source.html
2025-12-11 08:55:10 -08:00

156 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" 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: delegate.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_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">delegate.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">#pragma once</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include &lt;test/jtx/Account.h&gt;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;test/jtx/Env.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacexrpl.html">xrpl</a> {</div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="keyword">namespace </span>test {</div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="keyword">namespace </span>jtx {</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="foldopen" id="foldopen00010" data-start="{" data-end="}">
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"><a class="line" href="namespacexrpl_1_1test_1_1jtx_1_1delegate.html"> 10</a></span><span class="keyword">namespace </span>delegate {</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><a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><a class="code hl_function" href="namespacexrpl.html#a0ad5d92e6f6f18567bbdf6cae19f1fcd">set</a>(<a class="code hl_class" href="classxrpl_1_1test_1_1jtx_1_1Account.html">jtx::Account</a> <span class="keyword">const</span>&amp; account,</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> <a class="code hl_class" href="classxrpl_1_1test_1_1jtx_1_1Account.html">jtx::Account</a> <span class="keyword">const</span>&amp; authorize,</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector&lt;std::string&gt;</a> <span class="keyword">const</span>&amp; permissions);</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><a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><a class="code hl_function" href="namespacexrpl_1_1test_1_1jtx_1_1delegate.html#ab3d35016fa6d78a25d4eef2fa2d80cce">entry</a>(</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <a class="code hl_class" href="classxrpl_1_1test_1_1jtx_1_1Env.html">jtx::Env</a>&amp; env,</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <a class="code hl_class" href="classxrpl_1_1test_1_1jtx_1_1Account.html">jtx::Account</a> <span class="keyword">const</span>&amp; account,</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <a class="code hl_class" href="classxrpl_1_1test_1_1jtx_1_1Account.html">jtx::Account</a> <span class="keyword">const</span>&amp; authorize);</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="foldopen" id="foldopen00023" data-start="{" data-end="};">
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="structxrpl_1_1test_1_1jtx_1_1delegate_1_1as.html"> 23</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structxrpl_1_1test_1_1jtx_1_1delegate_1_1as.html">as</a></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span>{</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="structxrpl_1_1test_1_1jtx_1_1delegate_1_1as.html#a04b3a10e2c10898274c89b10eb74f66e"> 26</a></span> <a class="code hl_class" href="classxrpl_1_1test_1_1jtx_1_1Account.html">jtx::Account</a> <a class="code hl_variable" href="structxrpl_1_1test_1_1jtx_1_1delegate_1_1as.html#a04b3a10e2c10898274c89b10eb74f66e">delegate_</a>;</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="keyword">public</span>:</div>
<div class="foldopen" id="foldopen00029" data-start="{" data-end="}">
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="structxrpl_1_1test_1_1jtx_1_1delegate_1_1as.html#a26b627b0df4a3f4149c1b01fd0c21c15"> 29</a></span> <span class="keyword">explicit</span> <a class="code hl_function" href="structxrpl_1_1test_1_1jtx_1_1delegate_1_1as.html#a26b627b0df4a3f4149c1b01fd0c21c15">as</a>(<a class="code hl_class" href="classxrpl_1_1test_1_1jtx_1_1Account.html">jtx::Account</a> <span class="keyword">const</span>&amp; account) : <a class="code hl_variable" href="structxrpl_1_1test_1_1jtx_1_1delegate_1_1as.html#a04b3a10e2c10898274c89b10eb74f66e">delegate_</a>(account)</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> {</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> }</div>
</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keywordtype">void</span></div>
<div class="foldopen" id="foldopen00034" data-start="{" data-end="}">
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="structxrpl_1_1test_1_1jtx_1_1delegate_1_1as.html#a70d00ccfbfc513771f8c036bcc94ae3c"> 34</a></span> <a class="code hl_function" href="structxrpl_1_1test_1_1jtx_1_1delegate_1_1as.html#a70d00ccfbfc513771f8c036bcc94ae3c">operator()</a>(<a class="code hl_class" href="classxrpl_1_1test_1_1jtx_1_1Env.html">jtx::Env</a>&amp;, <a class="code hl_struct" href="structxrpl_1_1test_1_1jtx_1_1JTx.html">jtx::JTx</a>&amp; jtx)<span class="keyword"> const</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> jtx.<a class="code hl_variable" href="structxrpl_1_1test_1_1jtx_1_1JTx.html#afc49774451e206763c989c483a1b418a">jv</a>[sfDelegate.jsonName] = <a class="code hl_variable" href="structxrpl_1_1test_1_1jtx_1_1delegate_1_1as.html#a04b3a10e2c10898274c89b10eb74f66e">delegate_</a>.<a class="code hl_function" href="classxrpl_1_1test_1_1jtx_1_1Account.html#a26a750f85953905d4d29b1477a38ea37">human</a>();</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> }</div>
</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span>};</div>
</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="comment">// namespace delegate</span></div>
</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span>} <span class="comment">// namespace jtx</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span>} <span class="comment">// namespace test</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span>} <span class="comment">// namespace xrpl</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="aclassxrpl_1_1test_1_1jtx_1_1Account_html"><div class="ttname"><a href="classxrpl_1_1test_1_1jtx_1_1Account.html">xrpl::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#l00019">Account.h:20</a></div></div>
<div class="ttc" id="aclassxrpl_1_1test_1_1jtx_1_1Account_html_a26a750f85953905d4d29b1477a38ea37"><div class="ttname"><a href="classxrpl_1_1test_1_1jtx_1_1Account.html#a26a750f85953905d4d29b1477a38ea37">xrpl::test::jtx::Account::human</a></div><div class="ttdeci">std::string const &amp; human() const</div><div class="ttdoc">Returns the human readable public key.</div><div class="ttdef"><b>Definition</b> <a href="Account_8h_source.html#l00099">Account.h:99</a></div></div>
<div class="ttc" id="aclassxrpl_1_1test_1_1jtx_1_1Env_html"><div class="ttname"><a href="classxrpl_1_1test_1_1jtx_1_1Env.html">xrpl::test::jtx::Env</a></div><div class="ttdoc">A transaction testing environment.</div><div class="ttdef"><b>Definition</b> <a href="Env_8h_source.html#l00101">Env.h:102</a></div></div>
<div class="ttc" id="anamespacexrpl_1_1test_1_1jtx_1_1delegate_html_ab3d35016fa6d78a25d4eef2fa2d80cce"><div class="ttname"><a href="namespacexrpl_1_1test_1_1jtx_1_1delegate.html#ab3d35016fa6d78a25d4eef2fa2d80cce">xrpl::test::jtx::delegate::entry</a></div><div class="ttdeci">Json::Value entry(jtx::Env &amp;env, jtx::Account const &amp;account, jtx::Account const &amp;authorize)</div><div class="ttdef"><b>Definition</b> <a href="delegate_8cpp_source.html#l00036">delegate.cpp:36</a></div></div>
<div class="ttc" id="anamespacexrpl_html"><div class="ttname"><a href="namespacexrpl.html">xrpl</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="anamespacexrpl_html_a0ad5d92e6f6f18567bbdf6cae19f1fcd"><div class="ttname"><a href="namespacexrpl.html#a0ad5d92e6f6f18567bbdf6cae19f1fcd">xrpl::set</a></div><div class="ttdeci">bool set(T &amp;target, std::string const &amp;name, Section const &amp;section)</div><div class="ttdoc">Set a value from a configuration Section If the named value is not found or doesn't parse as a T,...</div><div class="ttdef"><b>Definition</b> <a href="BasicConfig_8h_source.html#l00296">BasicConfig.h:296</a></div></div>
<div class="ttc" id="astructxrpl_1_1test_1_1jtx_1_1JTx_html"><div class="ttname"><a href="structxrpl_1_1test_1_1jtx_1_1JTx.html">xrpl::test::jtx::JTx</a></div><div class="ttdoc">Execution context for applying a JSON transaction.</div><div class="ttdef"><b>Definition</b> <a href="JTx_8h_source.html#l00025">JTx.h:26</a></div></div>
<div class="ttc" id="astructxrpl_1_1test_1_1jtx_1_1JTx_html_afc49774451e206763c989c483a1b418a"><div class="ttname"><a href="structxrpl_1_1test_1_1jtx_1_1JTx.html#afc49774451e206763c989c483a1b418a">xrpl::test::jtx::JTx::jv</a></div><div class="ttdeci">Json::Value jv</div><div class="ttdef"><b>Definition</b> <a href="JTx_8h_source.html#l00027">JTx.h:27</a></div></div>
<div class="ttc" id="astructxrpl_1_1test_1_1jtx_1_1delegate_1_1as_html"><div class="ttname"><a href="structxrpl_1_1test_1_1jtx_1_1delegate_1_1as.html">xrpl::test::jtx::delegate::as</a></div><div class="ttdef"><b>Definition</b> <a href="delegate_8h_source.html#l00023">delegate.h:24</a></div></div>
<div class="ttc" id="astructxrpl_1_1test_1_1jtx_1_1delegate_1_1as_html_a04b3a10e2c10898274c89b10eb74f66e"><div class="ttname"><a href="structxrpl_1_1test_1_1jtx_1_1delegate_1_1as.html#a04b3a10e2c10898274c89b10eb74f66e">xrpl::test::jtx::delegate::as::delegate_</a></div><div class="ttdeci">jtx::Account delegate_</div><div class="ttdef"><b>Definition</b> <a href="delegate_8h_source.html#l00026">delegate.h:26</a></div></div>
<div class="ttc" id="astructxrpl_1_1test_1_1jtx_1_1delegate_1_1as_html_a26b627b0df4a3f4149c1b01fd0c21c15"><div class="ttname"><a href="structxrpl_1_1test_1_1jtx_1_1delegate_1_1as.html#a26b627b0df4a3f4149c1b01fd0c21c15">xrpl::test::jtx::delegate::as::as</a></div><div class="ttdeci">as(jtx::Account const &amp;account)</div><div class="ttdef"><b>Definition</b> <a href="delegate_8h_source.html#l00029">delegate.h:29</a></div></div>
<div class="ttc" id="astructxrpl_1_1test_1_1jtx_1_1delegate_1_1as_html_a70d00ccfbfc513771f8c036bcc94ae3c"><div class="ttname"><a href="structxrpl_1_1test_1_1jtx_1_1delegate_1_1as.html#a70d00ccfbfc513771f8c036bcc94ae3c">xrpl::test::jtx::delegate::as::operator()</a></div><div class="ttdeci">void operator()(jtx::Env &amp;, jtx::JTx &amp;jtx) const</div><div class="ttdef"><b>Definition</b> <a href="delegate_8h_source.html#l00034">delegate.h:34</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>