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

321 lines
18 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: ripple::ValidatorKeys 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 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>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="classripple_1_1ValidatorKeys.html">ValidatorKeys</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="#pub-attribs">Public Attributes</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classripple_1_1ValidatorKeys-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::ValidatorKeys Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Validator keys and manifest as set in configuration file.
<a href="classripple_1_1ValidatorKeys.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="ValidatorKeys_8h_source.html">ValidatorKeys.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ripple::ValidatorKeys:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1ValidatorKeys__coll__graph.png" border="0" usemap="#aripple_1_1ValidatorKeys_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1ValidatorKeys_coll__map" id="aripple_1_1ValidatorKeys_coll__map">
<area shape="rect" title="Validator keys and manifest as set in configuration file." alt="" coords="803,106,959,131"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/utility/optional.html" title=" " alt="" coords="511,5,685,45"/>
<area shape="poly" title=" " alt="" coords="677,47,780,80,845,103,844,108,778,85,676,52"/>
<area shape="rect" href="classripple_1_1base__uint.html" title=" " alt="" coords="504,69,692,109"/>
<area shape="poly" title=" " alt="" coords="706,98,803,108,802,113,706,103"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="261,19,349,45"/>
<area shape="poly" title=" " alt="" coords="363,41,504,68,503,74,362,46"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/array.html" title=" " alt="" coords="221,69,389,109"/>
<area shape="poly" title=" " alt="" coords="403,87,504,87,504,92,403,92"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="5,113,108,138"/>
<area shape="poly" title=" " alt="" coords="122,122,692,119,802,117,802,123,692,124,122,128"/>
<area shape="poly" title=" " alt="" coords="121,113,221,99,222,104,122,119"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="555,187,641,213"/>
<area shape="poly" title=" " alt="" coords="655,197,715,192,778,177,825,155,862,129,865,134,827,159,780,183,716,197,655,203"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="236,184,375,224"/>
<area shape="poly" title=" " alt="" coords="388,200,554,198,554,203,388,206"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1ValidatorKeys_1_1Keys.html">Keys</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 id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ad8e9721f7cbe7ad937d12437dcbd6789" id="r_ad8e9721f7cbe7ad937d12437dcbd6789"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ValidatorKeys.html#ad8e9721f7cbe7ad937d12437dcbd6789">ValidatorKeys</a> ()=delete</td></tr>
<tr class="separator:ad8e9721f7cbe7ad937d12437dcbd6789"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4e94fcbc4b7a59806f65cc55e5b7b8f" id="r_ab4e94fcbc4b7a59806f65cc55e5b7b8f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ValidatorKeys.html#ab4e94fcbc4b7a59806f65cc55e5b7b8f">ValidatorKeys</a> (<a class="el" href="classripple_1_1Config.html">Config</a> const &amp;config, <a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> j)</td></tr>
<tr class="separator:ab4e94fcbc4b7a59806f65cc55e5b7b8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a44b2d0c3657d1c81fc4cf366389e4135" id="r_a44b2d0c3657d1c81fc4cf366389e4135"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ValidatorKeys.html#a44b2d0c3657d1c81fc4cf366389e4135">configInvalid</a> () const</td></tr>
<tr class="separator:a44b2d0c3657d1c81fc4cf366389e4135"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a4d7df09f95d48d81154748b945d1dc43" id="r_a4d7df09f95d48d81154748b945d1dc43"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt; <a class="el" href="structripple_1_1ValidatorKeys_1_1Keys.html">Keys</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ValidatorKeys.html#a4d7df09f95d48d81154748b945d1dc43">keys</a></td></tr>
<tr class="separator:a4d7df09f95d48d81154748b945d1dc43"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf43add83ef3a8968e1457e1d8e380ee" id="r_aaf43add83ef3a8968e1457e1d8e380ee"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#a4e412a5834900d9affa8db3ac1a27209">NodeID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ValidatorKeys.html#aaf43add83ef3a8968e1457e1d8e380ee">nodeID</a></td></tr>
<tr class="separator:aaf43add83ef3a8968e1457e1d8e380ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a183b4ce6c755f2788f75bfabd9a8dcb7" id="r_a183b4ce6c755f2788f75bfabd9a8dcb7"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ValidatorKeys.html#a183b4ce6c755f2788f75bfabd9a8dcb7">manifest</a></td></tr>
<tr class="separator:a183b4ce6c755f2788f75bfabd9a8dcb7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad00c2991257b5cc276b423a6e80f7ad2" id="r_ad00c2991257b5cc276b423a6e80f7ad2"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ValidatorKeys.html#ad00c2991257b5cc276b423a6e80f7ad2">sequence</a> = 0</td></tr>
<tr class="separator:ad00c2991257b5cc276b423a6e80f7ad2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:af157e199cda90e0e55b004c185483091" id="r_af157e199cda90e0e55b004c185483091"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1ValidatorKeys.html#af157e199cda90e0e55b004c185483091">configInvalid_</a> = false</td></tr>
<tr class="separator:af157e199cda90e0e55b004c185483091"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Validator keys and manifest as set in configuration file. </p>
<p>Values will be empty if not configured as a validator or not configured with a manifest. </p>
<p class="definition">Definition at line <a class="el" href="ValidatorKeys_8h_source.html#l00018">18</a> of file <a class="el" href="ValidatorKeys_8h_source.html">ValidatorKeys.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ad8e9721f7cbe7ad937d12437dcbd6789" name="ad8e9721f7cbe7ad937d12437dcbd6789"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad8e9721f7cbe7ad937d12437dcbd6789">&#9670;&#160;</a></span>ValidatorKeys() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::ValidatorKeys::ValidatorKeys </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ab4e94fcbc4b7a59806f65cc55e5b7b8f" name="ab4e94fcbc4b7a59806f65cc55e5b7b8f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab4e94fcbc4b7a59806f65cc55e5b7b8f">&#9670;&#160;</a></span>ValidatorKeys() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::ValidatorKeys::ValidatorKeys </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1Config.html">Config</a> const &amp;&#160;</td>
<td class="paramname"><em>config</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a>&#160;</td>
<td class="paramname"><em>j</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ValidatorKeys_8cpp_source.html#l00010">10</a> of file <a class="el" href="ValidatorKeys_8cpp_source.html">ValidatorKeys.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a44b2d0c3657d1c81fc4cf366389e4135" name="a44b2d0c3657d1c81fc4cf366389e4135"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44b2d0c3657d1c81fc4cf366389e4135">&#9670;&#160;</a></span>configInvalid()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ripple::ValidatorKeys::configInvalid </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="ValidatorKeys_8h_source.html#l00053">53</a> of file <a class="el" href="ValidatorKeys_8h_source.html">ValidatorKeys.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a4d7df09f95d48d81154748b945d1dc43" name="a4d7df09f95d48d81154748b945d1dc43"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d7df09f95d48d81154748b945d1dc43">&#9670;&#160;</a></span>keys</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>&lt;<a class="el" href="structripple_1_1ValidatorKeys_1_1Keys.html">Keys</a>&gt; ripple::ValidatorKeys::keys</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ValidatorKeys_8h_source.html#l00044">44</a> of file <a class="el" href="ValidatorKeys_8h_source.html">ValidatorKeys.h</a>.</p>
</div>
</div>
<a id="aaf43add83ef3a8968e1457e1d8e380ee" name="aaf43add83ef3a8968e1457e1d8e380ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaf43add83ef3a8968e1457e1d8e380ee">&#9670;&#160;</a></span>nodeID</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceripple.html#a4e412a5834900d9affa8db3ac1a27209">NodeID</a> ripple::ValidatorKeys::nodeID</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ValidatorKeys_8h_source.html#l00045">45</a> of file <a class="el" href="ValidatorKeys_8h_source.html">ValidatorKeys.h</a>.</p>
</div>
</div>
<a id="a183b4ce6c755f2788f75bfabd9a8dcb7" name="a183b4ce6c755f2788f75bfabd9a8dcb7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a183b4ce6c755f2788f75bfabd9a8dcb7">&#9670;&#160;</a></span>manifest</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> ripple::ValidatorKeys::manifest</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ValidatorKeys_8h_source.html#l00046">46</a> of file <a class="el" href="ValidatorKeys_8h_source.html">ValidatorKeys.h</a>.</p>
</div>
</div>
<a id="ad00c2991257b5cc276b423a6e80f7ad2" name="ad00c2991257b5cc276b423a6e80f7ad2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad00c2991257b5cc276b423a6e80f7ad2">&#9670;&#160;</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::ValidatorKeys::sequence = 0</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ValidatorKeys_8h_source.html#l00047">47</a> of file <a class="el" href="ValidatorKeys_8h_source.html">ValidatorKeys.h</a>.</p>
</div>
</div>
<a id="af157e199cda90e0e55b004c185483091" name="af157e199cda90e0e55b004c185483091"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af157e199cda90e0e55b004c185483091">&#9670;&#160;</a></span>configInvalid_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ripple::ValidatorKeys::configInvalid_ = false</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="ValidatorKeys_8h_source.html#l00059">59</a> of file <a class="el" href="ValidatorKeys_8h_source.html">ValidatorKeys.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>