Google Git
Sign in
apache/iceberg-cpp/refs/heads/gh-pages/./api/classiceberg_1_1Timer.html
blob: 975f6e7ee7ea805daa0d6b44b049557d6d287384 [file]
<!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>iceberg-cpp: iceberg::Timer 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">iceberg-cpp
</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="namespaceiceberg.html">iceberg</a></li><li class="navelem"><a class="el" href="classiceberg_1_1Timer.html">Timer</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="classiceberg_1_1Timer-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">iceberg::Timer Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div>
</div><!--header-->
<div class="contents">
<p>Abstract timer for measuring operation durations.
<a href="classiceberg_1_1Timer.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="timer_8h_source.html">timer.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for iceberg::Timer:</div>
<div class="dyncontent">
<div class="center">
<img src="classiceberg_1_1Timer.png" usemap="#iceberg::Timer_map" alt=""/>
<map id="iceberg::Timer_map" name="iceberg::Timer_map">
<area href="classiceberg_1_1DefaultTimer.html" title="Thread-safe timer backed by std::atomic&lt;int64_t&gt;." alt="iceberg::DefaultTimer" shape="rect" coords="0,56,132,80"/>
</map>
</div></div>
<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">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Timer_1_1Timed.html">Timed</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">RAII guard that records elapsed time into a non-owning <a class="el" href="classiceberg_1_1Timer.html" title="Abstract timer for measuring operation durations.">Timer</a> on destruction. <a href="classiceberg_1_1Timer_1_1Timed.html#details">More...</a><br /></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="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a221670653142490dd9b0d8f503a93fe0" id="r_a221670653142490dd9b0d8f503a93fe0"><td class="memItemLeft" align="right" valign="top">virtual int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Timer.html#a221670653142490dd9b0d8f503a93fe0">Count</a> () const =0</td></tr>
<tr class="memdesc:a221670653142490dd9b0d8f503a93fe0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of timing recordings made so far. <br /></td></tr>
<tr class="separator:a221670653142490dd9b0d8f503a93fe0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9cb0b951b21d13fbab08d62ce8152ee6" id="r_a9cb0b951b21d13fbab08d62ce8152ee6"><td class="memItemLeft" align="right" valign="top">virtual std::chrono::nanoseconds&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Timer.html#a9cb0b951b21d13fbab08d62ce8152ee6">TotalDuration</a> () const =0</td></tr>
<tr class="memdesc:a9cb0b951b21d13fbab08d62ce8152ee6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Total accumulated duration across all recordings. <br /></td></tr>
<tr class="separator:a9cb0b951b21d13fbab08d62ce8152ee6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea567b5246f94785cac35eaab22472d0" id="r_aea567b5246f94785cac35eaab22472d0"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Timer.html#aea567b5246f94785cac35eaab22472d0">Record</a> (std::chrono::nanoseconds duration)=0</td></tr>
<tr class="memdesc:aea567b5246f94785cac35eaab22472d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Record a nanosecond duration directly. <br /></td></tr>
<tr class="separator:aea567b5246f94785cac35eaab22472d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a42e9476ad403c7bcd61327f585e51922" id="r_a42e9476ad403c7bcd61327f585e51922"><td class="memTemplParams" colspan="2"><a id="a42e9476ad403c7bcd61327f585e51922" name="a42e9476ad403c7bcd61327f585e51922"></a>
template&lt;typename Rep , typename Period &gt; </td></tr>
<tr class="memitem:a42e9476ad403c7bcd61327f585e51922"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><b>Record</b> (std::chrono::duration&lt; Rep, Period &gt; duration)</td></tr>
<tr class="memdesc:a42e9476ad403c7bcd61327f585e51922"><td class="mdescLeft">&#160;</td><td class="mdescRight">Record a duration of any chrono type, converting to nanoseconds. <br /></td></tr>
<tr class="separator:a42e9476ad403c7bcd61327f585e51922"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a4910174c81ea6545a130e42412ad03" id="r_a4a4910174c81ea6545a130e42412ad03"><td class="memItemLeft" align="right" valign="top">virtual std::string_view&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Timer.html#a4a4910174c81ea6545a130e42412ad03">Unit</a> () const</td></tr>
<tr class="memdesc:a4a4910174c81ea6545a130e42412ad03"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the time unit used by this timer. <br /></td></tr>
<tr class="separator:a4a4910174c81ea6545a130e42412ad03"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a625487b1476a9c96e4c2be7443afc2aa" id="r_a625487b1476a9c96e4c2be7443afc2aa"><td class="memItemLeft" align="right" valign="top"><a id="a625487b1476a9c96e4c2be7443afc2aa" name="a625487b1476a9c96e4c2be7443afc2aa"></a>
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><b>IsNoop</b> () const</td></tr>
<tr class="memdesc:a625487b1476a9c96e4c2be7443afc2aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return true if this timer is a no-op. <br /></td></tr>
<tr class="separator:a625487b1476a9c96e4c2be7443afc2aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af19032db807f4c8890aae045e3384a7f" id="r_af19032db807f4c8890aae045e3384a7f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classiceberg_1_1Timer_1_1Timed.html">Timed</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Timer.html#af19032db807f4c8890aae045e3384a7f">Start</a> ()</td></tr>
<tr class="memdesc:af19032db807f4c8890aae045e3384a7f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start timing and return a RAII <a class="el" href="classiceberg_1_1Timer_1_1Timed.html" title="RAII guard that records elapsed time into a non-owning Timer on destruction.">Timed</a> guard. <br /></td></tr>
<tr class="separator:af19032db807f4c8890aae045e3384a7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1a40cd3e1bd699ba5cf6787ecbb59395" id="r_a1a40cd3e1bd699ba5cf6787ecbb59395"><td class="memTemplParams" colspan="2"><a id="a1a40cd3e1bd699ba5cf6787ecbb59395" name="a1a40cd3e1bd699ba5cf6787ecbb59395"></a>
template&lt;typename Callable &gt; </td></tr>
<tr class="memitem:a1a40cd3e1bd699ba5cf6787ecbb59395"><td class="memTemplItemLeft" align="right" valign="top">decltype(auto)&#160;</td><td class="memTemplItemRight" valign="bottom"><b>Time</b> (Callable &amp;&amp;fn)</td></tr>
<tr class="memdesc:a1a40cd3e1bd699ba5cf6787ecbb59395"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute a callable, record its wall-clock duration, and return its result. <br /></td></tr>
<tr class="separator:a1a40cd3e1bd699ba5cf6787ecbb59395"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:aa52e69efb7f9bedcdc150a46f2b7c08c" id="r_aa52e69efb7f9bedcdc150a46f2b7c08c"><td class="memItemLeft" align="right" valign="top"><a id="aa52e69efb7f9bedcdc150a46f2b7c08c" name="aa52e69efb7f9bedcdc150a46f2b7c08c"></a>
static std::shared_ptr&lt; <a class="el" href="classiceberg_1_1Timer.html">Timer</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><b>Noop</b> ()</td></tr>
<tr class="memdesc:aa52e69efb7f9bedcdc150a46f2b7c08c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a shared no-op timer singleton. <br /></td></tr>
<tr class="separator:aa52e69efb7f9bedcdc150a46f2b7c08c"><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>Abstract timer for measuring operation durations. </p>
<p>Use <a class="el" href="classiceberg_1_1Timer.html#af19032db807f4c8890aae045e3384a7f" title="Start timing and return a RAII Timed guard.">Start()</a> to obtain a <a class="el" href="classiceberg_1_1Timer_1_1Timed.html" title="RAII guard that records elapsed time into a non-owning Timer on destruction.">Timed</a> RAII guard that records the elapsed duration when it goes out of scope. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a221670653142490dd9b0d8f503a93fe0" name="a221670653142490dd9b0d8f503a93fe0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a221670653142490dd9b0d8f503a93fe0">&#9670;&#160;</a></span>Count()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual int64_t iceberg::Timer::Count </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of timing recordings made so far. </p>
<p>Implemented in <a class="el" href="classiceberg_1_1DefaultTimer.html#a0680281fb49a3b28f17b3534beeb7849">iceberg::DefaultTimer</a>.</p>
</div>
</div>
<a id="aea567b5246f94785cac35eaab22472d0" name="aea567b5246f94785cac35eaab22472d0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea567b5246f94785cac35eaab22472d0">&#9670;&#160;</a></span>Record()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void iceberg::Timer::Record </td>
<td>(</td>
<td class="paramtype">std::chrono::nanoseconds&#160;</td>
<td class="paramname"><em>duration</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Record a nanosecond duration directly. </p>
<p>Use the template overload below to record any std::chrono duration type with automatic unit conversion. </p>
<p>Implemented in <a class="el" href="classiceberg_1_1DefaultTimer.html#a5f12e8509b6cda2f688d175787088279">iceberg::DefaultTimer</a>.</p>
</div>
</div>
<a id="af19032db807f4c8890aae045e3384a7f" name="af19032db807f4c8890aae045e3384a7f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af19032db807f4c8890aae045e3384a7f">&#9670;&#160;</a></span>Start()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classiceberg_1_1Timer_1_1Timed.html">Timed</a> iceberg::Timer::Start </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Start timing and return a RAII <a class="el" href="classiceberg_1_1Timer_1_1Timed.html" title="RAII guard that records elapsed time into a non-owning Timer on destruction.">Timed</a> guard. </p>
<p>The elapsed duration is recorded into this timer when the <a class="el" href="classiceberg_1_1Timer_1_1Timed.html" title="RAII guard that records elapsed time into a non-owning Timer on destruction.">Timed</a> guard is destroyed or Stop() is called. The caller must ensure this timer outlives the returned guard. </p>
</div>
</div>
<a id="a9cb0b951b21d13fbab08d62ce8152ee6" name="a9cb0b951b21d13fbab08d62ce8152ee6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9cb0b951b21d13fbab08d62ce8152ee6">&#9670;&#160;</a></span>TotalDuration()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::chrono::nanoseconds iceberg::Timer::TotalDuration </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Total accumulated duration across all recordings. </p>
<p>Implemented in <a class="el" href="classiceberg_1_1DefaultTimer.html#a2344941bb8e0ac6872833b067695cde0">iceberg::DefaultTimer</a>.</p>
</div>
</div>
<a id="a4a4910174c81ea6545a130e42412ad03" name="a4a4910174c81ea6545a130e42412ad03"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a4910174c81ea6545a130e42412ad03">&#9670;&#160;</a></span>Unit()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual std::string_view iceberg::Timer::Unit </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the time unit used by this timer. </p>
<p>Reimplemented in <a class="el" href="classiceberg_1_1DefaultTimer.html#a730501496959c45605b4735823760a25">iceberg::DefaultTimer</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>iceberg/metrics/<a class="el" href="timer_8h_source.html">timer.h</a></li>
</ul>
</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>