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

151 lines
15 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: check.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">check.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_TEST_JTX_CHECK_H_INCLUDED</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XRPL_TEST_JTX_CHECK_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;test/jtx/Account.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;test/jtx/Env.h&gt;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &lt;test/jtx/owners.h&gt;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="keyword">namespace </span>test {</div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="keyword">namespace </span>jtx {</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> </div>
<div class="foldopen" id="foldopen00013" data-start="{" data-end="}">
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="namespaceripple_1_1test_1_1jtx_1_1check.html"> 13</a></span><span class="keyword">namespace </span>check {</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><a class="code hl_function" href="namespaceripple_1_1test_1_1jtx_1_1check.html#ae71d096a3ebaf2a7a9e5816cd705e63c">cash</a>(<a class="code hl_class" href="classripple_1_1test_1_1jtx_1_1Account.html">jtx::Account</a> <span class="keyword">const</span>&amp; dest, <a class="code hl_class" href="classripple_1_1base__uint.html">uint256</a> <span class="keyword">const</span>&amp; checkId, <a class="code hl_class" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>&amp; amount);</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> </div>
<div class="foldopen" id="foldopen00020" data-start="{" data-end="};">
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="structripple_1_1test_1_1jtx_1_1check_1_1DeliverMin.html"> 20</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structripple_1_1test_1_1jtx_1_1check_1_1DeliverMin.html">DeliverMin</a></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span>{</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="structripple_1_1test_1_1jtx_1_1check_1_1DeliverMin.html#add17edf71bb5122de44c391946964951"> 22</a></span> <a class="code hl_class" href="classripple_1_1STAmount.html">STAmount</a> <a class="code hl_variable" href="structripple_1_1test_1_1jtx_1_1check_1_1DeliverMin.html#add17edf71bb5122de44c391946964951">value</a>;</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="structripple_1_1test_1_1jtx_1_1check_1_1DeliverMin.html#a92a29febce152ff1ba2b820499f95dbd"> 23</a></span> <span class="keyword">explicit</span> <a class="code hl_function" href="structripple_1_1test_1_1jtx_1_1check_1_1DeliverMin.html#a92a29febce152ff1ba2b820499f95dbd">DeliverMin</a>(<a class="code hl_class" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>&amp; deliverMin) : <a class="code hl_variable" href="structripple_1_1test_1_1jtx_1_1check_1_1DeliverMin.html#add17edf71bb5122de44c391946964951">value</a>(deliverMin)</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> }</div>
</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span>};</div>
</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><a class="code hl_function" href="namespaceripple_1_1test_1_1jtx_1_1check.html#ae71d096a3ebaf2a7a9e5816cd705e63c">cash</a>(</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <a class="code hl_class" href="classripple_1_1test_1_1jtx_1_1Account.html">jtx::Account</a> <span class="keyword">const</span>&amp; dest,</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <a class="code hl_class" href="classripple_1_1base__uint.html">uint256</a> <span class="keyword">const</span>&amp; checkId,</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> DeliverMin <span class="keyword">const</span>&amp; atLeast);</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><a class="code hl_function" href="namespaceripple_1_1test_1_1jtx_1_1check.html#a2d3a894a7ac4d177a05437a83718d0ac">cancel</a>(<a class="code hl_class" href="classripple_1_1test_1_1jtx_1_1Account.html">jtx::Account</a> <span class="keyword">const</span>&amp; dest, <a class="code hl_class" href="classripple_1_1base__uint.html">uint256</a> <span class="keyword">const</span>&amp; checkId);</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span>} <span class="comment">// namespace check</span></div>
</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="namespaceripple_1_1test_1_1jtx.html#aa8ee6dedc82e3189cd3f5c02e463168c"> 42</a></span><span class="keyword">using </span><a class="code hl_class" href="classripple_1_1test_1_1jtx_1_1owner__count.html">checks</a> = <a class="code hl_class" href="classripple_1_1test_1_1jtx_1_1owner__count.html">owner_count&lt;ltCHECK&gt;</a>;</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"> 44</span>} <span class="comment">// namespace jtx</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"> 46</span>} <span class="comment">// namespace test</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</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="aclassripple_1_1STAmount_html"><div class="ttname"><a href="classripple_1_1STAmount.html">ripple::STAmount</a></div><div class="ttdef"><b>Definition</b> <a href="STAmount_8h_source.html#l00030">STAmount.h:31</a></div></div>
<div class="ttc" id="aclassripple_1_1base__uint_html"><div class="ttname"><a href="classripple_1_1base__uint.html">ripple::base_uint&lt; 256 &gt;</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#l00019">Account.h:20</a></div></div>
<div class="ttc" id="aclassripple_1_1test_1_1jtx_1_1owner__count_html"><div class="ttname"><a href="classripple_1_1test_1_1jtx_1_1owner__count.html">ripple::test::jtx::owner_count</a></div><div class="ttdef"><b>Definition</b> <a href="owners_8h_source.html#l00033">owners.h:34</a></div></div>
<div class="ttc" id="anamespaceripple_1_1test_1_1jtx_1_1check_html_a2d3a894a7ac4d177a05437a83718d0ac"><div class="ttname"><a href="namespaceripple_1_1test_1_1jtx_1_1check.html#a2d3a894a7ac4d177a05437a83718d0ac">ripple::test::jtx::check::cancel</a></div><div class="ttdeci">Json::Value cancel(jtx::Account const &amp;dest, uint256 const &amp;checkId)</div><div class="ttdoc">Cancel a check.</div><div class="ttdef"><b>Definition</b> <a href="check_8cpp_source.html#l00041">check.cpp:41</a></div></div>
<div class="ttc" id="anamespaceripple_1_1test_1_1jtx_1_1check_html_ae71d096a3ebaf2a7a9e5816cd705e63c"><div class="ttname"><a href="namespaceripple_1_1test_1_1jtx_1_1check.html#ae71d096a3ebaf2a7a9e5816cd705e63c">ripple::test::jtx::check::cash</a></div><div class="ttdeci">Json::Value cash(jtx::Account const &amp;dest, uint256 const &amp;checkId, STAmount const &amp;amount)</div><div class="ttdoc">Cash a check requiring that a specific amount be delivered.</div><div class="ttdef"><b>Definition</b> <a href="check_8cpp_source.html#l00014">check.cpp:14</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="astructripple_1_1test_1_1jtx_1_1check_1_1DeliverMin_html"><div class="ttname"><a href="structripple_1_1test_1_1jtx_1_1check_1_1DeliverMin.html">ripple::test::jtx::check::DeliverMin</a></div><div class="ttdoc">Type used to specify DeliverMin for cashing a check.</div><div class="ttdef"><b>Definition</b> <a href="check_8h_source.html#l00020">check.h:21</a></div></div>
<div class="ttc" id="astructripple_1_1test_1_1jtx_1_1check_1_1DeliverMin_html_a92a29febce152ff1ba2b820499f95dbd"><div class="ttname"><a href="structripple_1_1test_1_1jtx_1_1check_1_1DeliverMin.html#a92a29febce152ff1ba2b820499f95dbd">ripple::test::jtx::check::DeliverMin::DeliverMin</a></div><div class="ttdeci">DeliverMin(STAmount const &amp;deliverMin)</div><div class="ttdef"><b>Definition</b> <a href="check_8h_source.html#l00023">check.h:23</a></div></div>
<div class="ttc" id="astructripple_1_1test_1_1jtx_1_1check_1_1DeliverMin_html_add17edf71bb5122de44c391946964951"><div class="ttname"><a href="structripple_1_1test_1_1jtx_1_1check_1_1DeliverMin.html#add17edf71bb5122de44c391946964951">ripple::test::jtx::check::DeliverMin::value</a></div><div class="ttdeci">STAmount value</div><div class="ttdef"><b>Definition</b> <a href="check_8h_source.html#l00022">check.h:22</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