ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-20 02:55:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
rippled/classripple_1_1RclConsensusLogger.html
bthomee 74d4116914 deploy: 2c187461cc
2025-11-17 06:05:07 -08:00

335 lines
18 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::RclConsensusLogger 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_1RclConsensusLogger.html">RclConsensusLogger</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classripple_1_1RclConsensusLogger-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::RclConsensusLogger Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Collects logging information.
<a href="classripple_1_1RclConsensusLogger.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="RCLConsensus_8h_source.html">RCLConsensus.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ripple::RclConsensusLogger:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1RclConsensusLogger__coll__graph.png" border="0" usemap="#aripple_1_1RclConsensusLogger_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1RclConsensusLogger_coll__map" id="aripple_1_1RclConsensusLogger_coll__map">
<area shape="rect" title="Collects logging information." alt="" coords="141,628,342,653"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="54,533,141,558"/>
<area shape="poly" title=" " alt="" coords="125,564,180,602,221,625,218,630,177,606,122,568"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title=" " alt="" coords="5,423,144,463"/>
<area shape="poly" title=" " alt="" coords="84,475,97,532,92,533,79,476"/>
<area shape="rect" href="classbeast_1_1Journal.html" title="A generic endpoint for log messages." alt="" coords="186,533,297,558"/>
<area shape="poly" title=" " alt="" coords="244,572,244,628,239,628,239,572"/>
<area shape="rect" href="classbeast_1_1Journal_1_1Sink.html" title="Abstraction for the underlying message destination." alt="" coords="168,430,315,455"/>
<area shape="poly" title=" " alt="" coords="244,469,244,533,239,533,239,469"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html" title=" " alt="" coords="324,525,479,565"/>
<area shape="poly" title=" " alt="" coords="359,574,262,630,260,626,356,570"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/io/basic_stringstream.html" title=" " alt="" coords="339,430,472,455"/>
<area shape="poly" title=" " alt="" coords="407,469,405,525,399,525,402,469"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/io/basic_stringstream.html" title=" " alt="" coords="318,333,493,373"/>
<area shape="poly" title=" " alt="" coords="408,387,408,430,403,430,403,387"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/io/basic_iostream.html" title=" " alt="" coords="331,244,480,284"/>
<area shape="poly" title=" " alt="" coords="408,298,408,333,403,333,403,298"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/io/basic_istream.html" title=" " alt="" coords="252,155,393,195"/>
<area shape="poly" title=" " alt="" coords="352,203,389,242,386,246,348,206"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/io/basic_ios.html" title=" " alt="" coords="320,80,491,105"/>
<area shape="poly" title=" " alt="" coords="385,117,344,157,340,153,382,113"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html" title=" " alt="" coords="418,155,563,195"/>
<area shape="poly" title=" " alt="" coords="429,113,472,153,469,157,426,116"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/io/ios_base.html" title=" " alt="" coords="352,5,459,31"/>
<area shape="poly" title=" " alt="" coords="408,45,408,80,403,80,403,45"/>
<area shape="poly" title=" " alt="" coords="464,207,426,246,422,242,461,203"/>
</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="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a62b616635dd7bca3503b13ad3e358d59" id="r_a62b616635dd7bca3503b13ad3e358d59"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RclConsensusLogger.html#a62b616635dd7bca3503b13ad3e358d59">RclConsensusLogger</a> (char const *label, bool validating, <a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> j)</td></tr>
<tr class="separator:a62b616635dd7bca3503b13ad3e358d59"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa6afcdf2752a0c206942dc1a057ffc3e" id="r_aa6afcdf2752a0c206942dc1a057ffc3e"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RclConsensusLogger.html#aa6afcdf2752a0c206942dc1a057ffc3e">~RclConsensusLogger</a> ()</td></tr>
<tr class="separator:aa6afcdf2752a0c206942dc1a057ffc3e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a04f13d14041f6722222652455f4bd88c" id="r_a04f13d14041f6722222652455f4bd88c"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>&lt; <a class="elRef" href="http://en.cppreference.com/w/cpp/io/basic_stringstream.html">std::stringstream</a> &gt; const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RclConsensusLogger.html#a04f13d14041f6722222652455f4bd88c">ss</a> ()</td></tr>
<tr class="separator:a04f13d14041f6722222652455f4bd88c"><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:a68cfb38b00a3322049efed5d3dcbd598" id="r_a68cfb38b00a3322049efed5d3dcbd598"><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_1RclConsensusLogger.html#a68cfb38b00a3322049efed5d3dcbd598">header_</a></td></tr>
<tr class="separator:a68cfb38b00a3322049efed5d3dcbd598"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a79d994c030dca64010c0195207af3117" id="r_a79d994c030dca64010c0195207af3117"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RclConsensusLogger.html#a79d994c030dca64010c0195207af3117">j_</a></td></tr>
<tr class="separator:a79d994c030dca64010c0195207af3117"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0773f83dee4a3df01d5a9f365a2a917" id="r_ab0773f83dee4a3df01d5a9f365a2a917"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>&lt; <a class="elRef" href="http://en.cppreference.com/w/cpp/io/basic_stringstream.html">std::stringstream</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RclConsensusLogger.html#ab0773f83dee4a3df01d5a9f365a2a917">ss_</a></td></tr>
<tr class="separator:ab0773f83dee4a3df01d5a9f365a2a917"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa7947aaac11956a173d35768b7bc95b2" id="r_aa7947aaac11956a173d35768b7bc95b2"><td class="memItemLeft" align="right" valign="top">std::chrono::steady_clock::time_point&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1RclConsensusLogger.html#aa7947aaac11956a173d35768b7bc95b2">start_</a></td></tr>
<tr class="separator:aa7947aaac11956a173d35768b7bc95b2"><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>Collects logging information. </p>
<p>Eases correlating multiple data points together to help follow flow of a complex activity, such as consensus heartbeat timer. If we are a validator, then always write output to debug log on destruction. Otherwise, INFO level. </p>
<p class="definition">Definition at line <a class="el" href="RCLConsensus_8h_source.html#l00531">531</a> of file <a class="el" href="RCLConsensus_8h_source.html">RCLConsensus.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a62b616635dd7bca3503b13ad3e358d59" name="a62b616635dd7bca3503b13ad3e358d59"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a62b616635dd7bca3503b13ad3e358d59">&#9670;&#160;</a></span>RclConsensusLogger()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::RclConsensusLogger::RclConsensusLogger </td>
<td>(</td>
<td class="paramtype">char const *&#160;</td>
<td class="paramname"><em>label</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>validating</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>
</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="RCLConsensus_8cpp_source.html#l01081">1081</a> of file <a class="el" href="RCLConsensus_8cpp_source.html">RCLConsensus.cpp</a>.</p>
</div>
</div>
<a id="aa6afcdf2752a0c206942dc1a057ffc3e" name="aa6afcdf2752a0c206942dc1a057ffc3e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa6afcdf2752a0c206942dc1a057ffc3e">&#9670;&#160;</a></span>~RclConsensusLogger()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::RclConsensusLogger::~RclConsensusLogger </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="RCLConsensus_8cpp_source.html#l01096">1096</a> of file <a class="el" href="RCLConsensus_8cpp_source.html">RCLConsensus.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a04f13d14041f6722222652455f4bd88c" name="a04f13d14041f6722222652455f4bd88c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a04f13d14041f6722222652455f4bd88c">&#9670;&#160;</a></span>ss()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/unique_ptr.html">std::unique_ptr</a>&lt; <a class="elRef" href="http://en.cppreference.com/w/cpp/io/basic_stringstream.html">std::stringstream</a> &gt; const &amp; ripple::RclConsensusLogger::ss </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="RCLConsensus_8h_source.html#l00546">546</a> of file <a class="el" href="RCLConsensus_8h_source.html">RCLConsensus.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a68cfb38b00a3322049efed5d3dcbd598" name="a68cfb38b00a3322049efed5d3dcbd598"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68cfb38b00a3322049efed5d3dcbd598">&#9670;&#160;</a></span>header_</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/string/basic_string.html">std::string</a> ripple::RclConsensusLogger::header_</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="RCLConsensus_8h_source.html#l00533">533</a> of file <a class="el" href="RCLConsensus_8h_source.html">RCLConsensus.h</a>.</p>
</div>
</div>
<a id="a79d994c030dca64010c0195207af3117" name="a79d994c030dca64010c0195207af3117"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a79d994c030dca64010c0195207af3117">&#9670;&#160;</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::RclConsensusLogger::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="RCLConsensus_8h_source.html#l00534">534</a> of file <a class="el" href="RCLConsensus_8h_source.html">RCLConsensus.h</a>.</p>
</div>
</div>
<a id="ab0773f83dee4a3df01d5a9f365a2a917" name="ab0773f83dee4a3df01d5a9f365a2a917"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab0773f83dee4a3df01d5a9f365a2a917">&#9670;&#160;</a></span>ss_</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/memory/unique_ptr.html">std::unique_ptr</a>&lt;<a class="elRef" href="http://en.cppreference.com/w/cpp/io/basic_stringstream.html">std::stringstream</a>&gt; ripple::RclConsensusLogger::ss_</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="RCLConsensus_8h_source.html#l00535">535</a> of file <a class="el" href="RCLConsensus_8h_source.html">RCLConsensus.h</a>.</p>
</div>
</div>
<a id="aa7947aaac11956a173d35768b7bc95b2" name="aa7947aaac11956a173d35768b7bc95b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7947aaac11956a173d35768b7bc95b2">&#9670;&#160;</a></span>start_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::chrono::steady_clock::time_point ripple::RclConsensusLogger::start_</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="RCLConsensus_8h_source.html#l00536">536</a> of file <a class="el" href="RCLConsensus_8h_source.html">RCLConsensus.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>
Reference in New Issue View Git Blame Copy Permalink