ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-21 03:26:01 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
rippled/InboundTransactions_8h_source.html
bthomee 33451fdc96 deploy: 1d42c4f6de
2025-11-04 00:36:48 -08:00

170 lines
21 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: InboundTransactions.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_a62226f9e3a6c7c5a3be455e2f87ae01.html">xrpld</a></li><li class="navelem"><a class="el" href="dir_c69db3203fa08a9ff994909ba6ee9783.html">app</a></li><li class="navelem"><a class="el" href="dir_7899ad0c658a3b97a951171682eee0fc.html">ledger</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">InboundTransactions.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef XRPL_APP_LEDGER_INBOUNDTRANSACTIONS_H_INCLUDED</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XRPL_APP_LEDGER_INBOUNDTRANSACTIONS_H_INCLUDED</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;xrpld/overlay/Peer.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &lt;xrpl/beast/clock/abstract_clock.h&gt;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &lt;xrpl/shamap/SHAMap.h&gt;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/memory.html">memory</a>&gt;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="keyword">class </span>Application;</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
<div class="foldopen" id="foldopen00018" data-start="{" data-end="};">
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="classripple_1_1InboundTransactions.html"> 18</a></span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1InboundTransactions.html">InboundTransactions</a></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="keyword">public</span>:</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="classripple_1_1InboundTransactions.html#a7e983f1242289095a89311b17b72be0b"> 21</a></span> <span class="keyword">using </span><a class="code hl_class" href="classbeast_1_1abstract__clock.html">clock_type</a> = <a class="code hl_class" href="classbeast_1_1abstract__clock.html">beast::abstract_clock&lt;std::chrono::steady_clock&gt;</a>;</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"><a class="line" href="classripple_1_1InboundTransactions.html#a167c291e53d3dde1ce41fb449e24695d"> 23</a></span> <a class="code hl_function" href="classripple_1_1InboundTransactions.html#a167c291e53d3dde1ce41fb449e24695d">InboundTransactions</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="classripple_1_1InboundTransactions.html#a014a2b0795382cab7d089495d3bff277"> 24</a></span> <a class="code hl_function" href="classripple_1_1InboundTransactions.html#a014a2b0795382cab7d089495d3bff277">InboundTransactions</a>(<a class="code hl_class" href="classripple_1_1InboundTransactions.html">InboundTransactions</a> <span class="keyword">const</span>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <a class="code hl_class" href="classripple_1_1InboundTransactions.html">InboundTransactions</a>&amp;</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="classripple_1_1InboundTransactions.html#afc87c1bd8bf4e657f0a97d03a7bd2541"> 26</a></span> <a class="code hl_function" href="classripple_1_1InboundTransactions.html#afc87c1bd8bf4e657f0a97d03a7bd2541">operator=</a>(<a class="code hl_class" href="classripple_1_1InboundTransactions.html">InboundTransactions</a> <span class="keyword">const</span>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="classripple_1_1InboundTransactions.html#ad6c5e57253b9a0bd5e6a2b933f57752f"> 28</a></span> <span class="keyword">virtual</span> <a class="code hl_function" href="classripple_1_1InboundTransactions.html#ad6c5e57253b9a0bd5e6a2b933f57752f">~InboundTransactions</a>() = 0;</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">virtual</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr&lt;SHAMap&gt;</a></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="classripple_1_1InboundTransactions.html#a67558f8bcfc9b88ebc4a06f635515344"> 39</a></span> <a class="code hl_function" href="classripple_1_1InboundTransactions.html#a67558f8bcfc9b88ebc4a06f635515344">getSet</a>(<a class="code hl_class" href="classripple_1_1base__uint.html">uint256</a> <span class="keyword">const</span>&amp; setHash, <span class="keywordtype">bool</span> acquire) = 0;</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="classripple_1_1InboundTransactions.html#afc34365d8412a8ae51acc35b40c26295"> 48</a></span> <a class="code hl_function" href="classripple_1_1InboundTransactions.html#afc34365d8412a8ae51acc35b40c26295">gotData</a>(</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <a class="code hl_class" href="classripple_1_1base__uint.html">uint256</a> <span class="keyword">const</span>&amp; setHash,</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr&lt;Peer&gt;</a> peer,</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr&lt;protocol::TMLedgerData&gt;</a> message) = 0;</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> </div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"><a class="line" href="classripple_1_1InboundTransactions.html#aca94ada1bea94330fa6e7b1076d7952b"> 61</a></span> <a class="code hl_function" href="classripple_1_1InboundTransactions.html#aca94ada1bea94330fa6e7b1076d7952b">giveSet</a>(</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <a class="code hl_class" href="classripple_1_1base__uint.html">uint256</a> <span class="keyword">const</span>&amp; setHash,</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr&lt;SHAMap&gt;</a> <span class="keyword">const</span>&amp; set,</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> <span class="keywordtype">bool</span> acquired) = 0;</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> </div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"><a class="line" href="classripple_1_1InboundTransactions.html#a3226ecf56a2d2ac47514917082d55204"> 69</a></span> <a class="code hl_function" href="classripple_1_1InboundTransactions.html#a3226ecf56a2d2ac47514917082d55204">newRound</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> seq) = 0;</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> </div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> <span class="keyword">virtual</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"><a class="line" href="classripple_1_1InboundTransactions.html#a1aa456ca7047c1a43eb993d885ddb00e"> 72</a></span> <a class="code hl_function" href="classripple_1_1InboundTransactions.html#a1aa456ca7047c1a43eb993d885ddb00e">stop</a>() = 0;</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span>};</div>
</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> </div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr&lt;InboundTransactions&gt;</a></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span><a class="code hl_function" href="namespaceripple.html#a87ab8e956bac8394e11be28fb4e04406">make_InboundTransactions</a>(</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> <a class="code hl_class" href="classripple_1_1Application.html">Application</a>&amp; app,</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">beast::insight::Collector::ptr</a> <span class="keyword">const</span>&amp; collector,</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>&lt;<span class="keywordtype">void</span>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr&lt;SHAMap&gt;</a> <span class="keyword">const</span>&amp;, <span class="keywordtype">bool</span>)&gt; gotSet);</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> </div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> </div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassbeast_1_1abstract__clock_html"><div class="ttname"><a href="classbeast_1_1abstract__clock.html">beast::abstract_clock&lt; std::chrono::steady_clock &gt;</a></div></div>
<div class="ttc" id="aclassripple_1_1Application_html"><div class="ttname"><a href="classripple_1_1Application.html">ripple::Application</a></div><div class="ttdef"><b>Definition</b> <a href="Application_8h_source.html#l00094">Application.h:95</a></div></div>
<div class="ttc" id="aclassripple_1_1InboundTransactions_html"><div class="ttname"><a href="classripple_1_1InboundTransactions.html">ripple::InboundTransactions</a></div><div class="ttdoc">Manages the acquisition and lifetime of transaction sets.</div><div class="ttdef"><b>Definition</b> <a href="InboundTransactions_8h_source.html#l00018">InboundTransactions.h:19</a></div></div>
<div class="ttc" id="aclassripple_1_1InboundTransactions_html_a014a2b0795382cab7d089495d3bff277"><div class="ttname"><a href="classripple_1_1InboundTransactions.html#a014a2b0795382cab7d089495d3bff277">ripple::InboundTransactions::InboundTransactions</a></div><div class="ttdeci">InboundTransactions(InboundTransactions const &amp;)=delete</div></div>
<div class="ttc" id="aclassripple_1_1InboundTransactions_html_a167c291e53d3dde1ce41fb449e24695d"><div class="ttname"><a href="classripple_1_1InboundTransactions.html#a167c291e53d3dde1ce41fb449e24695d">ripple::InboundTransactions::InboundTransactions</a></div><div class="ttdeci">InboundTransactions()=default</div></div>
<div class="ttc" id="aclassripple_1_1InboundTransactions_html_a1aa456ca7047c1a43eb993d885ddb00e"><div class="ttname"><a href="classripple_1_1InboundTransactions.html#a1aa456ca7047c1a43eb993d885ddb00e">ripple::InboundTransactions::stop</a></div><div class="ttdeci">virtual void stop()=0</div></div>
<div class="ttc" id="aclassripple_1_1InboundTransactions_html_a3226ecf56a2d2ac47514917082d55204"><div class="ttname"><a href="classripple_1_1InboundTransactions.html#a3226ecf56a2d2ac47514917082d55204">ripple::InboundTransactions::newRound</a></div><div class="ttdeci">virtual void newRound(std::uint32_t seq)=0</div><div class="ttdoc">Informs the container if a new consensus round.</div></div>
<div class="ttc" id="aclassripple_1_1InboundTransactions_html_a67558f8bcfc9b88ebc4a06f635515344"><div class="ttname"><a href="classripple_1_1InboundTransactions.html#a67558f8bcfc9b88ebc4a06f635515344">ripple::InboundTransactions::getSet</a></div><div class="ttdeci">virtual std::shared_ptr&lt; SHAMap &gt; getSet(uint256 const &amp;setHash, bool acquire)=0</div><div class="ttdoc">Find and return a transaction set, or nullptr if it is missing.</div></div>
<div class="ttc" id="aclassripple_1_1InboundTransactions_html_aca94ada1bea94330fa6e7b1076d7952b"><div class="ttname"><a href="classripple_1_1InboundTransactions.html#aca94ada1bea94330fa6e7b1076d7952b">ripple::InboundTransactions::giveSet</a></div><div class="ttdeci">virtual void giveSet(uint256 const &amp;setHash, std::shared_ptr&lt; SHAMap &gt; const &amp;set, bool acquired)=0</div><div class="ttdoc">Add a transaction set.</div></div>
<div class="ttc" id="aclassripple_1_1InboundTransactions_html_ad6c5e57253b9a0bd5e6a2b933f57752f"><div class="ttname"><a href="classripple_1_1InboundTransactions.html#ad6c5e57253b9a0bd5e6a2b933f57752f">ripple::InboundTransactions::~InboundTransactions</a></div><div class="ttdeci">virtual ~InboundTransactions()=0</div></div>
<div class="ttc" id="aclassripple_1_1InboundTransactions_html_afc34365d8412a8ae51acc35b40c26295"><div class="ttname"><a href="classripple_1_1InboundTransactions.html#afc34365d8412a8ae51acc35b40c26295">ripple::InboundTransactions::gotData</a></div><div class="ttdeci">virtual void gotData(uint256 const &amp;setHash, std::shared_ptr&lt; Peer &gt; peer, std::shared_ptr&lt; protocol::TMLedgerData &gt; message)=0</div><div class="ttdoc">Add a transaction set from a LedgerData message.</div></div>
<div class="ttc" id="aclassripple_1_1InboundTransactions_html_afc87c1bd8bf4e657f0a97d03a7bd2541"><div class="ttname"><a href="classripple_1_1InboundTransactions.html#afc87c1bd8bf4e657f0a97d03a7bd2541">ripple::InboundTransactions::operator=</a></div><div class="ttdeci">InboundTransactions &amp; operator=(InboundTransactions const &amp;)=delete</div></div>
<div class="ttc" id="aclassripple_1_1base__uint_html"><div class="ttname"><a href="classripple_1_1base__uint.html">ripple::base_uint&lt; 256 &gt;</a></div></div>
<div class="ttc" id="afunction_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a></div></div>
<div class="ttc" id="ainteger_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a></div></div>
<div class="ttc" id="amemory_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/memory.html">memory</a></div></div>
<div class="ttc" id="anamespaceripple_html"><div class="ttname"><a href="namespaceripple.html">ripple</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition</b> <a href="algorithm_8h_source.html#l00006">algorithm.h:6</a></div></div>
<div class="ttc" id="anamespaceripple_html_a87ab8e956bac8394e11be28fb4e04406"><div class="ttname"><a href="namespaceripple.html#a87ab8e956bac8394e11be28fb4e04406">ripple::make_InboundTransactions</a></div><div class="ttdeci">std::unique_ptr&lt; InboundTransactions &gt; make_InboundTransactions(Application &amp;app, beast::insight::Collector::ptr const &amp;collector, std::function&lt; void(std::shared_ptr&lt; SHAMap &gt; const &amp;, bool)&gt; gotSet)</div><div class="ttdef"><b>Definition</b> <a href="InboundTransactions_8cpp_source.html#l00252">InboundTransactions.cpp:252</a></div></div>
<div class="ttc" id="ashared_ptr_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a></div></div>
<div class="ttc" id="aunique_ptr_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink