Files
rippled/structripple_1_1ValidatorList_1_1PublisherListStats.html
2023-12-01 05:03:54 +00:00

350 lines
20 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::ValidatorList::PublisherListStats Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="classripple_1_1ValidatorList.html">ValidatorList</a></li><li class="navelem"><a class="el" href="structripple_1_1ValidatorList_1_1PublisherListStats.html">PublisherListStats</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structripple_1_1ValidatorList_1_1PublisherListStats-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ripple::ValidatorList::PublisherListStats Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Describes the result of processing a Validator List (UNL), including some of the information from the list which can be used by the caller to know which list publisher is involved.
<a href="structripple_1_1ValidatorList_1_1PublisherListStats.html#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for ripple::ValidatorList::PublisherListStats:</div>
<div class="dyncontent">
<div class="center"><img src="structripple_1_1ValidatorList_1_1PublisherListStats__coll__graph.png" border="0" usemap="#ripple_1_1ValidatorList_1_1PublisherListStats_coll__map" alt="Collaboration graph"/></div>
<map name="ripple_1_1ValidatorList_1_1PublisherListStats_coll__map" id="ripple_1_1ValidatorList_1_1PublisherListStats_coll__map">
<area shape="rect" title="Describes the result of processing a Validator List (UNL), including some of the information from the..." alt="" coords="539,65,687,107"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/utility/optional.html" title=" " alt="" coords="227,5,381,47"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="5,107,93,134"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/map.html" title=" " alt="" coords="207,135,401,176"/>
</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:a3377c0090810a38667f445596bb1aaf7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1ValidatorList_1_1PublisherListStats.html#a3377c0090810a38667f445596bb1aaf7">PublisherListStats</a> ()=default</td></tr>
<tr class="separator:a3377c0090810a38667f445596bb1aaf7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa6c17138870cb5a2bd680c29cc4ebab"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1ValidatorList_1_1PublisherListStats.html#aaa6c17138870cb5a2bd680c29cc4ebab">PublisherListStats</a> (<a class="el" href="namespaceripple.html#a6eaff79c38106bc3b27326d878c902d3">ListDisposition</a> d)</td></tr>
<tr class="separator:aaa6c17138870cb5a2bd680c29cc4ebab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a34d5705410e27523336af23aa9d90ec6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1ValidatorList_1_1PublisherListStats.html#a34d5705410e27523336af23aa9d90ec6">PublisherListStats</a> (<a class="el" href="namespaceripple.html#a6eaff79c38106bc3b27326d878c902d3">ListDisposition</a> d, <a class="el" href="classripple_1_1PublicKey.html">PublicKey</a> key, <a class="el" href="namespaceripple.html#aaf9d6587e02c610e84a029ad5b5e17b4">PublisherStatus</a> stat, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> seq)</td></tr>
<tr class="separator:a34d5705410e27523336af23aa9d90ec6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c1a5dcd8079d94a6affd3602b9d4fbc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#a6eaff79c38106bc3b27326d878c902d3">ListDisposition</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1ValidatorList_1_1PublisherListStats.html#a1c1a5dcd8079d94a6affd3602b9d4fbc">bestDisposition</a> () const</td></tr>
<tr class="separator:a1c1a5dcd8079d94a6affd3602b9d4fbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a47be311fd3dc2b5a9aa0623ee493215d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#a6eaff79c38106bc3b27326d878c902d3">ListDisposition</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1ValidatorList_1_1PublisherListStats.html#a47be311fd3dc2b5a9aa0623ee493215d">worstDisposition</a> () const</td></tr>
<tr class="separator:a47be311fd3dc2b5a9aa0623ee493215d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0152f32b497bbaa62e9a85e0be90bb02"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1ValidatorList_1_1PublisherListStats.html#a0152f32b497bbaa62e9a85e0be90bb02">mergeDispositions</a> (<a class="el" href="structripple_1_1ValidatorList_1_1PublisherListStats.html">PublisherListStats</a> const &amp;src)</td></tr>
<tr class="separator:a0152f32b497bbaa62e9a85e0be90bb02"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a517f509ad4f2032f1553def3e810a5a5"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/map.html">std::map</a>&lt; <a class="el" href="namespaceripple.html#a6eaff79c38106bc3b27326d878c902d3">ListDisposition</a>, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1ValidatorList_1_1PublisherListStats.html#a517f509ad4f2032f1553def3e810a5a5">dispositions</a></td></tr>
<tr class="separator:a517f509ad4f2032f1553def3e810a5a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6863af689efe13c3d2c5193bd1a6b580"><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="classripple_1_1PublicKey.html">PublicKey</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1ValidatorList_1_1PublisherListStats.html#a6863af689efe13c3d2c5193bd1a6b580">publisherKey</a></td></tr>
<tr class="separator:a6863af689efe13c3d2c5193bd1a6b580"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab22f32e8b38152895ef09736fea12d8c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#aaf9d6587e02c610e84a029ad5b5e17b4">PublisherStatus</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1ValidatorList_1_1PublisherListStats.html#ab22f32e8b38152895ef09736fea12d8c">status</a> = <a class="el" href="namespaceripple.html#aaf9d6587e02c610e84a029ad5b5e17b4a7060e0481896e00b3f7d20f1e8e2749a">PublisherStatus::unavailable</a></td></tr>
<tr class="separator:ab22f32e8b38152895ef09736fea12d8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa37066f4c4bc231ad60e6f751e56bf05"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1ValidatorList_1_1PublisherListStats.html#aa37066f4c4bc231ad60e6f751e56bf05">sequence</a> = 0</td></tr>
<tr class="separator:aa37066f4c4bc231ad60e6f751e56bf05"><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>Describes the result of processing a Validator List (UNL), including some of the information from the list which can be used by the caller to know which list publisher is involved. </p>
<p class="definition">Definition at line <a class="el" href="ValidatorList_8h_source.html#l00278">278</a> of file <a class="el" href="ValidatorList_8h_source.html">ValidatorList.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a3377c0090810a38667f445596bb1aaf7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3377c0090810a38667f445596bb1aaf7">&#9670;&nbsp;</a></span>PublisherListStats() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::ValidatorList::PublisherListStats::PublisherListStats </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aaa6c17138870cb5a2bd680c29cc4ebab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaa6c17138870cb5a2bd680c29cc4ebab">&#9670;&nbsp;</a></span>PublisherListStats() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::ValidatorList::PublisherListStats::PublisherListStats </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceripple.html#a6eaff79c38106bc3b27326d878c902d3">ListDisposition</a>&#160;</td>
<td class="paramname"><em>d</em></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="ValidatorList_8cpp_source.html#l00069">69</a> of file <a class="el" href="ValidatorList_8cpp_source.html">ValidatorList.cpp</a>.</p>
</div>
</div>
<a id="a34d5705410e27523336af23aa9d90ec6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a34d5705410e27523336af23aa9d90ec6">&#9670;&nbsp;</a></span>PublisherListStats() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::ValidatorList::PublisherListStats::PublisherListStats </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceripple.html#a6eaff79c38106bc3b27326d878c902d3">ListDisposition</a>&#160;</td>
<td class="paramname"><em>d</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1PublicKey.html">PublicKey</a>&#160;</td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceripple.html#aaf9d6587e02c610e84a029ad5b5e17b4">PublisherStatus</a>&#160;</td>
<td class="paramname"><em>stat</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>&#160;</td>
<td class="paramname"><em>seq</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="ValidatorList_8cpp_source.html#l00074">74</a> of file <a class="el" href="ValidatorList_8cpp_source.html">ValidatorList.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a1c1a5dcd8079d94a6affd3602b9d4fbc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c1a5dcd8079d94a6affd3602b9d4fbc">&#9670;&nbsp;</a></span>bestDisposition()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceripple.html#a6eaff79c38106bc3b27326d878c902d3">ListDisposition</a> ripple::ValidatorList::PublisherListStats::bestDisposition </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="ValidatorList_8cpp_source.html#l00085">85</a> of file <a class="el" href="ValidatorList_8cpp_source.html">ValidatorList.cpp</a>.</p>
</div>
</div>
<a id="a47be311fd3dc2b5a9aa0623ee493215d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a47be311fd3dc2b5a9aa0623ee493215d">&#9670;&nbsp;</a></span>worstDisposition()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceripple.html#a6eaff79c38106bc3b27326d878c902d3">ListDisposition</a> ripple::ValidatorList::PublisherListStats::worstDisposition </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="ValidatorList_8cpp_source.html#l00092">92</a> of file <a class="el" href="ValidatorList_8cpp_source.html">ValidatorList.cpp</a>.</p>
</div>
</div>
<a id="a0152f32b497bbaa62e9a85e0be90bb02"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0152f32b497bbaa62e9a85e0be90bb02">&#9670;&nbsp;</a></span>mergeDispositions()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::ValidatorList::PublisherListStats::mergeDispositions </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structripple_1_1ValidatorList_1_1PublisherListStats.html">PublisherListStats</a> const &amp;&#160;</td>
<td class="paramname"><em>src</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ValidatorList_8cpp_source.html#l00099">99</a> of file <a class="el" href="ValidatorList_8cpp_source.html">ValidatorList.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a517f509ad4f2032f1553def3e810a5a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a517f509ad4f2032f1553def3e810a5a5">&#9670;&nbsp;</a></span>dispositions</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/container/map.html">std::map</a>&lt;<a class="el" href="namespaceripple.html#a6eaff79c38106bc3b27326d878c902d3">ListDisposition</a>, <a class="elRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a>&gt; ripple::ValidatorList::PublisherListStats::dispositions</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ValidatorList_8h_source.html#l00297">297</a> of file <a class="el" href="ValidatorList_8h_source.html">ValidatorList.h</a>.</p>
</div>
</div>
<a id="a6863af689efe13c3d2c5193bd1a6b580"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6863af689efe13c3d2c5193bd1a6b580">&#9670;&nbsp;</a></span>publisherKey</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="classripple_1_1PublicKey.html">PublicKey</a>&gt; ripple::ValidatorList::PublisherListStats::publisherKey</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ValidatorList_8h_source.html#l00298">298</a> of file <a class="el" href="ValidatorList_8h_source.html">ValidatorList.h</a>.</p>
</div>
</div>
<a id="ab22f32e8b38152895ef09736fea12d8c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab22f32e8b38152895ef09736fea12d8c">&#9670;&nbsp;</a></span>status</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceripple.html#aaf9d6587e02c610e84a029ad5b5e17b4">PublisherStatus</a> ripple::ValidatorList::PublisherListStats::status = <a class="el" href="namespaceripple.html#aaf9d6587e02c610e84a029ad5b5e17b4a7060e0481896e00b3f7d20f1e8e2749a">PublisherStatus::unavailable</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ValidatorList_8h_source.html#l00299">299</a> of file <a class="el" href="ValidatorList_8h_source.html">ValidatorList.h</a>.</p>
</div>
</div>
<a id="aa37066f4c4bc231ad60e6f751e56bf05"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa37066f4c4bc231ad60e6f751e56bf05">&#9670;&nbsp;</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/size_t.html">std::size_t</a> ripple::ValidatorList::PublisherListStats::sequence = 0</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="ValidatorList_8h_source.html#l00300">300</a> of file <a class="el" href="ValidatorList_8h_source.html">ValidatorList.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>