mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-21 03:26:01 +00:00
170 lines
18 KiB
HTML
170 lines
18 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: 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&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&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&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="comment">//------------------------------------------------------------------------------</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">/*</span></div>
|
|
<div class="line"><a id="l00003" 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 id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> Copyright (c) 2019 Ripple Labs Inc.</span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00006" 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 id="l00007" 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 id="l00008" 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 id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00010" 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 id="l00011" 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 id="l00012" 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 id="l00013" 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 id="l00014" 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 id="l00015" 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 id="l00016" 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 id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">*/</span></div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">//==============================================================================</span></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><span class="preprocessor">#ifndef RIPPLE_TEST_JTX_CHECK_H_INCLUDED</span></div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#define RIPPLE_TEST_JTX_CHECK_H_INCLUDED</span></div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include <test/jtx/Account.h></span></div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include <test/jtx/Env.h></span></div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include <test/jtx/owners.h></span></div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="keyword">namespace </span>test {</div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="keyword">namespace </span>jtx {</div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</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="namespaceripple_1_1test_1_1jtx_1_1check.html"> 32</a></span><span class="keyword">namespace </span>check {</div>
|
|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a></div>
|
|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</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>& dest, <a class="code hl_class" href="classripple_1_1base__uint.html">uint256</a> <span class="keyword">const</span>& checkId, <a class="code hl_class" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>& amount);</div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
|
|
<div class="foldopen" id="foldopen00039" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="structripple_1_1test_1_1jtx_1_1check_1_1DeliverMin.html"> 39</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="l00040" name="l00040"></a><span class="lineno"> 40</span>{</div>
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="structripple_1_1test_1_1jtx_1_1check_1_1DeliverMin.html#add17edf71bb5122de44c391946964951"> 41</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="foldopen00042" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="structripple_1_1test_1_1jtx_1_1check_1_1DeliverMin.html#a92a29febce152ff1ba2b820499f95dbd"> 42</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>& 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="l00043" name="l00043"></a><span class="lineno"> 43</span> {</div>
|
|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> }</div>
|
|
</div>
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span>};</div>
|
|
</div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
|
|
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a></div>
|
|
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><a class="code hl_function" href="namespaceripple_1_1test_1_1jtx_1_1check.html#ae71d096a3ebaf2a7a9e5816cd705e63c">cash</a>(</div>
|
|
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <a class="code hl_class" href="classripple_1_1test_1_1jtx_1_1Account.html">jtx::Account</a> <span class="keyword">const</span>& dest,</div>
|
|
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <a class="code hl_class" href="classripple_1_1base__uint.html">uint256</a> <span class="keyword">const</span>& checkId,</div>
|
|
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> DeliverMin <span class="keyword">const</span>& atLeast);</div>
|
|
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div>
|
|
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><a class="code hl_class" href="classJson_1_1Value.html">Json::Value</a></div>
|
|
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</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>& dest, <a class="code hl_class" href="classripple_1_1base__uint.html">uint256</a> <span class="keyword">const</span>& checkId);</div>
|
|
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div>
|
|
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span>} <span class="comment">// namespace check</span></div>
|
|
</div>
|
|
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> </div>
|
|
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"><a class="line" href="namespaceripple_1_1test_1_1jtx.html#aa8ee6dedc82e3189cd3f5c02e463168c"> 61</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<ltCHECK></a>;</div>
|
|
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> </div>
|
|
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span>} <span class="comment">// namespace jtx</span></div>
|
|
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> </div>
|
|
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span>} <span class="comment">// namespace test</span></div>
|
|
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span>} <span class="comment">// namespace ripple</span></div>
|
|
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> </div>
|
|
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</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#l00148">json_value.h:149</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#l00049">STAmount.h:50</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< 256 ></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#l00038">Account.h:39</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#l00052">owners.h:53</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 &dest, uint256 const &checkId)</div><div class="ttdoc">Cancel a check.</div><div class="ttdef"><b>Definition</b> <a href="check_8cpp_source.html#l00060">check.cpp:60</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 &dest, uint256 const &checkId, STAmount const &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#l00033">check.cpp:33</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#l00025">algorithm.h:25</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#l00039">check.h:40</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 &deliverMin)</div><div class="ttdef"><b>Definition</b> <a href="check_8h_source.html#l00042">check.h:42</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#l00041">check.h:41</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <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>
|