mirror of
https://github.com/XRPLF/rippled.git
synced 2025-12-06 17:27:55 +00:00
766 lines
47 KiB
HTML
766 lines
47 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">
|
|
<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::ManifestCache Class 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&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&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_1ManifestCache.html">ManifestCache</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pri-attribs">Private Attributes</a> |
|
|
<a href="classripple_1_1ManifestCache-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">ripple::ManifestCache Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Remembers manifests with the highest sequence number.
|
|
<a href="classripple_1_1ManifestCache.html#details">More...</a></p>
|
|
<div class="dynheader">
|
|
Collaboration diagram for ripple::ManifestCache:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classripple_1_1ManifestCache__coll__graph.png" border="0" usemap="#ripple_1_1ManifestCache_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="ripple_1_1ManifestCache_coll__map" id="ripple_1_1ManifestCache_coll__map">
|
|
<area shape="rect" title="Remembers manifests with the highest sequence number." alt="" coords="1093,179,1256,205"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/unordered_map.html" title=" " alt="" coords="637,5,789,61"/>
|
|
<area shape="rect" href="classripple_1_1PublicKey.html" title="A public key." alt="" coords="185,69,316,96"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/unordered_map.html" title=" " alt="" coords="840,164,992,220"/>
|
|
<area shape="rect" href="structripple_1_1Manifest.html" title=" " alt="" coords="451,179,573,205"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="5,44,100,71"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="9,95,97,121"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/thread/shared_mutex.html" title="STL class." alt="" coords="845,113,987,140"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/atomic/atomic.html" title=" " alt="" coords="609,260,816,287"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="199,249,302,276"/>
|
|
<area shape="rect" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title="STL class." alt="" coords="207,179,294,205"/>
|
|
<area shape="rect" href="classbeast_1_1Journal.html" title="A generic endpoint for log messages." alt="" coords="861,316,971,343"/>
|
|
<area shape="rect" href="classbeast_1_1Journal_1_1Sink.html" title="Abstraction for the underlying message destination." alt="" coords="439,320,585,347"/>
|
|
</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="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a2c088a5eb9f576fc06b07a5a91877093"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ManifestCache.html#a2c088a5eb9f576fc06b07a5a91877093">ManifestCache</a> (<a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> j=<a class="el" href="classbeast_1_1Journal.html">beast::Journal</a>(<a class="el" href="classbeast_1_1Journal.html#a930d70ff72f71414fcd5b560610cefb6">beast::Journal::getNullSink</a>()))</td></tr>
|
|
<tr class="separator:a2c088a5eb9f576fc06b07a5a91877093"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a55b2fe63f46ce104f2dffb351e792c79"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ManifestCache.html#a55b2fe63f46ce104f2dffb351e792c79">sequence</a> () const</td></tr>
|
|
<tr class="memdesc:a55b2fe63f46ce104f2dffb351e792c79"><td class="mdescLeft"> </td><td class="mdescRight">A monotonically increasing number used to detect new manifests. <a href="classripple_1_1ManifestCache.html#a55b2fe63f46ce104f2dffb351e792c79">More...</a><br /></td></tr>
|
|
<tr class="separator:a55b2fe63f46ce104f2dffb351e792c79"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8409a7089c3e04f972f1513a54576133"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1PublicKey.html">PublicKey</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ManifestCache.html#a8409a7089c3e04f972f1513a54576133">getSigningKey</a> (<a class="el" href="classripple_1_1PublicKey.html">PublicKey</a> const &pk) const</td></tr>
|
|
<tr class="memdesc:a8409a7089c3e04f972f1513a54576133"><td class="mdescLeft"> </td><td class="mdescRight">Returns master key's current signing key. <a href="classripple_1_1ManifestCache.html#a8409a7089c3e04f972f1513a54576133">More...</a><br /></td></tr>
|
|
<tr class="separator:a8409a7089c3e04f972f1513a54576133"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:adbe8167cfd5ac328a9bf8b85c319ddc1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1PublicKey.html">PublicKey</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ManifestCache.html#adbe8167cfd5ac328a9bf8b85c319ddc1">getMasterKey</a> (<a class="el" href="classripple_1_1PublicKey.html">PublicKey</a> const &pk) const</td></tr>
|
|
<tr class="memdesc:adbe8167cfd5ac328a9bf8b85c319ddc1"><td class="mdescLeft"> </td><td class="mdescRight">Returns ephemeral signing key's master public key. <a href="classripple_1_1ManifestCache.html#adbe8167cfd5ac328a9bf8b85c319ddc1">More...</a><br /></td></tr>
|
|
<tr class="separator:adbe8167cfd5ac328a9bf8b85c319ddc1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a093d015f0c2d38111f217ab167a3973d"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ManifestCache.html#a093d015f0c2d38111f217ab167a3973d">getSequence</a> (<a class="el" href="classripple_1_1PublicKey.html">PublicKey</a> const &pk) const</td></tr>
|
|
<tr class="memdesc:a093d015f0c2d38111f217ab167a3973d"><td class="mdescLeft"> </td><td class="mdescRight">Returns master key's current manifest sequence. <a href="classripple_1_1ManifestCache.html#a093d015f0c2d38111f217ab167a3973d">More...</a><br /></td></tr>
|
|
<tr class="separator:a093d015f0c2d38111f217ab167a3973d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae3996fe85083b04c4f568cd527a84dc8"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ManifestCache.html#ae3996fe85083b04c4f568cd527a84dc8">getDomain</a> (<a class="el" href="classripple_1_1PublicKey.html">PublicKey</a> const &pk) const</td></tr>
|
|
<tr class="memdesc:ae3996fe85083b04c4f568cd527a84dc8"><td class="mdescLeft"> </td><td class="mdescRight">Returns domain claimed by a given public key. <a href="classripple_1_1ManifestCache.html#ae3996fe85083b04c4f568cd527a84dc8">More...</a><br /></td></tr>
|
|
<tr class="separator:ae3996fe85083b04c4f568cd527a84dc8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4fd705df2aded2766ea1e5a98eb0ca74"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ManifestCache.html#a4fd705df2aded2766ea1e5a98eb0ca74">getManifest</a> (<a class="el" href="classripple_1_1PublicKey.html">PublicKey</a> const &pk) const</td></tr>
|
|
<tr class="memdesc:a4fd705df2aded2766ea1e5a98eb0ca74"><td class="mdescLeft"> </td><td class="mdescRight">Returns mainfest corresponding to a given public key. <a href="classripple_1_1ManifestCache.html#a4fd705df2aded2766ea1e5a98eb0ca74">More...</a><br /></td></tr>
|
|
<tr class="separator:a4fd705df2aded2766ea1e5a98eb0ca74"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6494e744b90cbecd735b460fcd7be82f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ManifestCache.html#a6494e744b90cbecd735b460fcd7be82f">revoked</a> (<a class="el" href="classripple_1_1PublicKey.html">PublicKey</a> const &pk) const</td></tr>
|
|
<tr class="memdesc:a6494e744b90cbecd735b460fcd7be82f"><td class="mdescLeft"> </td><td class="mdescRight">Returns <code>true</code> if master key has been revoked in a manifest. <a href="classripple_1_1ManifestCache.html#a6494e744b90cbecd735b460fcd7be82f">More...</a><br /></td></tr>
|
|
<tr class="separator:a6494e744b90cbecd735b460fcd7be82f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a882c588d2f26d7d61ae3ffe4212cbae0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#a8a16d6f665a032453ec4cbfca01929b6">ManifestDisposition</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ManifestCache.html#a882c588d2f26d7d61ae3ffe4212cbae0">applyManifest</a> (<a class="el" href="structripple_1_1Manifest.html">Manifest</a> m)</td></tr>
|
|
<tr class="memdesc:a882c588d2f26d7d61ae3ffe4212cbae0"><td class="mdescLeft"> </td><td class="mdescRight">Add manifest to cache. <a href="classripple_1_1ManifestCache.html#a882c588d2f26d7d61ae3ffe4212cbae0">More...</a><br /></td></tr>
|
|
<tr class="separator:a882c588d2f26d7d61ae3ffe4212cbae0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac42643e71e254d658a38a61a070864c6"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ManifestCache.html#ac42643e71e254d658a38a61a070864c6">load</a> (<a class="el" href="classripple_1_1DatabaseCon.html">DatabaseCon</a> &dbCon, <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &dbTable, <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &configManifest, <a class="elRef" href="http://en.cppreference.com/w/cpp/container/vector.html">std::vector</a>< <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> > const &configRevocation)</td></tr>
|
|
<tr class="memdesc:ac42643e71e254d658a38a61a070864c6"><td class="mdescLeft"> </td><td class="mdescRight">Populate manifest cache with manifests in database and config. <a href="classripple_1_1ManifestCache.html#ac42643e71e254d658a38a61a070864c6">More...</a><br /></td></tr>
|
|
<tr class="separator:ac42643e71e254d658a38a61a070864c6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aba96a3ca5f51243e21c858537ef16722"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ManifestCache.html#aba96a3ca5f51243e21c858537ef16722">load</a> (<a class="el" href="classripple_1_1DatabaseCon.html">DatabaseCon</a> &dbCon, <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &dbTable)</td></tr>
|
|
<tr class="memdesc:aba96a3ca5f51243e21c858537ef16722"><td class="mdescLeft"> </td><td class="mdescRight">Populate manifest cache with manifests in database. <a href="classripple_1_1ManifestCache.html#aba96a3ca5f51243e21c858537ef16722">More...</a><br /></td></tr>
|
|
<tr class="separator:aba96a3ca5f51243e21c858537ef16722"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad38243694bc875ac8bff27e7370ef307"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ManifestCache.html#ad38243694bc875ac8bff27e7370ef307">save</a> (<a class="el" href="classripple_1_1DatabaseCon.html">DatabaseCon</a> &dbCon, <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &dbTable, <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>< bool(<a class="el" href="classripple_1_1PublicKey.html">PublicKey</a> const &)> const &isTrusted)</td></tr>
|
|
<tr class="memdesc:ad38243694bc875ac8bff27e7370ef307"><td class="mdescLeft"> </td><td class="mdescRight">Save cached manifests to database. <a href="classripple_1_1ManifestCache.html#ad38243694bc875ac8bff27e7370ef307">More...</a><br /></td></tr>
|
|
<tr class="separator:ad38243694bc875ac8bff27e7370ef307"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7f05c967613f99e5f05af017673c6765"><td class="memTemplParams" colspan="2">template<class Function > </td></tr>
|
|
<tr class="memitem:a7f05c967613f99e5f05af017673c6765"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classripple_1_1ManifestCache.html#a7f05c967613f99e5f05af017673c6765">for_each_manifest</a> (Function &&f) const</td></tr>
|
|
<tr class="memdesc:a7f05c967613f99e5f05af017673c6765"><td class="mdescLeft"> </td><td class="mdescRight">Invokes the callback once for every populated manifest. <a href="classripple_1_1ManifestCache.html#a7f05c967613f99e5f05af017673c6765">More...</a><br /></td></tr>
|
|
<tr class="separator:a7f05c967613f99e5f05af017673c6765"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad2e75cff2c2f79664967d4c0f0bf8284"><td class="memTemplParams" colspan="2">template<class PreFun , class EachFun > </td></tr>
|
|
<tr class="memitem:ad2e75cff2c2f79664967d4c0f0bf8284"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classripple_1_1ManifestCache.html#ad2e75cff2c2f79664967d4c0f0bf8284">for_each_manifest</a> (PreFun &&pf, EachFun &&f) const</td></tr>
|
|
<tr class="memdesc:ad2e75cff2c2f79664967d4c0f0bf8284"><td class="mdescLeft"> </td><td class="mdescRight">Invokes the callback once for every populated manifest. <a href="classripple_1_1ManifestCache.html#ad2e75cff2c2f79664967d4c0f0bf8284">More...</a><br /></td></tr>
|
|
<tr class="separator:ad2e75cff2c2f79664967d4c0f0bf8284"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
|
|
Private Attributes</h2></td></tr>
|
|
<tr class="memitem:a78e50a3a9a3c02e82874340a07eaef5d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ManifestCache.html#a78e50a3a9a3c02e82874340a07eaef5d">j_</a></td></tr>
|
|
<tr class="separator:a78e50a3a9a3c02e82874340a07eaef5d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5c8a04996a9f90aa043d52e83db15935"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/thread/shared_mutex.html">std::shared_mutex</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ManifestCache.html#a5c8a04996a9f90aa043d52e83db15935">mutex_</a></td></tr>
|
|
<tr class="separator:a5c8a04996a9f90aa043d52e83db15935"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab2506c2817784a9f62f8ecf0f151fcf9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#a46c521271235f4e2715d7fa8b68940ca">hash_map</a>< <a class="el" href="classripple_1_1PublicKey.html">PublicKey</a>, <a class="el" href="structripple_1_1Manifest.html">Manifest</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ManifestCache.html#ab2506c2817784a9f62f8ecf0f151fcf9">map_</a></td></tr>
|
|
<tr class="memdesc:ab2506c2817784a9f62f8ecf0f151fcf9"><td class="mdescLeft"> </td><td class="mdescRight">Active manifests stored by master public key. <a href="classripple_1_1ManifestCache.html#ab2506c2817784a9f62f8ecf0f151fcf9">More...</a><br /></td></tr>
|
|
<tr class="separator:ab2506c2817784a9f62f8ecf0f151fcf9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a23063af048722db1bc29db23e2c86d0f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#a46c521271235f4e2715d7fa8b68940ca">hash_map</a>< <a class="el" href="classripple_1_1PublicKey.html">PublicKey</a>, <a class="el" href="classripple_1_1PublicKey.html">PublicKey</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ManifestCache.html#a23063af048722db1bc29db23e2c86d0f">signingToMasterKeys_</a></td></tr>
|
|
<tr class="memdesc:a23063af048722db1bc29db23e2c86d0f"><td class="mdescLeft"> </td><td class="mdescRight">Master public keys stored by current ephemeral public key. <a href="classripple_1_1ManifestCache.html#a23063af048722db1bc29db23e2c86d0f">More...</a><br /></td></tr>
|
|
<tr class="separator:a23063af048722db1bc29db23e2c86d0f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acfd2b0682f4ce9cafc0b643c332e053b"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/atomic/atomic.html">std::atomic</a>< <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ManifestCache.html#acfd2b0682f4ce9cafc0b643c332e053b">seq_</a> {0}</td></tr>
|
|
<tr class="separator:acfd2b0682f4ce9cafc0b643c332e053b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Remembers manifests with the highest sequence number. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Manifest_8h_source.html#l00231">231</a> of file <a class="el" href="Manifest_8h_source.html">Manifest.h</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a2c088a5eb9f576fc06b07a5a91877093"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2c088a5eb9f576fc06b07a5a91877093">◆ </a></span>ManifestCache()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">ripple::ManifestCache::ManifestCache </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> </td>
|
|
<td class="paramname"><em>j</em> = <code><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a>(<a class="el" href="classbeast_1_1Journal.html#a930d70ff72f71414fcd5b560610cefb6">beast::Journal::getNullSink</a>())</code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Manifest_8h_source.html#l00246">246</a> of file <a class="el" href="Manifest_8h_source.html">Manifest.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a55b2fe63f46ce104f2dffb351e792c79"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a55b2fe63f46ce104f2dffb351e792c79">◆ </a></span>sequence()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> ripple::ManifestCache::sequence </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>A monotonically increasing number used to detect new manifests. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Manifest_8h_source.html#l00254">254</a> of file <a class="el" href="Manifest_8h_source.html">Manifest.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8409a7089c3e04f972f1513a54576133"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8409a7089c3e04f972f1513a54576133">◆ </a></span>getSigningKey()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classripple_1_1PublicKey.html">PublicKey</a> ripple::ManifestCache::getSigningKey </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1PublicKey.html">PublicKey</a> const & </td>
|
|
<td class="paramname"><em>pk</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns master key's current signing key. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pk</td><td>Master public key</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>pk if no known signing key from a manifest</dd></dl>
|
|
<dl class="section user"><dt>Thread Safety</dt><dd></dd></dl>
|
|
<p>May be called concurrently </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="app_2misc_2impl_2Manifest_8cpp_source.html#l00291">291</a> of file <a class="el" href="app_2misc_2impl_2Manifest_8cpp_source.html">app/misc/impl/Manifest.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="adbe8167cfd5ac328a9bf8b85c319ddc1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adbe8167cfd5ac328a9bf8b85c319ddc1">◆ </a></span>getMasterKey()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classripple_1_1PublicKey.html">PublicKey</a> ripple::ManifestCache::getMasterKey </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1PublicKey.html">PublicKey</a> const & </td>
|
|
<td class="paramname"><em>pk</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns ephemeral signing key's master public key. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pk</td><td>Ephemeral signing public key</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>pk if signing key is not in a valid manifest</dd></dl>
|
|
<dl class="section user"><dt>Thread Safety</dt><dd></dd></dl>
|
|
<p>May be called concurrently </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="app_2misc_2impl_2Manifest_8cpp_source.html#l00303">303</a> of file <a class="el" href="app_2misc_2impl_2Manifest_8cpp_source.html">app/misc/impl/Manifest.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a093d015f0c2d38111f217ab167a3973d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a093d015f0c2d38111f217ab167a3973d">◆ </a></span>getSequence()</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>< <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> > ripple::ManifestCache::getSequence </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1PublicKey.html">PublicKey</a> const & </td>
|
|
<td class="paramname"><em>pk</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns master key's current manifest sequence. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>sequence corresponding to Master public key if configured or std::nullopt otherwise </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="app_2misc_2impl_2Manifest_8cpp_source.html#l00315">315</a> of file <a class="el" href="app_2misc_2impl_2Manifest_8cpp_source.html">app/misc/impl/Manifest.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae3996fe85083b04c4f568cd527a84dc8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae3996fe85083b04c4f568cd527a84dc8">◆ </a></span>getDomain()</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>< <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> > ripple::ManifestCache::getDomain </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1PublicKey.html">PublicKey</a> const & </td>
|
|
<td class="paramname"><em>pk</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns domain claimed by a given public key. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>domain corresponding to Master public key if present, otherwise std::nullopt </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="app_2misc_2impl_2Manifest_8cpp_source.html#l00327">327</a> of file <a class="el" href="app_2misc_2impl_2Manifest_8cpp_source.html">app/misc/impl/Manifest.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4fd705df2aded2766ea1e5a98eb0ca74"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4fd705df2aded2766ea1e5a98eb0ca74">◆ </a></span>getManifest()</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>< <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> > ripple::ManifestCache::getManifest </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1PublicKey.html">PublicKey</a> const & </td>
|
|
<td class="paramname"><em>pk</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns mainfest corresponding to a given public key. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>manifest corresponding to Master public key if present, otherwise std::nullopt </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="app_2misc_2impl_2Manifest_8cpp_source.html#l00339">339</a> of file <a class="el" href="app_2misc_2impl_2Manifest_8cpp_source.html">app/misc/impl/Manifest.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6494e744b90cbecd735b460fcd7be82f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6494e744b90cbecd735b460fcd7be82f">◆ </a></span>revoked()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ripple::ManifestCache::revoked </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1PublicKey.html">PublicKey</a> const & </td>
|
|
<td class="paramname"><em>pk</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns <code>true</code> if master key has been revoked in a manifest. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pk</td><td>Master public key</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section user"><dt>Thread Safety</dt><dd></dd></dl>
|
|
<p>May be called concurrently </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="app_2misc_2impl_2Manifest_8cpp_source.html#l00351">351</a> of file <a class="el" href="app_2misc_2impl_2Manifest_8cpp_source.html">app/misc/impl/Manifest.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a882c588d2f26d7d61ae3ffe4212cbae0"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a882c588d2f26d7d61ae3ffe4212cbae0">◆ </a></span>applyManifest()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceripple.html#a8a16d6f665a032453ec4cbfca01929b6">ManifestDisposition</a> ripple::ManifestCache::applyManifest </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structripple_1_1Manifest.html">Manifest</a> </td>
|
|
<td class="paramname"><em>m</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Add manifest to cache. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">m</td><td><a class="el" href="structripple_1_1Manifest.html">Manifest</a> to add</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><code><a class="el" href="namespaceripple.html#a8a16d6f665a032453ec4cbfca01929b6a3e4d891a5df3d6d0d7dd9432a1bc6470" title="Manifest is valid.">ManifestDisposition::accepted</a></code> if successful, or <code>stale</code> or <code>invalid</code> otherwise</dd></dl>
|
|
<dl class="section user"><dt>Thread Safety</dt><dd></dd></dl>
|
|
<p>May be called concurrently </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="app_2misc_2impl_2Manifest_8cpp_source.html#l00363">363</a> of file <a class="el" href="app_2misc_2impl_2Manifest_8cpp_source.html">app/misc/impl/Manifest.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac42643e71e254d658a38a61a070864c6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac42643e71e254d658a38a61a070864c6">◆ </a></span>load() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool ripple::ManifestCache::load </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1DatabaseCon.html">DatabaseCon</a> & </td>
|
|
<td class="paramname"><em>dbCon</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const & </td>
|
|
<td class="paramname"><em>dbTable</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const & </td>
|
|
<td class="paramname"><em>configManifest</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>< <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> > const & </td>
|
|
<td class="paramname"><em>configRevocation</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Populate manifest cache with manifests in database and config. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dbCon</td><td>Database connection with dbTable</td></tr>
|
|
<tr><td class="paramname">dbTable</td><td>Database table</td></tr>
|
|
<tr><td class="paramname">configManifest</td><td>Base64 encoded manifest for local node's validator keys</td></tr>
|
|
<tr><td class="paramname">configRevocation</td><td>Base64 encoded validator key revocation from the config</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section user"><dt>Thread Safety</dt><dd></dd></dl>
|
|
<p>May be called concurrently </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="app_2misc_2impl_2Manifest_8cpp_source.html#l00520">520</a> of file <a class="el" href="app_2misc_2impl_2Manifest_8cpp_source.html">app/misc/impl/Manifest.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aba96a3ca5f51243e21c858537ef16722"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aba96a3ca5f51243e21c858537ef16722">◆ </a></span>load() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ripple::ManifestCache::load </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1DatabaseCon.html">DatabaseCon</a> & </td>
|
|
<td class="paramname"><em>dbCon</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const & </td>
|
|
<td class="paramname"><em>dbTable</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Populate manifest cache with manifests in database. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dbCon</td><td>Database connection with dbTable</td></tr>
|
|
<tr><td class="paramname">dbTable</td><td>Database table</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section user"><dt>Thread Safety</dt><dd></dd></dl>
|
|
<p>May be called concurrently </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="app_2misc_2impl_2Manifest_8cpp_source.html#l00513">513</a> of file <a class="el" href="app_2misc_2impl_2Manifest_8cpp_source.html">app/misc/impl/Manifest.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad38243694bc875ac8bff27e7370ef307"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad38243694bc875ac8bff27e7370ef307">◆ </a></span>save()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ripple::ManifestCache::save </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classripple_1_1DatabaseCon.html">DatabaseCon</a> & </td>
|
|
<td class="paramname"><em>dbCon</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const & </td>
|
|
<td class="paramname"><em>dbTable</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>< bool(<a class="el" href="classripple_1_1PublicKey.html">PublicKey</a> const &)> const & </td>
|
|
<td class="paramname"><em>isTrusted</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Save cached manifests to database. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dbCon</td><td>Database connection with <code>ValidatorManifests</code> table</td></tr>
|
|
<tr><td class="paramname">isTrusted</td><td>Function that returns true if manifest is trusted</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section user"><dt>Thread Safety</dt><dd></dd></dl>
|
|
<p>May be called concurrently </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="app_2misc_2impl_2Manifest_8cpp_source.html#l00577">577</a> of file <a class="el" href="app_2misc_2impl_2Manifest_8cpp_source.html">app/misc/impl/Manifest.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a7f05c967613f99e5f05af017673c6765"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7f05c967613f99e5f05af017673c6765">◆ </a></span>for_each_manifest() <span class="overload">[1/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class Function > </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ripple::ManifestCache::for_each_manifest </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Function && </td>
|
|
<td class="paramname"><em>f</em></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Invokes the callback once for every populated manifest. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>Do not call <a class="el" href="classripple_1_1ManifestCache.html" title="Remembers manifests with the highest sequence number.">ManifestCache</a> member functions from within the callback. This can re-lock the mutex from the same thread, which is UB. </dd>
|
|
<dd>
|
|
Do not write <a class="el" href="classripple_1_1ManifestCache.html" title="Remembers manifests with the highest sequence number.">ManifestCache</a> member variables from within the callback. This can lead to data races.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">f</td><td>Function called for each manifest</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section user"><dt>Thread Safety</dt><dd></dd></dl>
|
|
<p>May be called concurrently </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Manifest_8h_source.html#l00401">401</a> of file <a class="el" href="Manifest_8h_source.html">Manifest.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad2e75cff2c2f79664967d4c0f0bf8284"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad2e75cff2c2f79664967d4c0f0bf8284">◆ </a></span>for_each_manifest() <span class="overload">[2/2]</span></h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<class PreFun , class EachFun > </div>
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void ripple::ManifestCache::for_each_manifest </td>
|
|
<td>(</td>
|
|
<td class="paramtype">PreFun && </td>
|
|
<td class="paramname"><em>pf</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">EachFun && </td>
|
|
<td class="paramname"><em>f</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Invokes the callback once for every populated manifest. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>Do not call <a class="el" href="classripple_1_1ManifestCache.html" title="Remembers manifests with the highest sequence number.">ManifestCache</a> member functions from within the callback. This can re-lock the mutex from the same thread, which is UB. </dd>
|
|
<dd>
|
|
Do not write <a class="el" href="classripple_1_1ManifestCache.html" title="Remembers manifests with the highest sequence number.">ManifestCache</a> member variables from within the callback. This can lead to data races.</dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">pf</td><td>Pre-function called with the maximum number of times f will be called (useful for memory allocations)</td></tr>
|
|
<tr><td class="paramname">f</td><td>Function called for each manifest</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section user"><dt>Thread Safety</dt><dd></dd></dl>
|
|
<p>May be called concurrently </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Manifest_8h_source.html#l00429">429</a> of file <a class="el" href="Manifest_8h_source.html">Manifest.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="a78e50a3a9a3c02e82874340a07eaef5d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a78e50a3a9a3c02e82874340a07eaef5d">◆ </a></span>j_</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> ripple::ManifestCache::j_</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Manifest_8h_source.html#l00234">234</a> of file <a class="el" href="Manifest_8h_source.html">Manifest.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5c8a04996a9f90aa043d52e83db15935"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5c8a04996a9f90aa043d52e83db15935">◆ </a></span>mutex_</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<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/thread/shared_mutex.html">std::shared_mutex</a> ripple::ManifestCache::mutex_</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">mutable</span><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Manifest_8h_source.html#l00235">235</a> of file <a class="el" href="Manifest_8h_source.html">Manifest.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab2506c2817784a9f62f8ecf0f151fcf9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab2506c2817784a9f62f8ecf0f151fcf9">◆ </a></span>map_</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceripple.html#a46c521271235f4e2715d7fa8b68940ca">hash_map</a><<a class="el" href="classripple_1_1PublicKey.html">PublicKey</a>, <a class="el" href="structripple_1_1Manifest.html">Manifest</a>> ripple::ManifestCache::map_</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Active manifests stored by master public key. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Manifest_8h_source.html#l00238">238</a> of file <a class="el" href="Manifest_8h_source.html">Manifest.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a23063af048722db1bc29db23e2c86d0f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a23063af048722db1bc29db23e2c86d0f">◆ </a></span>signingToMasterKeys_</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespaceripple.html#a46c521271235f4e2715d7fa8b68940ca">hash_map</a><<a class="el" href="classripple_1_1PublicKey.html">PublicKey</a>, <a class="el" href="classripple_1_1PublicKey.html">PublicKey</a>> ripple::ManifestCache::signingToMasterKeys_</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Master public keys stored by current ephemeral public key. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Manifest_8h_source.html#l00241">241</a> of file <a class="el" href="Manifest_8h_source.html">Manifest.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acfd2b0682f4ce9cafc0b643c332e053b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acfd2b0682f4ce9cafc0b643c332e053b">◆ </a></span>seq_</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<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/atomic/atomic.html">std::atomic</a><<a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a>> ripple::ManifestCache::seq_ {0}</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p class="definition">Definition at line <a class="el" href="Manifest_8h_source.html#l00243">243</a> of file <a class="el" href="Manifest_8h_source.html">Manifest.h</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|