ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-12-06 17:27:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e2b7ef418d04a83b54b764be575c4400ca8e6dac
rippled/structripple_1_1StrandContext.html
bthomee e61ca37029 deploy: eac3abdca9
2025-01-21 19:58:08 +00:00

583 lines
37 KiB
HTML
Raw 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.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::StrandContext Struct Reference</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.5 -->
<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>
<!-- 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="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="structripple_1_1StrandContext.html">StrandContext</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structripple_1_1StrandContext-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::StrandContext Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Context needed to build Strand Steps and for error checking.
<a href="structripple_1_1StrandContext.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="Steps_8h_source.html">Steps.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ripple::StrandContext:</div>
<div class="dyncontent">
<div class="center"><img src="structripple_1_1StrandContext__coll__graph.png" border="0" usemap="#aripple_1_1StrandContext_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1StrandContext_coll__map" id="aripple_1_1StrandContext_coll__map">
<area shape="rect" title="Context needed to build Strand Steps and for error checking." alt="" coords="1193,226,1353,251"/>
<area shape="rect" href="classripple_1_1ReadView.html" title="A view into a ledger." alt="" coords="860,501,992,526"/>
<area shape="rect" href="classripple_1_1detail_1_1ReadViewFwdRange.html" title=" " alt="" coords="1180,493,1367,533"/>
<area shape="rect" href="classripple_1_1detail_1_1ReadViewFwdRange.html" title=" " alt="" coords="1185,620,1362,660"/>
<area shape="rect" href="structripple_1_1ReadView_1_1sles__type.html" title=" " alt="" coords="1416,458,1617,483"/>
<area shape="rect" href="structripple_1_1ReadView_1_1txs__type.html" title=" " alt="" coords="1419,575,1614,601"/>
<area shape="rect" href="classripple_1_1base__uint.html" title="Integers of any length that is a multiple of 32&#45;bits." alt="" coords="519,31,661,71"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="261,55,349,81"/>
<area shape="rect" href="classripple_1_1base__uint.html" title=" " alt="" coords="491,95,689,135"/>
<area shape="rect" href="classripple_1_1base__uint.html" title=" " alt="" coords="487,201,693,241"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/array.html" title=" " alt="" coords="221,199,389,239"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="5,206,108,231"/>
<area shape="rect" href="classripple_1_1Issue.html" title="A currency issued by an account." alt="" coords="875,99,977,125"/>
<area shape="rect" href="classripple_1_1AMMContext.html" title="Maintains AMM info per overall payment engine execution and individual iteration." alt="" coords="851,326,1001,351"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/utility/optional.html" title=" " alt="" coords="836,149,1016,174"/>
<area shape="rect" href="classripple_1_1Step.html" title="A step in a payment path." alt="" coords="878,198,974,223"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/array.html" title=" " alt="" coords="845,247,1007,302"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="543,277,637,302"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="539,326,641,351"/>
<area shape="rect" href="classbeast_1_1Journal.html" title="A generic endpoint for log messages." alt="" coords="871,375,981,401"/>
<area shape="rect" href="classbeast_1_1Journal_1_1Sink.html" title="Abstraction for the underlying message destination." alt="" coords="517,375,663,401"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a0be060a46bfa148f6d8e0ae61ac60c93"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1StrandContext.html#a0be060a46bfa148f6d8e0ae61ac60c93">StrandContext</a> (<a class="el" href="classripple_1_1ReadView.html">ReadView</a> const &amp;view_, <a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt; <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>&lt; <a class="el" href="classripple_1_1Step.html">Step</a> &gt; &gt; const &amp;strand_, <a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const &amp;strandSrc_, <a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const &amp;strandDst_, <a class="el" href="classripple_1_1Issue.html">Issue</a> const &amp;strandDeliver_, <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt; Quality &gt; const &amp;limitQuality_, bool isLast_, bool ownerPaysTransferFee_, <a class="el" href="namespaceripple.html#a786c40cb27211e1704047accb2ca26bd">OfferCrossing</a> offerCrossing_, bool isDefaultPath_, <a class="elRef" href="http://en.cppreference.com/w/cpp/container/array.html">std::array</a>&lt; boost::container::flat_set&lt; <a class="el" href="classripple_1_1Issue.html">Issue</a> &gt;, 2 &gt; &amp;seenDirectIssues_, boost::container::flat_set&lt; <a class="el" href="classripple_1_1Issue.html">Issue</a> &gt; &amp;seenBookOuts_, <a class="el" href="classripple_1_1AMMContext.html">AMMContext</a> &amp;ammContext_, <a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> j_)</td></tr>
<tr class="memdesc:a0be060a46bfa148f6d8e0ae61ac60c93"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="structripple_1_1StrandContext.html" title="Context needed to build Strand Steps and for error checking.">StrandContext</a> constructor. <a href="structripple_1_1StrandContext.html#a0be060a46bfa148f6d8e0ae61ac60c93">More...</a><br /></td></tr>
<tr class="separator:a0be060a46bfa148f6d8e0ae61ac60c93"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a0e059ee50baf7c62cfa1748b40f1092d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1ReadView.html">ReadView</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1StrandContext.html#a0e059ee50baf7c62cfa1748b40f1092d">view</a></td></tr>
<tr class="memdesc:a0e059ee50baf7c62cfa1748b40f1092d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Current <a class="el" href="classripple_1_1ReadView.html" title="A view into a ledger.">ReadView</a>. <a href="structripple_1_1StrandContext.html#a0e059ee50baf7c62cfa1748b40f1092d">More...</a><br /></td></tr>
<tr class="separator:a0e059ee50baf7c62cfa1748b40f1092d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d70df9585bd114fef1d5dcda3ee7280"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1StrandContext.html#a0d70df9585bd114fef1d5dcda3ee7280">strandSrc</a></td></tr>
<tr class="memdesc:a0d70df9585bd114fef1d5dcda3ee7280"><td class="mdescLeft">&#160;</td><td class="mdescRight">Strand source account. <a href="structripple_1_1StrandContext.html#a0d70df9585bd114fef1d5dcda3ee7280">More...</a><br /></td></tr>
<tr class="separator:a0d70df9585bd114fef1d5dcda3ee7280"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5d1a40124f3369767530ba3557d5994d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1StrandContext.html#a5d1a40124f3369767530ba3557d5994d">strandDst</a></td></tr>
<tr class="memdesc:a5d1a40124f3369767530ba3557d5994d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Strand destination account. <a href="structripple_1_1StrandContext.html#a5d1a40124f3369767530ba3557d5994d">More...</a><br /></td></tr>
<tr class="separator:a5d1a40124f3369767530ba3557d5994d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad73e9640d10c5af89e57dc6f65fc890"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1Issue.html">Issue</a> const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1StrandContext.html#aad73e9640d10c5af89e57dc6f65fc890">strandDeliver</a></td></tr>
<tr class="memdesc:aad73e9640d10c5af89e57dc6f65fc890"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classripple_1_1Issue.html" title="A currency issued by an account.">Issue</a> strand delivers. <a href="structripple_1_1StrandContext.html#aad73e9640d10c5af89e57dc6f65fc890">More...</a><br /></td></tr>
<tr class="separator:aad73e9640d10c5af89e57dc6f65fc890"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa5346c7dcbf9963a46c30ceedb7e5b86"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt; Quality &gt; const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1StrandContext.html#aa5346c7dcbf9963a46c30ceedb7e5b86">limitQuality</a></td></tr>
<tr class="memdesc:aa5346c7dcbf9963a46c30ceedb7e5b86"><td class="mdescLeft">&#160;</td><td class="mdescRight">Worst accepted quality. <a href="structripple_1_1StrandContext.html#aa5346c7dcbf9963a46c30ceedb7e5b86">More...</a><br /></td></tr>
<tr class="separator:aa5346c7dcbf9963a46c30ceedb7e5b86"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8348b69ccb12d4f42adcff1c747671c2"><td class="memItemLeft" align="right" valign="top">bool const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1StrandContext.html#a8348b69ccb12d4f42adcff1c747671c2">isFirst</a></td></tr>
<tr class="memdesc:a8348b69ccb12d4f42adcff1c747671c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">true if <a class="el" href="classripple_1_1Step.html" title="A step in a payment path.">Step</a> is first in Strand <a href="structripple_1_1StrandContext.html#a8348b69ccb12d4f42adcff1c747671c2">More...</a><br /></td></tr>
<tr class="separator:a8348b69ccb12d4f42adcff1c747671c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a92f0bbf8a41c47dc2adaf095ee3d38c0"><td class="memItemLeft" align="right" valign="top">bool const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1StrandContext.html#a92f0bbf8a41c47dc2adaf095ee3d38c0">isLast</a> = false</td></tr>
<tr class="memdesc:a92f0bbf8a41c47dc2adaf095ee3d38c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">true if <a class="el" href="classripple_1_1Step.html" title="A step in a payment path.">Step</a> is last in Strand <a href="structripple_1_1StrandContext.html#a92f0bbf8a41c47dc2adaf095ee3d38c0">More...</a><br /></td></tr>
<tr class="separator:a92f0bbf8a41c47dc2adaf095ee3d38c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3c162fa9856ab3be1951abb22ac2d57f"><td class="memItemLeft" align="right" valign="top">bool const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1StrandContext.html#a3c162fa9856ab3be1951abb22ac2d57f">ownerPaysTransferFee</a></td></tr>
<tr class="memdesc:a3c162fa9856ab3be1951abb22ac2d57f"><td class="mdescLeft">&#160;</td><td class="mdescRight">true if owner, not sender, pays fee <a href="structripple_1_1StrandContext.html#a3c162fa9856ab3be1951abb22ac2d57f">More...</a><br /></td></tr>
<tr class="separator:a3c162fa9856ab3be1951abb22ac2d57f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a823714e1b46346bde9898caac9c824d2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#a786c40cb27211e1704047accb2ca26bd">OfferCrossing</a> const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1StrandContext.html#a823714e1b46346bde9898caac9c824d2">offerCrossing</a></td></tr>
<tr class="memdesc:a823714e1b46346bde9898caac9c824d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Yes/Sell if offer crossing, not payment. <a href="structripple_1_1StrandContext.html#a823714e1b46346bde9898caac9c824d2">More...</a><br /></td></tr>
<tr class="separator:a823714e1b46346bde9898caac9c824d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a012ba7095985d961b9dcc6d7a1016732"><td class="memItemLeft" align="right" valign="top">bool const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1StrandContext.html#a012ba7095985d961b9dcc6d7a1016732">isDefaultPath</a></td></tr>
<tr class="memdesc:a012ba7095985d961b9dcc6d7a1016732"><td class="mdescLeft">&#160;</td><td class="mdescRight">true if Strand is default path <a href="structripple_1_1StrandContext.html#a012ba7095985d961b9dcc6d7a1016732">More...</a><br /></td></tr>
<tr class="separator:a012ba7095985d961b9dcc6d7a1016732"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09258816e4b43be8130db55952317cf0"><td class="memItemLeft" align="right" valign="top">size_t const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1StrandContext.html#a09258816e4b43be8130db55952317cf0">strandSize</a></td></tr>
<tr class="memdesc:a09258816e4b43be8130db55952317cf0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Length of Strand. <a href="structripple_1_1StrandContext.html#a09258816e4b43be8130db55952317cf0">More...</a><br /></td></tr>
<tr class="separator:a09258816e4b43be8130db55952317cf0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a20f852451e14c6cc04c3fbb5a49c41f6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1Step.html">Step</a> const *const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1StrandContext.html#a20f852451e14c6cc04c3fbb5a49c41f6">prevStep</a> = nullptr</td></tr>
<tr class="memdesc:a20f852451e14c6cc04c3fbb5a49c41f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">The previous step in the strand. <a href="structripple_1_1StrandContext.html#a20f852451e14c6cc04c3fbb5a49c41f6">More...</a><br /></td></tr>
<tr class="separator:a20f852451e14c6cc04c3fbb5a49c41f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f64547d1189ede6fef202ada9dc0f2b"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/array.html">std::array</a>&lt; boost::container::flat_set&lt; <a class="el" href="classripple_1_1Issue.html">Issue</a> &gt;, 2 &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1StrandContext.html#a1f64547d1189ede6fef202ada9dc0f2b">seenDirectIssues</a></td></tr>
<tr class="memdesc:a1f64547d1189ede6fef202ada9dc0f2b"><td class="mdescLeft">&#160;</td><td class="mdescRight">A strand may not include the same account node more than once in the same currency. <a href="structripple_1_1StrandContext.html#a1f64547d1189ede6fef202ada9dc0f2b">More...</a><br /></td></tr>
<tr class="separator:a1f64547d1189ede6fef202ada9dc0f2b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0bef921eb9b057dff6fa57d4bef62025"><td class="memItemLeft" align="right" valign="top">boost::container::flat_set&lt; <a class="el" href="classripple_1_1Issue.html">Issue</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1StrandContext.html#a0bef921eb9b057dff6fa57d4bef62025">seenBookOuts</a></td></tr>
<tr class="memdesc:a0bef921eb9b057dff6fa57d4bef62025"><td class="mdescLeft">&#160;</td><td class="mdescRight">A strand may not include an offer that output the same issue more than once. <a href="structripple_1_1StrandContext.html#a0bef921eb9b057dff6fa57d4bef62025">More...</a><br /></td></tr>
<tr class="separator:a0bef921eb9b057dff6fa57d4bef62025"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad518e54e6f8dd8bc666dd4066e4da31c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1AMMContext.html">AMMContext</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1StrandContext.html#ad518e54e6f8dd8bc666dd4066e4da31c">ammContext</a></td></tr>
<tr class="separator:ad518e54e6f8dd8bc666dd4066e4da31c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a09a7d44d440f4d4b4f89fd71aff64368"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> const&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1StrandContext.html#a09a7d44d440f4d4b4f89fd71aff64368">j</a></td></tr>
<tr class="separator:a09a7d44d440f4d4b4f89fd71aff64368"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Context needed to build Strand Steps and for error checking. </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00525">525</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a0be060a46bfa148f6d8e0ae61ac60c93" name="a0be060a46bfa148f6d8e0ae61ac60c93"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0be060a46bfa148f6d8e0ae61ac60c93">&#9670;&#160;</a></span>StrandContext()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::StrandContext::StrandContext </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1ReadView.html">ReadView</a> const &amp;&#160;</td>
<td class="paramname"><em>view_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>&lt; <a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>&lt; <a class="el" href="classripple_1_1Step.html">Step</a> &gt; &gt; const &amp;&#160;</td>
<td class="paramname"><em>strand_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const &amp;&#160;</td>
<td class="paramname"><em>strandSrc_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const &amp;&#160;</td>
<td class="paramname"><em>strandDst_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1Issue.html">Issue</a> const &amp;&#160;</td>
<td class="paramname"><em>strandDeliver_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt; Quality &gt; const &amp;&#160;</td>
<td class="paramname"><em>limitQuality_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>isLast_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>ownerPaysTransferFee_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceripple.html#a786c40cb27211e1704047accb2ca26bd">OfferCrossing</a>&#160;</td>
<td class="paramname"><em>offerCrossing_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>isDefaultPath_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/array.html">std::array</a>&lt; boost::container::flat_set&lt; <a class="el" href="classripple_1_1Issue.html">Issue</a> &gt;, 2 &gt; &amp;&#160;</td>
<td class="paramname"><em>seenDirectIssues_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">boost::container::flat_set&lt; <a class="el" href="classripple_1_1Issue.html">Issue</a> &gt; &amp;&#160;</td>
<td class="paramname"><em>seenBookOuts_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1AMMContext.html">AMMContext</a> &amp;&#160;</td>
<td class="paramname"><em>ammContext_</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a>&#160;</td>
<td class="paramname"><em>j_</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="structripple_1_1StrandContext.html" title="Context needed to build Strand Steps and for error checking.">StrandContext</a> constructor. </p>
<p >Journal for logging </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">seenDirectIssues_</td><td>For detecting currency loops</td></tr>
<tr><td class="paramname">seenBookOuts_</td><td>For detecting book loops </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="PaySteps_8cpp_source.html#l00582">582</a> of file <a class="el" href="PaySteps_8cpp_source.html">PaySteps.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a0e059ee50baf7c62cfa1748b40f1092d" name="a0e059ee50baf7c62cfa1748b40f1092d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e059ee50baf7c62cfa1748b40f1092d">&#9670;&#160;</a></span>view</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1ReadView.html">ReadView</a> const&amp; ripple::StrandContext::view</td>
</tr>
</table>
</div><div class="memdoc">
<p>Current <a class="el" href="classripple_1_1ReadView.html" title="A view into a ledger.">ReadView</a>. </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00527">527</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
<a id="a0d70df9585bd114fef1d5dcda3ee7280" name="a0d70df9585bd114fef1d5dcda3ee7280"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d70df9585bd114fef1d5dcda3ee7280">&#9670;&#160;</a></span>strandSrc</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const ripple::StrandContext::strandSrc</td>
</tr>
</table>
</div><div class="memdoc">
<p>Strand source account. </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00528">528</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
<a id="a5d1a40124f3369767530ba3557d5994d" name="a5d1a40124f3369767530ba3557d5994d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5d1a40124f3369767530ba3557d5994d">&#9670;&#160;</a></span>strandDst</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const ripple::StrandContext::strandDst</td>
</tr>
</table>
</div><div class="memdoc">
<p>Strand destination account. </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00529">529</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
<a id="aad73e9640d10c5af89e57dc6f65fc890" name="aad73e9640d10c5af89e57dc6f65fc890"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad73e9640d10c5af89e57dc6f65fc890">&#9670;&#160;</a></span>strandDeliver</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1Issue.html">Issue</a> const ripple::StrandContext::strandDeliver</td>
</tr>
</table>
</div><div class="memdoc">
<p><a class="el" href="classripple_1_1Issue.html" title="A currency issued by an account.">Issue</a> strand delivers. </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00530">530</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
<a id="aa5346c7dcbf9963a46c30ceedb7e5b86" name="aa5346c7dcbf9963a46c30ceedb7e5b86"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa5346c7dcbf9963a46c30ceedb7e5b86">&#9670;&#160;</a></span>limitQuality</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt;Quality&gt; const ripple::StrandContext::limitQuality</td>
</tr>
</table>
</div><div class="memdoc">
<p>Worst accepted quality. </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00531">531</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
<a id="a8348b69ccb12d4f42adcff1c747671c2" name="a8348b69ccb12d4f42adcff1c747671c2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8348b69ccb12d4f42adcff1c747671c2">&#9670;&#160;</a></span>isFirst</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool const ripple::StrandContext::isFirst</td>
</tr>
</table>
</div><div class="memdoc">
<p>true if <a class="el" href="classripple_1_1Step.html" title="A step in a payment path.">Step</a> is first in Strand </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00532">532</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
<a id="a92f0bbf8a41c47dc2adaf095ee3d38c0" name="a92f0bbf8a41c47dc2adaf095ee3d38c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a92f0bbf8a41c47dc2adaf095ee3d38c0">&#9670;&#160;</a></span>isLast</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool const ripple::StrandContext::isLast = false</td>
</tr>
</table>
</div><div class="memdoc">
<p>true if <a class="el" href="classripple_1_1Step.html" title="A step in a payment path.">Step</a> is last in Strand </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00533">533</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
<a id="a3c162fa9856ab3be1951abb22ac2d57f" name="a3c162fa9856ab3be1951abb22ac2d57f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3c162fa9856ab3be1951abb22ac2d57f">&#9670;&#160;</a></span>ownerPaysTransferFee</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool const ripple::StrandContext::ownerPaysTransferFee</td>
</tr>
</table>
</div><div class="memdoc">
<p>true if owner, not sender, pays fee </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00534">534</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
<a id="a823714e1b46346bde9898caac9c824d2" name="a823714e1b46346bde9898caac9c824d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a823714e1b46346bde9898caac9c824d2">&#9670;&#160;</a></span>offerCrossing</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceripple.html#a786c40cb27211e1704047accb2ca26bd">OfferCrossing</a> const ripple::StrandContext::offerCrossing</td>
</tr>
</table>
</div><div class="memdoc">
<p>Yes/Sell if offer crossing, not payment. </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00536">536</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
<a id="a012ba7095985d961b9dcc6d7a1016732" name="a012ba7095985d961b9dcc6d7a1016732"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a012ba7095985d961b9dcc6d7a1016732">&#9670;&#160;</a></span>isDefaultPath</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool const ripple::StrandContext::isDefaultPath</td>
</tr>
</table>
</div><div class="memdoc">
<p>true if Strand is default path </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00537">537</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
<a id="a09258816e4b43be8130db55952317cf0" name="a09258816e4b43be8130db55952317cf0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a09258816e4b43be8130db55952317cf0">&#9670;&#160;</a></span>strandSize</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t const ripple::StrandContext::strandSize</td>
</tr>
</table>
</div><div class="memdoc">
<p>Length of Strand. </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00538">538</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
<a id="a20f852451e14c6cc04c3fbb5a49c41f6" name="a20f852451e14c6cc04c3fbb5a49c41f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a20f852451e14c6cc04c3fbb5a49c41f6">&#9670;&#160;</a></span>prevStep</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1Step.html">Step</a> const* const ripple::StrandContext::prevStep = nullptr</td>
</tr>
</table>
</div><div class="memdoc">
<p>The previous step in the strand. </p>
<p >Needed to check the no ripple constraint </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00542">542</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
<a id="a1f64547d1189ede6fef202ada9dc0f2b" name="a1f64547d1189ede6fef202ada9dc0f2b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1f64547d1189ede6fef202ada9dc0f2b">&#9670;&#160;</a></span>seenDirectIssues</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/array.html">std::array</a>&lt;boost::container::flat_set&lt;<a class="el" href="classripple_1_1Issue.html">Issue</a>&gt;, 2&gt;&amp; ripple::StrandContext::seenDirectIssues</td>
</tr>
</table>
</div><div class="memdoc">
<p>A strand may not include the same account node more than once in the same currency. </p>
<p >In a direct step, an account will show up at most twice: once as a src and once as a dst (hence the two element array). The strandSrc and strandDst will only show up once each. </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00548">548</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
<a id="a0bef921eb9b057dff6fa57d4bef62025" name="a0bef921eb9b057dff6fa57d4bef62025"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0bef921eb9b057dff6fa57d4bef62025">&#9670;&#160;</a></span>seenBookOuts</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boost::container::flat_set&lt;<a class="el" href="classripple_1_1Issue.html">Issue</a>&gt;&amp; ripple::StrandContext::seenBookOuts</td>
</tr>
</table>
</div><div class="memdoc">
<p>A strand may not include an offer that output the same issue more than once. </p>
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00552">552</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
<a id="ad518e54e6f8dd8bc666dd4066e4da31c" name="ad518e54e6f8dd8bc666dd4066e4da31c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad518e54e6f8dd8bc666dd4066e4da31c">&#9670;&#160;</a></span>ammContext</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1AMMContext.html">AMMContext</a>&amp; ripple::StrandContext::ammContext</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00553">553</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
<a id="a09a7d44d440f4d4b4f89fd71aff64368" name="a09a7d44d440f4d4b4f89fd71aff64368"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a09a7d44d440f4d4b4f89fd71aff64368">&#9670;&#160;</a></span>j</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> const ripple::StrandContext::j</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00554">554</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
</div>
</div>
</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.5
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink