ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-27 22:45:52 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
1f22595f620e55e408a1b22ccfc18a72bae9660e
rippled/classbeast_1_1insight_1_1Meter.html
bthomee e7f4ae8bed deploy: afc05659ed
2025-08-19 09:49:50 -07:00

345 lines
20 KiB
HTML
Raw 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: beast::insight::Meter 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="namespacebeast.html">beast</a></li><li class="navelem"><a class="el" href="namespacebeast_1_1insight.html">insight</a></li><li class="navelem"><a class="el" href="classbeast_1_1insight_1_1Meter.html">Meter</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classbeast_1_1insight_1_1Meter-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">beast::insight::Meter Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>A metric for measuring an integral value.
<a href="classbeast_1_1insight_1_1Meter.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="Meter_8h_source.html">Meter.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for beast::insight::Meter:</div>
<div class="dyncontent">
<div class="center"><img src="classbeast_1_1insight_1_1Meter__coll__graph.png" border="0" usemap="#abeast_1_1insight_1_1Meter_coll__map" alt="Collaboration graph"/></div>
<map name="abeast_1_1insight_1_1Meter_coll__map" id="abeast_1_1insight_1_1Meter_coll__map">
<area shape="rect" title="A metric for measuring an integral value." alt="" coords="21,285,177,311"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="14,183,185,223"/>
<area shape="poly" title=" " alt="" coords="102,237,102,285,97,285,97,237"/>
<area shape="rect" href="classbeast_1_1insight_1_1MeterImpl.html" title=" " alt="" coords="7,95,192,120"/>
<area shape="poly" title=" " alt="" coords="102,134,102,182,97,182,97,134"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/memory/enable_shared_from_this.html" title=" " alt="" coords="5,5,193,45"/>
<area shape="poly" title=" " alt="" coords="102,59,102,94,97,94,97,59"/>
</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-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:aae27f186d8d27fc3ac18b640efcc8871" id="r_aae27f186d8d27fc3ac18b640efcc8871"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1insight_1_1Meter.html#aae27f186d8d27fc3ac18b640efcc8871">value_type</a> = <a class="el" href="classbeast_1_1insight_1_1MeterImpl.html#aec3325b96d5ce316cecb89dbbaba62b3">MeterImpl::value_type</a></td></tr>
<tr class="separator:aae27f186d8d27fc3ac18b640efcc8871"><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:a1c722eaae1865f01bfe1f0e0cbe42a4a" id="r_a1c722eaae1865f01bfe1f0e0cbe42a4a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1insight_1_1Meter.html#a1c722eaae1865f01bfe1f0e0cbe42a4a">Meter</a> ()</td></tr>
<tr class="memdesc:a1c722eaae1865f01bfe1f0e0cbe42a4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a null metric. <br /></td></tr>
<tr class="separator:a1c722eaae1865f01bfe1f0e0cbe42a4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b28aae0d54481cc432ce6fa9f158c4b" id="r_a3b28aae0d54481cc432ce6fa9f158c4b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1insight_1_1Meter.html#a3b28aae0d54481cc432ce6fa9f158c4b">Meter</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="classbeast_1_1insight_1_1MeterImpl.html">MeterImpl</a> &gt; const &amp;<a class="el" href="classbeast_1_1insight_1_1Meter.html#a913f00186289f7cd50444239a5011c16">impl</a>)</td></tr>
<tr class="memdesc:a3b28aae0d54481cc432ce6fa9f158c4b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create the metric reference the specified implementation. <br /></td></tr>
<tr class="separator:a3b28aae0d54481cc432ce6fa9f158c4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a913f00186289f7cd50444239a5011c16" id="r_a913f00186289f7cd50444239a5011c16"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="classbeast_1_1insight_1_1MeterImpl.html">MeterImpl</a> &gt; const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1insight_1_1Meter.html#a913f00186289f7cd50444239a5011c16">impl</a> () const</td></tr>
<tr class="separator:a913f00186289f7cd50444239a5011c16"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr class="memitem:a02c976b9dc407bedb19e99dfdb976332" id="r_a02c976b9dc407bedb19e99dfdb976332"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1insight_1_1Meter.html#a02c976b9dc407bedb19e99dfdb976332">increment</a> (<a class="el" href="classbeast_1_1insight_1_1Meter.html#aae27f186d8d27fc3ac18b640efcc8871">value_type</a> amount) const</td></tr>
<tr class="memdesc:a02c976b9dc407bedb19e99dfdb976332"><td class="mdescLeft">&#160;</td><td class="mdescRight">Increment the meter. <br /></td></tr>
<tr class="separator:a02c976b9dc407bedb19e99dfdb976332"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4560d7ebbb0b1361838c4ee429a3c5c7" id="r_a4560d7ebbb0b1361838c4ee429a3c5c7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbeast_1_1insight_1_1Meter.html">Meter</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1insight_1_1Meter.html#a4560d7ebbb0b1361838c4ee429a3c5c7">operator+=</a> (<a class="el" href="classbeast_1_1insight_1_1Meter.html#aae27f186d8d27fc3ac18b640efcc8871">value_type</a> amount) const</td></tr>
<tr class="separator:a4560d7ebbb0b1361838c4ee429a3c5c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a826b4a812b41082be048e3773d90e8b0" id="r_a826b4a812b41082be048e3773d90e8b0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbeast_1_1insight_1_1Meter.html">Meter</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1insight_1_1Meter.html#a826b4a812b41082be048e3773d90e8b0">operator++</a> () const</td></tr>
<tr class="separator:a826b4a812b41082be048e3773d90e8b0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a42c366d0937f768966fca53962020d0d" id="r_a42c366d0937f768966fca53962020d0d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbeast_1_1insight_1_1Meter.html">Meter</a> const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1insight_1_1Meter.html#a42c366d0937f768966fca53962020d0d">operator++</a> (int) const</td></tr>
<tr class="separator:a42c366d0937f768966fca53962020d0d"><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:a1d8b5ed61a14d832511f891a8b0245b8" id="r_a1d8b5ed61a14d832511f891a8b0245b8"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="classbeast_1_1insight_1_1MeterImpl.html">MeterImpl</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1insight_1_1Meter.html#a1d8b5ed61a14d832511f891a8b0245b8">m_impl</a></td></tr>
<tr class="separator:a1d8b5ed61a14d832511f891a8b0245b8"><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>A metric for measuring an integral value. </p>
<p>A meter may be thought of as an increment-only counter.</p>
<p>This is a lightweight reference wrapper which is cheap to copy and assign. When the last reference goes away, the metric is no longer collected. </p>
<p class="definition">Definition at line <a class="el" href="Meter_8h_source.html#l00037">37</a> of file <a class="el" href="Meter_8h_source.html">Meter.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="aae27f186d8d27fc3ac18b640efcc8871" name="aae27f186d8d27fc3ac18b640efcc8871"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae27f186d8d27fc3ac18b640efcc8871">&#9670;&#160;</a></span>value_type</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">using <a class="el" href="classbeast_1_1insight_1_1Meter.html#aae27f186d8d27fc3ac18b640efcc8871">beast::insight::Meter::value_type</a> = <a class="el" href="classbeast_1_1insight_1_1MeterImpl.html#aec3325b96d5ce316cecb89dbbaba62b3">MeterImpl::value_type</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Meter_8h_source.html#l00040">40</a> of file <a class="el" href="Meter_8h_source.html">Meter.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a1c722eaae1865f01bfe1f0e0cbe42a4a" name="a1c722eaae1865f01bfe1f0e0cbe42a4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c722eaae1865f01bfe1f0e0cbe42a4a">&#9670;&#160;</a></span>Meter() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">beast::insight::Meter::Meter </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a null metric. </p>
<p>A null metric reports no information. </p>
<p class="definition">Definition at line <a class="el" href="Meter_8h_source.html#l00045">45</a> of file <a class="el" href="Meter_8h_source.html">Meter.h</a>.</p>
</div>
</div>
<a id="a3b28aae0d54481cc432ce6fa9f158c4b" name="a3b28aae0d54481cc432ce6fa9f158c4b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3b28aae0d54481cc432ce6fa9f158c4b">&#9670;&#160;</a></span>Meter() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">beast::insight::Meter::Meter </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="classbeast_1_1insight_1_1MeterImpl.html">MeterImpl</a> &gt; const &amp;&#160;</td>
<td class="paramname"><em>impl</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>Create the metric reference the specified implementation. </p>
<p>Normally this won't be called directly. Instead, call the appropriate factory function in the <a class="el" href="classbeast_1_1insight_1_1Collector.html" title="Interface for a manager that allows collection of metrics.">Collector</a> interface. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="classbeast_1_1insight_1_1Collector.html" title="Interface for a manager that allows collection of metrics.">Collector</a>. </dd></dl>
<p class="definition">Definition at line <a class="el" href="Meter_8h_source.html#l00054">54</a> of file <a class="el" href="Meter_8h_source.html">Meter.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a02c976b9dc407bedb19e99dfdb976332" name="a02c976b9dc407bedb19e99dfdb976332"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a02c976b9dc407bedb19e99dfdb976332">&#9670;&#160;</a></span>increment()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void beast::insight::Meter::increment </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classbeast_1_1insight_1_1Meter.html#aae27f186d8d27fc3ac18b640efcc8871">value_type</a>&#160;</td>
<td class="paramname"><em>amount</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Increment the meter. </p>
<p class="definition">Definition at line <a class="el" href="Meter_8h_source.html#l00061">61</a> of file <a class="el" href="Meter_8h_source.html">Meter.h</a>.</p>
</div>
</div>
<a id="a4560d7ebbb0b1361838c4ee429a3c5c7" name="a4560d7ebbb0b1361838c4ee429a3c5c7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4560d7ebbb0b1361838c4ee429a3c5c7">&#9670;&#160;</a></span>operator+=()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classbeast_1_1insight_1_1Meter.html">Meter</a> const &amp; beast::insight::Meter::operator+= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classbeast_1_1insight_1_1Meter.html#aae27f186d8d27fc3ac18b640efcc8871">value_type</a>&#160;</td>
<td class="paramname"><em>amount</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Meter_8h_source.html#l00068">68</a> of file <a class="el" href="Meter_8h_source.html">Meter.h</a>.</p>
</div>
</div>
<a id="a826b4a812b41082be048e3773d90e8b0" name="a826b4a812b41082be048e3773d90e8b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a826b4a812b41082be048e3773d90e8b0">&#9670;&#160;</a></span>operator++() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classbeast_1_1insight_1_1Meter.html">Meter</a> const &amp; beast::insight::Meter::operator++ </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="Meter_8h_source.html#l00075">75</a> of file <a class="el" href="Meter_8h_source.html">Meter.h</a>.</p>
</div>
</div>
<a id="a42c366d0937f768966fca53962020d0d" name="a42c366d0937f768966fca53962020d0d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a42c366d0937f768966fca53962020d0d">&#9670;&#160;</a></span>operator++() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classbeast_1_1insight_1_1Meter.html">Meter</a> const &amp; beast::insight::Meter::operator++ </td>
<td>(</td>
<td class="paramtype">int&#160;</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="Meter_8h_source.html#l00082">82</a> of file <a class="el" href="Meter_8h_source.html">Meter.h</a>.</p>
</div>
</div>
<a id="a913f00186289f7cd50444239a5011c16" name="a913f00186289f7cd50444239a5011c16"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a913f00186289f7cd50444239a5011c16">&#9670;&#160;</a></span>impl()</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/shared_ptr.html">std::shared_ptr</a>&lt; <a class="el" href="classbeast_1_1insight_1_1MeterImpl.html">MeterImpl</a> &gt; const &amp; beast::insight::Meter::impl </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="Meter_8h_source.html#l00090">90</a> of file <a class="el" href="Meter_8h_source.html">Meter.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a1d8b5ed61a14d832511f891a8b0245b8" name="a1d8b5ed61a14d832511f891a8b0245b8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1d8b5ed61a14d832511f891a8b0245b8">&#9670;&#160;</a></span>m_impl</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/shared_ptr.html">std::shared_ptr</a>&lt;<a class="el" href="classbeast_1_1insight_1_1MeterImpl.html">MeterImpl</a>&gt; beast::insight::Meter::m_impl</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="Meter_8h_source.html#l00096">96</a> of file <a class="el" href="Meter_8h_source.html">Meter.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