Files
rippled/namespaceripple_1_1perf.html
2025-10-08 01:28:57 -07:00

236 lines
13 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::perf Namespace 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="namespaceripple_1_1perf.html">perf</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">ripple::perf Namespace Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Dummy class for unit tests.
<a href="namespaceripple_1_1perf.html#details">More...</a></p>
<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_1perf_1_1Locked.html">Locked</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A box coupling data with a mutex for locking access to it. <a href="structripple_1_1perf_1_1Locked.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1perf_1_1PerfLog.html">PerfLog</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Singleton class that maintains performance counters and optionally writes Json-formatted data to a distinct log. <a href="classripple_1_1perf_1_1PerfLog.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1perf_1_1PerfLogImp.html">PerfLogImp</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implementation class for <a class="el" href="classripple_1_1perf_1_1PerfLog.html" title="Singleton class that maintains performance counters and optionally writes Json-formatted data to a di...">PerfLog</a>. <a href="classripple_1_1perf_1_1PerfLogImp.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1perf_1_1PerfLogTest.html">PerfLogTest</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="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a05a394877a70f3d8ee8ec2a42b906763" id="r_a05a394877a70f3d8ee8ec2a42b906763"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structripple_1_1perf_1_1PerfLog_1_1Setup.html">PerfLog::Setup</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceripple_1_1perf.html#a05a394877a70f3d8ee8ec2a42b906763">setup_PerfLog</a> (<a class="el" href="classripple_1_1Section.html">Section</a> const &amp;section, boost::filesystem::path const &amp;configDir)</td></tr>
<tr class="separator:a05a394877a70f3d8ee8ec2a42b906763"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef38cd26fe2b2e924f8c117aff08b598" id="r_aef38cd26fe2b2e924f8c117aff08b598"><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="el" href="classripple_1_1perf_1_1PerfLog.html">PerfLog</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceripple_1_1perf.html#aef38cd26fe2b2e924f8c117aff08b598">make_PerfLog</a> (<a class="el" href="structripple_1_1perf_1_1PerfLog_1_1Setup.html">PerfLog::Setup</a> const &amp;setup, <a class="el" href="classripple_1_1Application.html">Application</a> &amp;app, <a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> journal, <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>&lt; void()&gt; &amp;&amp;signalStop)</td></tr>
<tr class="separator:aef38cd26fe2b2e924f8c117aff08b598"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b533bab386ca1e6c4ecfeac09871d9e" id="r_a2b533bab386ca1e6c4ecfeac09871d9e"><td class="memTemplParams" colspan="2">template&lt;typename Func , class Rep , class Period &gt; </td></tr>
<tr class="memitem:a2b533bab386ca1e6c4ecfeac09871d9e"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceripple_1_1perf.html#a2b533bab386ca1e6c4ecfeac09871d9e">measureDurationAndLog</a> (Func &amp;&amp;func, <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp;actionDescription, <a class="elRef" href="http://en.cppreference.com/w/cpp/chrono/duration.html">std::chrono::duration</a>&lt; Rep, Period &gt; maxDelay, <a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> const &amp;journal)</td></tr>
<tr class="separator:a2b533bab386ca1e6c4ecfeac09871d9e"><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>Dummy class for unit tests. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a05a394877a70f3d8ee8ec2a42b906763" name="a05a394877a70f3d8ee8ec2a42b906763"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a05a394877a70f3d8ee8ec2a42b906763">&#9670;&#160;</a></span>setup_PerfLog()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structripple_1_1perf_1_1PerfLog_1_1Setup.html">PerfLog::Setup</a> ripple::perf::setup_PerfLog </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1Section.html">Section</a> const &amp;&#160;</td>
<td class="paramname"><em>section</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">boost::filesystem::path const &amp;&#160;</td>
<td class="paramname"><em>configDir</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="PerfLogImp_8cpp_source.html#l00500">500</a> of file <a class="el" href="PerfLogImp_8cpp_source.html">PerfLogImp.cpp</a>.</p>
</div>
</div>
<a id="aef38cd26fe2b2e924f8c117aff08b598" name="aef38cd26fe2b2e924f8c117aff08b598"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aef38cd26fe2b2e924f8c117aff08b598">&#9670;&#160;</a></span>make_PerfLog()</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="el" href="classripple_1_1perf_1_1PerfLog.html">PerfLog</a> &gt; ripple::perf::make_PerfLog </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structripple_1_1perf_1_1PerfLog_1_1Setup.html">PerfLog::Setup</a> const &amp;&#160;</td>
<td class="paramname"><em>setup</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1Application.html">Application</a> &amp;&#160;</td>
<td class="paramname"><em>app</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>journal</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/utility/functional/function.html">std::function</a>&lt; void()&gt; &amp;&amp;&#160;</td>
<td class="paramname"><em>signalStop</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="PerfLogImp_8cpp_source.html#l00522">522</a> of file <a class="el" href="PerfLogImp_8cpp_source.html">PerfLogImp.cpp</a>.</p>
</div>
</div>
<a id="a2b533bab386ca1e6c4ecfeac09871d9e" name="a2b533bab386ca1e6c4ecfeac09871d9e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b533bab386ca1e6c4ecfeac09871d9e">&#9670;&#160;</a></span>measureDurationAndLog()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Func , class Rep , class Period &gt; </div>
<table class="memname">
<tr>
<td class="memname">auto ripple::perf::measureDurationAndLog </td>
<td>(</td>
<td class="paramtype">Func &amp;&amp;&#160;</td>
<td class="paramname"><em>func</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> const &amp;&#160;</td>
<td class="paramname"><em>actionDescription</em>, </td>
</tr>
<tr>
<td class="paramkey"></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;&#160;</td>
<td class="paramname"><em>maxDelay</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classbeast_1_1Journal.html">beast::Journal</a> const &amp;&#160;</td>
<td class="paramname"><em>journal</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="PerfLog_8h_source.html#l00187">187</a> of file <a class="el" href="PerfLog_8h_source.html">PerfLog.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>