Files
rippled/Import_8h_source.html
2025-11-04 00:36:48 -08:00

144 lines
14 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: Import.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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_0103a8ad82dcc2c51f5cde661b4b5cb7.html">xrpl</a></li><li class="navelem"><a class="el" href="dir_68f79f171b7159941f300783854c1b48.html">resource</a></li><li class="navelem"><a class="el" href="dir_83cc80d895ddee2dee79c9a486487346.html">detail</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">Import.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_RESOURCE_IMPORT_H_INCLUDED</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XRPL_RESOURCE_IMPORT_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;xrpl/resource/Consumer.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;xrpl/resource/detail/Entry.h&gt;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="keyword">namespace </span>Resource {</div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="foldopen" id="foldopen00011" data-start="{" data-end="};">
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"><a class="line" href="structripple_1_1Resource_1_1Import.html"> 11</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structripple_1_1Resource_1_1Import.html">Import</a></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span>{</div>
<div class="foldopen" id="foldopen00013" data-start="{" data-end="};">
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="structripple_1_1Resource_1_1Import_1_1Item.html"> 13</a></span> <span class="keyword">struct </span><a class="code hl_struct" href="structripple_1_1Resource_1_1Import_1_1Item.html">Item</a></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> {</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="structripple_1_1Resource_1_1Import_1_1Item.html#a80cac8b0a5a4e9529e07f71caea028b9"> 15</a></span> <span class="keyword">explicit</span> <a class="code hl_function" href="structripple_1_1Resource_1_1Import_1_1Item.html#a80cac8b0a5a4e9529e07f71caea028b9">Item</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="structripple_1_1Resource_1_1Import_1_1Item.html#a57c30c59038c92c9cff4b3d291dd38e5"> 17</a></span> <span class="keywordtype">int</span> <a class="code hl_variable" href="structripple_1_1Resource_1_1Import_1_1Item.html#a57c30c59038c92c9cff4b3d291dd38e5">balance</a>;</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="structripple_1_1Resource_1_1Import_1_1Item.html#aa6de5d7c0a723a5c87524f68225974c5"> 18</a></span> <a class="code hl_class" href="classripple_1_1Resource_1_1Consumer.html">Consumer</a> <a class="code hl_variable" href="structripple_1_1Resource_1_1Import_1_1Item.html#aa6de5d7c0a723a5c87524f68225974c5">consumer</a>;</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> };</div>
</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <span class="comment">// Dummy argument required for zero-copy construction</span></div>
<div class="foldopen" id="foldopen00022" data-start="{" data-end="}">
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="structripple_1_1Resource_1_1Import.html#a527971b2d0fa797451caa8115069b824"> 22</a></span> <a class="code hl_function" href="structripple_1_1Resource_1_1Import.html#a527971b2d0fa797451caa8115069b824">Import</a>(<span class="keywordtype">int</span> = 0) : <a class="code hl_variable" href="structripple_1_1Resource_1_1Import.html#aea7cc5f53d609fcf9507cc9cd2ac03de">whenExpires</a>()</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> {</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> }</div>
</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <span class="comment">// When the imported data expires</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="structripple_1_1Resource_1_1Import.html#aea7cc5f53d609fcf9507cc9cd2ac03de"> 27</a></span> <a class="code hl_typedef" href="classbeast_1_1abstract__clock.html#a4e16832b0bdf9392c5138bbbde024d8e">clock_type::time_point</a> <a class="code hl_variable" href="structripple_1_1Resource_1_1Import.html#aea7cc5f53d609fcf9507cc9cd2ac03de">whenExpires</a>;</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="comment">// List of remote entries</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"><a class="line" href="structripple_1_1Resource_1_1Import.html#a24407aead5c02447020ec73c3d88a379"> 30</a></span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector&lt;Item&gt;</a> <a class="code hl_variable" href="structripple_1_1Resource_1_1Import.html#a24407aead5c02447020ec73c3d88a379">items</a>;</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span>};</div>
</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span>} <span class="comment">// namespace Resource</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassbeast_1_1abstract__clock_html_a4e16832b0bdf9392c5138bbbde024d8e"><div class="ttname"><a href="classbeast_1_1abstract__clock.html#a4e16832b0bdf9392c5138bbbde024d8e">beast::abstract_clock&lt; std::chrono::steady_clock &gt;::time_point</a></div><div class="ttdeci">typename Clock::time_point time_point</div><div class="ttdef"><b>Definition</b> <a href="abstract__clock_8h_source.html#l00041">abstract_clock.h:41</a></div></div>
<div class="ttc" id="aclassripple_1_1Resource_1_1Consumer_html"><div class="ttname"><a href="classripple_1_1Resource_1_1Consumer.html">ripple::Resource::Consumer</a></div><div class="ttdoc">An endpoint that consumes resources.</div><div class="ttdef"><b>Definition</b> <a href="Consumer_8h_source.html#l00016">Consumer.h:17</a></div></div>
<div class="ttc" id="anamespaceripple_html"><div class="ttname"><a href="namespaceripple.html">ripple</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition</b> <a href="algorithm_8h_source.html#l00006">algorithm.h:6</a></div></div>
<div class="ttc" id="astructripple_1_1Resource_1_1Import_1_1Item_html"><div class="ttname"><a href="structripple_1_1Resource_1_1Import_1_1Item.html">ripple::Resource::Import::Item</a></div><div class="ttdef"><b>Definition</b> <a href="Import_8h_source.html#l00013">Import.h:14</a></div></div>
<div class="ttc" id="astructripple_1_1Resource_1_1Import_1_1Item_html_a57c30c59038c92c9cff4b3d291dd38e5"><div class="ttname"><a href="structripple_1_1Resource_1_1Import_1_1Item.html#a57c30c59038c92c9cff4b3d291dd38e5">ripple::Resource::Import::Item::balance</a></div><div class="ttdeci">int balance</div><div class="ttdef"><b>Definition</b> <a href="Import_8h_source.html#l00017">Import.h:17</a></div></div>
<div class="ttc" id="astructripple_1_1Resource_1_1Import_1_1Item_html_a80cac8b0a5a4e9529e07f71caea028b9"><div class="ttname"><a href="structripple_1_1Resource_1_1Import_1_1Item.html#a80cac8b0a5a4e9529e07f71caea028b9">ripple::Resource::Import::Item::Item</a></div><div class="ttdeci">Item()=default</div></div>
<div class="ttc" id="astructripple_1_1Resource_1_1Import_1_1Item_html_aa6de5d7c0a723a5c87524f68225974c5"><div class="ttname"><a href="structripple_1_1Resource_1_1Import_1_1Item.html#aa6de5d7c0a723a5c87524f68225974c5">ripple::Resource::Import::Item::consumer</a></div><div class="ttdeci">Consumer consumer</div><div class="ttdef"><b>Definition</b> <a href="Import_8h_source.html#l00018">Import.h:18</a></div></div>
<div class="ttc" id="astructripple_1_1Resource_1_1Import_html"><div class="ttname"><a href="structripple_1_1Resource_1_1Import.html">ripple::Resource::Import</a></div><div class="ttdoc">A set of imported consumer data from a gossip origin.</div><div class="ttdef"><b>Definition</b> <a href="Import_8h_source.html#l00011">Import.h:12</a></div></div>
<div class="ttc" id="astructripple_1_1Resource_1_1Import_html_a24407aead5c02447020ec73c3d88a379"><div class="ttname"><a href="structripple_1_1Resource_1_1Import.html#a24407aead5c02447020ec73c3d88a379">ripple::Resource::Import::items</a></div><div class="ttdeci">std::vector&lt; Item &gt; items</div><div class="ttdef"><b>Definition</b> <a href="Import_8h_source.html#l00030">Import.h:30</a></div></div>
<div class="ttc" id="astructripple_1_1Resource_1_1Import_html_a527971b2d0fa797451caa8115069b824"><div class="ttname"><a href="structripple_1_1Resource_1_1Import.html#a527971b2d0fa797451caa8115069b824">ripple::Resource::Import::Import</a></div><div class="ttdeci">Import(int=0)</div><div class="ttdef"><b>Definition</b> <a href="Import_8h_source.html#l00022">Import.h:22</a></div></div>
<div class="ttc" id="astructripple_1_1Resource_1_1Import_html_aea7cc5f53d609fcf9507cc9cd2ac03de"><div class="ttname"><a href="structripple_1_1Resource_1_1Import.html#aea7cc5f53d609fcf9507cc9cd2ac03de">ripple::Resource::Import::whenExpires</a></div><div class="ttdeci">clock_type::time_point whenExpires</div><div class="ttdef"><b>Definition</b> <a href="Import_8h_source.html#l00027">Import.h:27</a></div></div>
<div class="ttc" id="avector_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</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>