ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-28 06:55:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
rippled/classbeast_1_1insight_1_1Event.html
bthomee 33451fdc96 deploy: 1d42c4f6de
2025-11-04 00:36:48 -08:00

282 lines
16 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: beast::insight::Event 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_1Event.html">Event</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_1Event-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">beast::insight::Event Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>A metric for reporting event timing.
<a href="classbeast_1_1insight_1_1Event.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="Event_8h_source.html">Event.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for beast::insight::Event:</div>
<div class="dyncontent">
<div class="center"><img src="classbeast_1_1insight_1_1Event__coll__graph.png" border="0" usemap="#abeast_1_1insight_1_1Event_coll__map" alt="Collaboration graph"/></div>
<map name="abeast_1_1insight_1_1Event_coll__map" id="abeast_1_1insight_1_1Event_coll__map">
<area shape="rect" title="A metric for reporting event timing." alt="" coords="21,285,176,311"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/memory/shared_ptr.html" title=" " alt="" coords="13,183,184,223"/>
<area shape="poly" title=" " alt="" coords="101,237,101,285,96,285,96,237"/>
<area shape="rect" href="classbeast_1_1insight_1_1EventImpl.html" title=" " alt="" coords="7,95,191,120"/>
<area shape="poly" title=" " alt="" coords="101,134,101,182,96,182,96,134"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/memory/enable_shared_from_this.html" title=" " alt="" coords="5,5,192,45"/>
<area shape="poly" title=" " alt="" coords="101,59,101,94,96,94,96,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:a3a053c8de8739b30eb7dae79a6f810c1" id="r_a3a053c8de8739b30eb7dae79a6f810c1"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1insight_1_1Event.html#a3a053c8de8739b30eb7dae79a6f810c1">value_type</a> = <a class="el" href="classbeast_1_1insight_1_1EventImpl.html#abb840f537602809ff28d7fda1cea1152">EventImpl::value_type</a></td></tr>
<tr class="separator:a3a053c8de8739b30eb7dae79a6f810c1"><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:abd3ec6423ccafcc82ceffcd8e84c689d" id="r_abd3ec6423ccafcc82ceffcd8e84c689d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1insight_1_1Event.html#abd3ec6423ccafcc82ceffcd8e84c689d">Event</a> ()</td></tr>
<tr class="memdesc:abd3ec6423ccafcc82ceffcd8e84c689d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a null metric. <br /></td></tr>
<tr class="separator:abd3ec6423ccafcc82ceffcd8e84c689d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaf309ac1b40d3090c9c3ccaf6cd93fc7" id="r_aaf309ac1b40d3090c9c3ccaf6cd93fc7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1insight_1_1Event.html#aaf309ac1b40d3090c9c3ccaf6cd93fc7">Event</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_1EventImpl.html">EventImpl</a> &gt; const &amp;<a class="el" href="classbeast_1_1insight_1_1Event.html#a9335298def8a60f86b5835ce2873eb99">impl</a>)</td></tr>
<tr class="memdesc:aaf309ac1b40d3090c9c3ccaf6cd93fc7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create the metric reference the specified implementation. <br /></td></tr>
<tr class="separator:aaf309ac1b40d3090c9c3ccaf6cd93fc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af25d64d42a95d26832e7354f07059245" id="r_af25d64d42a95d26832e7354f07059245"><td class="memTemplParams" colspan="2">template&lt;class Rep , class Period &gt; </td></tr>
<tr class="memitem:af25d64d42a95d26832e7354f07059245"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classbeast_1_1insight_1_1Event.html#af25d64d42a95d26832e7354f07059245">notify</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::duration</a>&lt; Rep, Period &gt; const &amp;value) const</td></tr>
<tr class="memdesc:af25d64d42a95d26832e7354f07059245"><td class="mdescLeft">&#160;</td><td class="mdescRight">Push an event notification. <br /></td></tr>
<tr class="separator:af25d64d42a95d26832e7354f07059245"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9335298def8a60f86b5835ce2873eb99" id="r_a9335298def8a60f86b5835ce2873eb99"><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_1EventImpl.html">EventImpl</a> &gt; const &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1insight_1_1Event.html#a9335298def8a60f86b5835ce2873eb99">impl</a> () const</td></tr>
<tr class="separator:a9335298def8a60f86b5835ce2873eb99"><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:a64fcf2f4779e99bbe5753531cefb736b" id="r_a64fcf2f4779e99bbe5753531cefb736b"><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_1EventImpl.html">EventImpl</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classbeast_1_1insight_1_1Event.html#a64fcf2f4779e99bbe5753531cefb736b">m_impl</a></td></tr>
<tr class="separator:a64fcf2f4779e99bbe5753531cefb736b"><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 reporting event timing. </p>
<p>An event is an operation that has an associated millisecond time, or other integral value. Because events happen at a specific moment, the metric only supports a push-style interface.</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="Event_8h_source.html#l00021">21</a> of file <a class="el" href="Event_8h_source.html">Event.h</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a3a053c8de8739b30eb7dae79a6f810c1" name="a3a053c8de8739b30eb7dae79a6f810c1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a053c8de8739b30eb7dae79a6f810c1">&#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_1Event.html#a3a053c8de8739b30eb7dae79a6f810c1">beast::insight::Event::value_type</a> = <a class="el" href="classbeast_1_1insight_1_1EventImpl.html#abb840f537602809ff28d7fda1cea1152">EventImpl::value_type</a></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="Event_8h_source.html#l00024">24</a> of file <a class="el" href="Event_8h_source.html">Event.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="abd3ec6423ccafcc82ceffcd8e84c689d" name="abd3ec6423ccafcc82ceffcd8e84c689d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abd3ec6423ccafcc82ceffcd8e84c689d">&#9670;&#160;</a></span>Event() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">beast::insight::Event::Event </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="Event_8h_source.html#l00029">29</a> of file <a class="el" href="Event_8h_source.html">Event.h</a>.</p>
</div>
</div>
<a id="aaf309ac1b40d3090c9c3ccaf6cd93fc7" name="aaf309ac1b40d3090c9c3ccaf6cd93fc7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaf309ac1b40d3090c9c3ccaf6cd93fc7">&#9670;&#160;</a></span>Event() <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::Event::Event </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_1EventImpl.html">EventImpl</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="Event_8h_source.html#l00038">38</a> of file <a class="el" href="Event_8h_source.html">Event.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="af25d64d42a95d26832e7354f07059245" name="af25d64d42a95d26832e7354f07059245"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af25d64d42a95d26832e7354f07059245">&#9670;&#160;</a></span>notify()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Rep , class Period &gt; </div>
<table class="memname">
<tr>
<td class="memname">void beast::insight::Event::notify </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::duration</a>&lt; Rep, Period &gt; const &amp;&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Push an event notification. </p>
<p class="definition">Definition at line <a class="el" href="Event_8h_source.html#l00045">45</a> of file <a class="el" href="Event_8h_source.html">Event.h</a>.</p>
</div>
</div>
<a id="a9335298def8a60f86b5835ce2873eb99" name="a9335298def8a60f86b5835ce2873eb99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9335298def8a60f86b5835ce2873eb99">&#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_1EventImpl.html">EventImpl</a> &gt; const &amp; beast::insight::Event::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="Event_8h_source.html#l00053">53</a> of file <a class="el" href="Event_8h_source.html">Event.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a64fcf2f4779e99bbe5753531cefb736b" name="a64fcf2f4779e99bbe5753531cefb736b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a64fcf2f4779e99bbe5753531cefb736b">&#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_1EventImpl.html">EventImpl</a>&gt; beast::insight::Event::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="Event_8h_source.html#l00059">59</a> of file <a class="el" href="Event_8h_source.html">Event.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