ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-26 05:55:51 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
a84d06b17d69754eb8af364182d5865ac35a05bc
rippled/classripple_1_1TOfferStreamBase.html
intelliot df089d923d deploy: 724a301599
2023-06-23 05:24:05 +00:00

708 lines
40 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">
<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: ripple::TOfferStreamBase&lt; TIn, TOut &gt; Class Template 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 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&amp;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&amp;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="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="classripple_1_1TOfferStreamBase.html">TOfferStreamBase</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classripple_1_1TOfferStreamBase-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ripple::TOfferStreamBase&lt; TIn, TOut &gt; Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for ripple::TOfferStreamBase&lt; TIn, TOut &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1TOfferStreamBase__inherit__graph.png" border="0" usemap="#ripple_1_1TOfferStreamBase_3_01TIn_00_01TOut_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="ripple_1_1TOfferStreamBase_3_01TIn_00_01TOut_01_4_inherit__map" id="ripple_1_1TOfferStreamBase_3_01TIn_00_01TOut_01_4_inherit__map">
<area shape="rect" title=" " alt="" coords="5,5,192,47"/>
<area shape="rect" href="classripple_1_1FlowOfferStream.html" title="Presents and consumes the offers in an order book." alt="" coords="11,95,187,136"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ripple::TOfferStreamBase&lt; TIn, TOut &gt;:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1TOfferStreamBase__coll__graph.png" border="0" usemap="#ripple_1_1TOfferStreamBase_3_01TIn_00_01TOut_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="ripple_1_1TOfferStreamBase_3_01TIn_00_01TOut_01_4_coll__map" id="ripple_1_1TOfferStreamBase_3_01TIn_00_01TOut_01_4_coll__map">
<area shape="rect" title=" " alt="" coords="2619,603,2805,645"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/utility/optional.html" title=" " alt="" coords="2299,208,2463,235"/>
<area shape="rect" href="classripple_1_1TOfferStreamBase_1_1StepCounter.html" title=" " alt="" coords="2282,673,2481,714"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="899,548,1002,575"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/array.html" title=" " alt="" coords="1147,519,1315,561"/>
<area shape="rect" href="classbeast_1_1Journal.html" title="A generic endpoint for log messages." alt="" coords="2031,736,2142,763"/>
<area shape="rect" href="classbeast_1_1Journal_1_1Sink.html" title="Abstraction for the underlying message destination." alt="" coords="1735,736,1881,763"/>
<area shape="rect" href="classripple_1_1BookTip.html" title="Iterates and consumes raw offers in an order book." alt="" coords="2321,259,2441,285"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="2001,169,2172,210"/>
<area shape="rect" href="classripple_1_1STLedgerEntry.html" title=" " alt="" coords="1727,171,1889,197"/>
<area shape="rect" href="classripple_1_1STObject.html" title=" " alt="" coords="1451,123,1577,149"/>
<area shape="rect" href="classripple_1_1STBase.html" title="A type which can be exported to a well known binary format." alt="" coords="626,144,741,171"/>
<area shape="rect" href="classripple_1_1detail_1_1STVar.html" title=" " alt="" coords="876,197,1025,224"/>
<area shape="rect" href="classripple_1_1SField.html" title="Identifies fields." alt="" coords="292,223,397,249"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/map.html" title=" " alt="" coords="605,261,761,302"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title="STL class." alt="" coords="28,197,115,224"/>
<area shape="rect" href="classJson_1_1StaticString.html" title="Lightweight wrapper to tag static string." alt="" coords="5,248,137,275"/>
<area shape="rect" href="classripple_1_1CountedObject.html" title=" " alt="" coords="1149,239,1312,281"/>
<area shape="rect" href="classripple_1_1SOTemplate.html" title="Defines the fields and their attributes within a STObject." alt="" coords="1158,64,1303,91"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="881,5,1020,32"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="879,57,1022,98"/>
<area shape="rect" href="classripple_1_1SOElement.html" title="An element in a SOTemplate." alt="" coords="614,64,753,91"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/utility/functional/reference_wrapper.html" title=" " alt="" coords="257,57,432,98"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/vector.html" title=" " alt="" coords="1159,174,1302,215"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/aligned_storage.html" title=" " alt="" coords="606,195,761,237"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="639,400,727,427"/>
<area shape="rect" href="classripple_1_1base__uint.html" title=" " alt="" coords="1443,281,1585,322"/>
<area shape="rect" href="classripple_1_1base__uint.html" title=" " alt="" coords="1415,603,1613,645"/>
<area shape="rect" href="classripple_1_1base__uint.html" title=" " alt="" coords="1411,519,1617,561"/>
<area shape="rect" href="classripple_1_1CountedObject.html" title=" " alt="" coords="1433,174,1595,215"/>
<area shape="rect" href="classripple_1_1ApplyView.html" title="Writeable view to a ledger, for applying a transaction." alt="" coords="2019,297,2155,324"/>
<area shape="rect" href="classripple_1_1ReadView.html" title="A view into a ledger." alt="" coords="1743,425,1873,452"/>
<area shape="rect" href="classripple_1_1detail_1_1ReadViewFwdRange.html" title=" " alt="" coords="1999,411,2175,467"/>
<area shape="rect" href="classripple_1_1detail_1_1ReadViewFwdRange.html" title=" " alt="" coords="1999,491,2175,533"/>
<area shape="rect" href="structripple_1_1ReadView_1_1sles__type.html" title=" " alt="" coords="2281,405,2481,432"/>
<area shape="rect" href="structripple_1_1ReadView_1_1txs__type.html" title=" " alt="" coords="2284,535,2479,561"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/chrono/time_point.html" title=" " alt="" coords="2295,811,2467,837"/>
<area shape="rect" href="classripple_1_1Book.html" title="Specifies an order book." alt="" coords="2037,620,2137,647"/>
<area shape="rect" href="classripple_1_1CountedObject.html" title=" " alt="" coords="1727,554,1889,595"/>
<area shape="rect" href="classripple_1_1Issue.html" title="A currency issued by an account." alt="" coords="1757,620,1859,647"/>
</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 name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TOfferStreamBase_1_1StepCounter.html">StepCounter</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a7790cf27c9173d5e4b7378d970ab8b0b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TOfferStreamBase.html#a7790cf27c9173d5e4b7378d970ab8b0b">TOfferStreamBase</a> (<a class="el" href="classripple_1_1ApplyView.html">ApplyView</a> &amp;view, <a class="el" href="classripple_1_1ApplyView.html">ApplyView</a> &amp;cancelView, <a class="el" href="classripple_1_1Book.html">Book</a> const &amp;book, <a class="el" href="classripple_1_1NetClock.html#a4c2428e178dca6689fa3fb4be0657107">NetClock::time_point</a> when, <a class="el" href="classripple_1_1TOfferStreamBase_1_1StepCounter.html">StepCounter</a> &amp;counter, <a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> journal)</td></tr>
<tr class="separator:a7790cf27c9173d5e4b7378d970ab8b0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a85a3c059578df4686974f7ae946fdd65"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TOfferStreamBase.html#a85a3c059578df4686974f7ae946fdd65">~TOfferStreamBase</a> ()=default</td></tr>
<tr class="separator:a85a3c059578df4686974f7ae946fdd65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b2dbfd4a3cfb6e68306c33d5ce9e38f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1TOffer.html">TOffer</a>&lt; TIn, TOut &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TOfferStreamBase.html#a8b2dbfd4a3cfb6e68306c33d5ce9e38f">tip</a> () const</td></tr>
<tr class="memdesc:a8b2dbfd4a3cfb6e68306c33d5ce9e38f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the offer at the tip of the order book. <a href="classripple_1_1TOfferStreamBase.html#a8b2dbfd4a3cfb6e68306c33d5ce9e38f">More...</a><br /></td></tr>
<tr class="separator:a8b2dbfd4a3cfb6e68306c33d5ce9e38f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4aeb5e78bbc94d5d899b40fd0bfa7620"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TOfferStreamBase.html#a4aeb5e78bbc94d5d899b40fd0bfa7620">step</a> ()</td></tr>
<tr class="memdesc:a4aeb5e78bbc94d5d899b40fd0bfa7620"><td class="mdescLeft">&#160;</td><td class="mdescRight">Advance to the next valid offer. <a href="classripple_1_1TOfferStreamBase.html#a4aeb5e78bbc94d5d899b40fd0bfa7620">More...</a><br /></td></tr>
<tr class="separator:a4aeb5e78bbc94d5d899b40fd0bfa7620"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae9be6ab3367fb465b76ac6e5b782c521"><td class="memItemLeft" align="right" valign="top">TOut&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TOfferStreamBase.html#ae9be6ab3367fb465b76ac6e5b782c521">ownerFunds</a> () const</td></tr>
<tr class="separator:ae9be6ab3367fb465b76ac6e5b782c521"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a3cc232612029eb43f6c1d31b994f9e82"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TOfferStreamBase.html#a3cc232612029eb43f6c1d31b994f9e82">erase</a> (<a class="el" href="classripple_1_1ApplyView.html">ApplyView</a> &amp;view)</td></tr>
<tr class="separator:a3cc232612029eb43f6c1d31b994f9e82"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af34ed892a7c78534069089b5674bbd78"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TOfferStreamBase.html#af34ed892a7c78534069089b5674bbd78">permRmOffer</a> (<a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const &amp;offerIndex)=0</td></tr>
<tr class="separator:af34ed892a7c78534069089b5674bbd78"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae524b906f0b6ef4decc4b80ca119ae55"><td class="memTemplParams" colspan="2">template&lt;class TTakerPays , class TTakerGets &gt; </td></tr>
<tr class="memitem:ae524b906f0b6ef4decc4b80ca119ae55"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classripple_1_1TOfferStreamBase.html#ae524b906f0b6ef4decc4b80ca119ae55">shouldRmSmallIncreasedQOffer</a> () const</td></tr>
<tr class="separator:ae524b906f0b6ef4decc4b80ca119ae55"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:ae835f09d769e4f1de31320e3bb1ebf16"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classbeast_1_1Journal.html">beast::Journal</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TOfferStreamBase.html#ae835f09d769e4f1de31320e3bb1ebf16">j_</a></td></tr>
<tr class="separator:ae835f09d769e4f1de31320e3bb1ebf16"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af449d5f0f06f8e268a7d0274dec8fd48"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1ApplyView.html">ApplyView</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TOfferStreamBase.html#af449d5f0f06f8e268a7d0274dec8fd48">view_</a></td></tr>
<tr class="separator:af449d5f0f06f8e268a7d0274dec8fd48"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc5a54be6dbfd52054c07a38bfcde773"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1ApplyView.html">ApplyView</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TOfferStreamBase.html#abc5a54be6dbfd52054c07a38bfcde773">cancelView_</a></td></tr>
<tr class="separator:abc5a54be6dbfd52054c07a38bfcde773"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af83167468dc560f5d5040c876dc152fc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1Book.html">Book</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TOfferStreamBase.html#af83167468dc560f5d5040c876dc152fc">book_</a></td></tr>
<tr class="separator:af83167468dc560f5d5040c876dc152fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af309ba357560059a0030403bb01ddd33"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TOfferStreamBase.html#af309ba357560059a0030403bb01ddd33">validBook_</a></td></tr>
<tr class="separator:af309ba357560059a0030403bb01ddd33"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8a19629268098e601e4d40912d663583"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classripple_1_1NetClock.html#a4c2428e178dca6689fa3fb4be0657107">NetClock::time_point</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TOfferStreamBase.html#a8a19629268098e601e4d40912d663583">expire_</a></td></tr>
<tr class="separator:a8a19629268098e601e4d40912d663583"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5856a31c250db1ea34415327ba0b79aa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1BookTip.html">BookTip</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TOfferStreamBase.html#a5856a31c250db1ea34415327ba0b79aa">tip_</a></td></tr>
<tr class="separator:a5856a31c250db1ea34415327ba0b79aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a923068803dd65557f013b5f5bd759422"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1TOffer.html">TOffer</a>&lt; TIn, TOut &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TOfferStreamBase.html#a923068803dd65557f013b5f5bd759422">offer_</a></td></tr>
<tr class="separator:a923068803dd65557f013b5f5bd759422"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1df599d315b58e69d097dca5d3467c62"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt; TOut &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TOfferStreamBase.html#a1df599d315b58e69d097dca5d3467c62">ownerFunds_</a></td></tr>
<tr class="separator:a1df599d315b58e69d097dca5d3467c62"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb8cfbde268008870618dbf76176b975"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1TOfferStreamBase_1_1StepCounter.html">StepCounter</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1TOfferStreamBase.html#aeb8cfbde268008870618dbf76176b975">counter_</a></td></tr>
<tr class="separator:aeb8cfbde268008870618dbf76176b975"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class TIn, class TOut&gt;<br />
class ripple::TOfferStreamBase&lt; TIn, TOut &gt;</h3>
<p class="definition">Definition at line <a class="el" href="OfferStream_8h_source.html#l00036">36</a> of file <a class="el" href="OfferStream_8h_source.html">OfferStream.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a7790cf27c9173d5e4b7378d970ab8b0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7790cf27c9173d5e4b7378d970ab8b0b">&#9670;&nbsp;</a></span>TOfferStreamBase()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TIn , class TOut &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1TOfferStreamBase.html">ripple::TOfferStreamBase</a>&lt; TIn, TOut &gt;::<a class="el" href="classripple_1_1TOfferStreamBase.html">TOfferStreamBase</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1ApplyView.html">ApplyView</a> &amp;&#160;</td>
<td class="paramname"><em>view</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1ApplyView.html">ApplyView</a> &amp;&#160;</td>
<td class="paramname"><em>cancelView</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1Book.html">Book</a> const &amp;&#160;</td>
<td class="paramname"><em>book</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1NetClock.html#a4c2428e178dca6689fa3fb4be0657107">NetClock::time_point</a>&#160;</td>
<td class="paramname"><em>when</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1TOfferStreamBase_1_1StepCounter.html">StepCounter</a> &amp;&#160;</td>
<td class="paramname"><em>counter</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>journal</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="OfferStream_8cpp_source.html#l00038">38</a> of file <a class="el" href="OfferStream_8cpp_source.html">OfferStream.cpp</a>.</p>
</div>
</div>
<a id="a85a3c059578df4686974f7ae946fdd65"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a85a3c059578df4686974f7ae946fdd65">&#9670;&nbsp;</a></span>~TOfferStreamBase()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TIn , class TOut &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classripple_1_1TOfferStreamBase.html">ripple::TOfferStreamBase</a>&lt; TIn, TOut &gt;::~<a class="el" href="classripple_1_1TOfferStreamBase.html">TOfferStreamBase</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a3cc232612029eb43f6c1d31b994f9e82"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3cc232612029eb43f6c1d31b994f9e82">&#9670;&nbsp;</a></span>erase()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TIn , class TOut &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classripple_1_1TOfferStreamBase.html">ripple::TOfferStreamBase</a>&lt; TIn, TOut &gt;::erase </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1ApplyView.html">ApplyView</a> &amp;&#160;</td>
<td class="paramname"><em>view</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="OfferStream_8cpp_source.html#l00061">61</a> of file <a class="el" href="OfferStream_8cpp_source.html">OfferStream.cpp</a>.</p>
</div>
</div>
<a id="af34ed892a7c78534069089b5674bbd78"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af34ed892a7c78534069089b5674bbd78">&#9670;&nbsp;</a></span>permRmOffer()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TIn , class TOut &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void <a class="el" href="classripple_1_1TOfferStreamBase.html">ripple::TOfferStreamBase</a>&lt; TIn, TOut &gt;::permRmOffer </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> const &amp;&#160;</td>
<td class="paramname"><em>offerIndex</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implemented in <a class="el" href="classripple_1_1FlowOfferStream.html#a9940206ba76f1698cbbf2db11afa12d5">ripple::FlowOfferStream&lt; TIn, TOut &gt;</a>, and <a class="el" href="classripple_1_1OfferStream.html#ac1d8ec4a933ecd3986985d3231e278c2">ripple::OfferStream</a>.</p>
</div>
</div>
<a id="ae524b906f0b6ef4decc4b80ca119ae55"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae524b906f0b6ef4decc4b80ca119ae55">&#9670;&nbsp;</a></span>shouldRmSmallIncreasedQOffer()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TIn , class TOut &gt; </div>
<div class="memtemplate">
template&lt;class TTakerPays , class TTakerGets &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classripple_1_1TOfferStreamBase.html">ripple::TOfferStreamBase</a>&lt; TIn, TOut &gt;::shouldRmSmallIncreasedQOffer</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="OfferStream_8cpp_source.html#l00139">139</a> of file <a class="el" href="OfferStream_8cpp_source.html">OfferStream.cpp</a>.</p>
</div>
</div>
<a id="a8b2dbfd4a3cfb6e68306c33d5ce9e38f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b2dbfd4a3cfb6e68306c33d5ce9e38f">&#9670;&nbsp;</a></span>tip()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TIn , class TOut &gt; </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1TOffer.html">TOffer</a>&lt;TIn, TOut&gt;&amp; <a class="el" href="classripple_1_1TOfferStreamBase.html">ripple::TOfferStreamBase</a>&lt; TIn, TOut &gt;::tip </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the offer at the tip of the order book. </p>
<p>Offers are always presented in decreasing quality. Only valid if <a class="el" href="classripple_1_1TOfferStreamBase.html#a4aeb5e78bbc94d5d899b40fd0bfa7620" title="Advance to the next valid offer.">step()</a> returned <code>true</code>. </p>
<p class="definition">Definition at line <a class="el" href="OfferStream_8h_source.html#l00108">108</a> of file <a class="el" href="OfferStream_8h_source.html">OfferStream.h</a>.</p>
</div>
</div>
<a id="a4aeb5e78bbc94d5d899b40fd0bfa7620"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4aeb5e78bbc94d5d899b40fd0bfa7620">&#9670;&nbsp;</a></span>step()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TIn , class TOut &gt; </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classripple_1_1TOfferStreamBase.html">ripple::TOfferStreamBase</a>&lt; TIn, TOut &gt;::step</td>
</tr>
</table>
</div><div class="memdoc">
<p>Advance to the next valid offer. </p>
<p>This automatically removes:</p><ul>
<li>Offers with missing ledger entries</li>
<li>Offers found unfunded</li>
<li>expired offers <dl class="section return"><dt>Returns</dt><dd><code>true</code> if there is a valid offer. </dd></dl>
</li>
</ul>
<p class="definition">Definition at line <a class="el" href="OfferStream_8cpp_source.html#l00221">221</a> of file <a class="el" href="OfferStream_8cpp_source.html">OfferStream.cpp</a>.</p>
</div>
</div>
<a id="ae9be6ab3367fb465b76ac6e5b782c521"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae9be6ab3367fb465b76ac6e5b782c521">&#9670;&nbsp;</a></span>ownerFunds()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TIn , class TOut &gt; </div>
<table class="memname">
<tr>
<td class="memname">TOut <a class="el" href="classripple_1_1TOfferStreamBase.html">ripple::TOfferStreamBase</a>&lt; TIn, TOut &gt;::ownerFunds </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="OfferStream_8h_source.html#l00124">124</a> of file <a class="el" href="OfferStream_8h_source.html">OfferStream.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ae835f09d769e4f1de31320e3bb1ebf16"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae835f09d769e4f1de31320e3bb1ebf16">&#9670;&nbsp;</a></span>j_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TIn , class TOut &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> <a class="el" href="classripple_1_1TOfferStreamBase.html">ripple::TOfferStreamBase</a>&lt; TIn, TOut &gt;::j_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="OfferStream_8h_source.html#l00071">71</a> of file <a class="el" href="OfferStream_8h_source.html">OfferStream.h</a>.</p>
</div>
</div>
<a id="af449d5f0f06f8e268a7d0274dec8fd48"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af449d5f0f06f8e268a7d0274dec8fd48">&#9670;&nbsp;</a></span>view_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TIn , class TOut &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1ApplyView.html">ApplyView</a>&amp; <a class="el" href="classripple_1_1TOfferStreamBase.html">ripple::TOfferStreamBase</a>&lt; TIn, TOut &gt;::view_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="OfferStream_8h_source.html#l00072">72</a> of file <a class="el" href="OfferStream_8h_source.html">OfferStream.h</a>.</p>
</div>
</div>
<a id="abc5a54be6dbfd52054c07a38bfcde773"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abc5a54be6dbfd52054c07a38bfcde773">&#9670;&nbsp;</a></span>cancelView_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TIn , class TOut &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1ApplyView.html">ApplyView</a>&amp; <a class="el" href="classripple_1_1TOfferStreamBase.html">ripple::TOfferStreamBase</a>&lt; TIn, TOut &gt;::cancelView_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="OfferStream_8h_source.html#l00073">73</a> of file <a class="el" href="OfferStream_8h_source.html">OfferStream.h</a>.</p>
</div>
</div>
<a id="af83167468dc560f5d5040c876dc152fc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af83167468dc560f5d5040c876dc152fc">&#9670;&nbsp;</a></span>book_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TIn , class TOut &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1Book.html">Book</a> <a class="el" href="classripple_1_1TOfferStreamBase.html">ripple::TOfferStreamBase</a>&lt; TIn, TOut &gt;::book_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="OfferStream_8h_source.html#l00074">74</a> of file <a class="el" href="OfferStream_8h_source.html">OfferStream.h</a>.</p>
</div>
</div>
<a id="af309ba357560059a0030403bb01ddd33"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af309ba357560059a0030403bb01ddd33">&#9670;&nbsp;</a></span>validBook_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TIn , class TOut &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classripple_1_1TOfferStreamBase.html">ripple::TOfferStreamBase</a>&lt; TIn, TOut &gt;::validBook_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="OfferStream_8h_source.html#l00075">75</a> of file <a class="el" href="OfferStream_8h_source.html">OfferStream.h</a>.</p>
</div>
</div>
<a id="a8a19629268098e601e4d40912d663583"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8a19629268098e601e4d40912d663583">&#9670;&nbsp;</a></span>expire_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TIn , class TOut &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classripple_1_1NetClock.html#a4c2428e178dca6689fa3fb4be0657107">NetClock::time_point</a> <a class="el" href="classripple_1_1TOfferStreamBase.html">ripple::TOfferStreamBase</a>&lt; TIn, TOut &gt;::expire_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="OfferStream_8h_source.html#l00076">76</a> of file <a class="el" href="OfferStream_8h_source.html">OfferStream.h</a>.</p>
</div>
</div>
<a id="a5856a31c250db1ea34415327ba0b79aa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5856a31c250db1ea34415327ba0b79aa">&#9670;&nbsp;</a></span>tip_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TIn , class TOut &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1BookTip.html">BookTip</a> <a class="el" href="classripple_1_1TOfferStreamBase.html">ripple::TOfferStreamBase</a>&lt; TIn, TOut &gt;::tip_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="OfferStream_8h_source.html#l00077">77</a> of file <a class="el" href="OfferStream_8h_source.html">OfferStream.h</a>.</p>
</div>
</div>
<a id="a923068803dd65557f013b5f5bd759422"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a923068803dd65557f013b5f5bd759422">&#9670;&nbsp;</a></span>offer_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TIn , class TOut &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1TOffer.html">TOffer</a>&lt;TIn, TOut&gt; <a class="el" href="classripple_1_1TOfferStreamBase.html">ripple::TOfferStreamBase</a>&lt; TIn, TOut &gt;::offer_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="OfferStream_8h_source.html#l00078">78</a> of file <a class="el" href="OfferStream_8h_source.html">OfferStream.h</a>.</p>
</div>
</div>
<a id="a1df599d315b58e69d097dca5d3467c62"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1df599d315b58e69d097dca5d3467c62">&#9670;&nbsp;</a></span>ownerFunds_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TIn , class TOut &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt;TOut&gt; <a class="el" href="classripple_1_1TOfferStreamBase.html">ripple::TOfferStreamBase</a>&lt; TIn, TOut &gt;::ownerFunds_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="OfferStream_8h_source.html#l00079">79</a> of file <a class="el" href="OfferStream_8h_source.html">OfferStream.h</a>.</p>
</div>
</div>
<a id="aeb8cfbde268008870618dbf76176b975"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeb8cfbde268008870618dbf76176b975">&#9670;&nbsp;</a></span>counter_</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class TIn , class TOut &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1TOfferStreamBase_1_1StepCounter.html">StepCounter</a>&amp; <a class="el" href="classripple_1_1TOfferStreamBase.html">ripple::TOfferStreamBase</a>&lt; TIn, TOut &gt;::counter_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="OfferStream_8h_source.html#l00080">80</a> of file <a class="el" href="OfferStream_8h_source.html">OfferStream.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink