| <!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/metrics/timer.h Source File</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&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&dn=expat.txt MIT */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */ |
| </script> |
| <div id="main-nav"></div> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ |
| $(document).ready(function() { init_codefold(0); }); |
| /* @license-end */ |
| </script> |
| <!-- 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="dir_51d145386ec5f52aa06ebf5e46944abc.html">iceberg</a></li><li class="navelem"><a class="el" href="dir_5dc26e7e5886cb79baf1860f841364b7.html">metrics</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"><div class="title">timer.h</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="timer_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div> |
| <div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div> |
| <div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div> |
| <div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * distributed with this work for additional information</span></div> |
| <div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div> |
| <div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div> |
| <div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * "License"); you may not use this file except in compliance</span></div> |
| <div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * with the License. You may obtain a copy of the License at</span></div> |
| <div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> *</span></div> |
| <div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div> |
| <div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * software distributed under the License is distributed on an</span></div> |
| <div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div> |
| <div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * KIND, either express or implied. See the License for the</span></div> |
| <div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * specific language governing permissions and limitations</span></div> |
| <div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * under the License.</span></div> |
| <div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> */</span></div> |
| <div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div> |
| <div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#pragma once</span></div> |
| <div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div> |
| <div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div> |
| <div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include <atomic></span></div> |
| <div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include <chrono></span></div> |
| <div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include <cstdint></span></div> |
| <div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include <functional></span></div> |
| <div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#include <memory></span></div> |
| <div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="preprocessor">#include <string_view></span></div> |
| <div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="preprocessor">#include <type_traits></span></div> |
| <div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="preprocessor">#include <utility></span></div> |
| <div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div> |
| <div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="preprocessor">#include "<a class="code" href="iceberg__export_8h.html">iceberg/iceberg_export.h</a>"</span></div> |
| <div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div> |
| <div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceiceberg.html">iceberg</a> {</div> |
| <div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div> |
| <div class="foldopen" id="foldopen00039" data-start="{" data-end="};"> |
| <div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="namespaceiceberg.html#a392862e5026f65af0f58105ede04659a"> 39</a></span><span class="keyword">enum class</span> <a class="code hl_enumeration" href="namespaceiceberg.html#a392862e5026f65af0f58105ede04659a">TimerUnit</a> {</div> |
| <div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> kNanoseconds,</div> |
| <div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> kMicroseconds,</div> |
| <div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> kMilliseconds,</div> |
| <div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> kSeconds,</div> |
| <div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> kMinutes,</div> |
| <div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> kHours,</div> |
| <div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> kDays,</div> |
| <div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span>};</div> |
| </div> |
| <div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div> |
| <div class="foldopen" id="foldopen00050" data-start="{" data-end="}"> |
| <div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="namespaceiceberg.html#a3eb506e2b02375005d6f87d31abe75ba"> 50</a></span>ICEBERG_EXPORT <span class="keyword">constexpr</span> std::string_view <a class="code hl_function" href="namespaceiceberg.html#a67197636ef5578a5ddd401c59a449164">ToString</a>(<a class="code hl_enumeration" href="namespaceiceberg.html#a392862e5026f65af0f58105ede04659a">TimerUnit</a> unit) <span class="keyword">noexcept</span> {</div> |
| <div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="keywordflow">switch</span> (unit) {</div> |
| <div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keywordflow">case</span> TimerUnit::kNanoseconds:</div> |
| <div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="keywordflow">return</span> <span class="stringliteral">"nanoseconds"</span>;</div> |
| <div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <span class="keywordflow">case</span> TimerUnit::kMicroseconds:</div> |
| <div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keywordflow">return</span> <span class="stringliteral">"microseconds"</span>;</div> |
| <div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="keywordflow">case</span> TimerUnit::kMilliseconds:</div> |
| <div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> <span class="keywordflow">return</span> <span class="stringliteral">"milliseconds"</span>;</div> |
| <div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="keywordflow">case</span> TimerUnit::kSeconds:</div> |
| <div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <span class="keywordflow">return</span> <span class="stringliteral">"seconds"</span>;</div> |
| <div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="keywordflow">case</span> TimerUnit::kMinutes:</div> |
| <div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <span class="keywordflow">return</span> <span class="stringliteral">"minutes"</span>;</div> |
| <div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="keywordflow">case</span> TimerUnit::kHours:</div> |
| <div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> <span class="keywordflow">return</span> <span class="stringliteral">"hours"</span>;</div> |
| <div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> <span class="keywordflow">case</span> TimerUnit::kDays:</div> |
| <div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="keywordflow">return</span> <span class="stringliteral">"days"</span>;</div> |
| <div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> }</div> |
| <div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> std::unreachable();</div> |
| <div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span>}</div> |
| </div> |
| <div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div> |
| <div class="foldopen" id="foldopen00074" data-start="{" data-end="};"> |
| <div class="line"><a id="l00074" name="l00074"></a><span class="lineno"><a class="line" href="classiceberg_1_1Timer.html"> 74</a></span><span class="keyword">class </span>ICEBERG_EXPORT <a class="code hl_class" href="classiceberg_1_1Timer.html">Timer</a> {</div> |
| <div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="keyword">public</span>:</div> |
| <div class="foldopen" id="foldopen00077" data-start="{" data-end="};"> |
| <div class="line"><a id="l00077" name="l00077"></a><span class="lineno"><a class="line" href="classiceberg_1_1Timer_1_1Timed.html"> 77</a></span> <span class="keyword">class </span>ICEBERG_EXPORT <a class="code hl_class" href="classiceberg_1_1Timer_1_1Timed.html">Timed</a> {</div> |
| <div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <span class="keyword">explicit</span> <a class="code hl_class" href="classiceberg_1_1Timer_1_1Timed.html">Timed</a>(<a class="code hl_class" href="classiceberg_1_1Timer.html">Timer</a>& timer);</div> |
| <div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> <a class="code hl_class" href="classiceberg_1_1Timer_1_1Timed.html">~Timed</a>();</div> |
| <div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> </div> |
| <div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> <a class="code hl_class" href="classiceberg_1_1Timer_1_1Timed.html">Timed</a>(<span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1Timer_1_1Timed.html">Timed</a>&) = <span class="keyword">delete</span>;</div> |
| <div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> <a class="code hl_class" href="classiceberg_1_1Timer_1_1Timed.html">Timed</a>& operator=(<span class="keyword">const</span> <a class="code hl_class" href="classiceberg_1_1Timer_1_1Timed.html">Timed</a>&) = <span class="keyword">delete</span>;</div> |
| <div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <a class="code hl_class" href="classiceberg_1_1Timer_1_1Timed.html">Timed</a>(<a class="code hl_class" href="classiceberg_1_1Timer_1_1Timed.html">Timed</a>&& other) <span class="keyword">noexcept</span>;</div> |
| <div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> <a class="code hl_class" href="classiceberg_1_1Timer_1_1Timed.html">Timed</a>& operator=(<a class="code hl_class" href="classiceberg_1_1Timer_1_1Timed.html">Timed</a>&& other) <span class="keyword">noexcept</span>;</div> |
| <div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> </div> |
| <div class="line"><a id="l00090" name="l00090"></a><span class="lineno"><a class="line" href="classiceberg_1_1Timer_1_1Timed.html#a435fc292cb438022e77ff8584a6c2c40"> 90</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classiceberg_1_1Timer_1_1Timed.html#a435fc292cb438022e77ff8584a6c2c40">Stop</a>();</div> |
| <div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> </div> |
| <div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> <span class="keyword">private</span>:</div> |
| <div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> <a class="code hl_class" href="classiceberg_1_1Timer.html">Timer</a>* timer_;</div> |
| <div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> std::chrono::steady_clock::time_point start_;</div> |
| <div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> <span class="keywordtype">bool</span> stopped_ = <span class="keyword">false</span>;</div> |
| <div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> };</div> |
| </div> |
| <div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> </div> |
| <div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <span class="keyword">virtual</span> <a class="code hl_class" href="classiceberg_1_1Timer.html">~Timer</a>() = <span class="keywordflow">default</span>;</div> |
| <div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> </div> |
| <div class="line"><a id="l00101" name="l00101"></a><span class="lineno"><a class="line" href="classiceberg_1_1Timer.html#a221670653142490dd9b0d8f503a93fe0"> 101</a></span> <span class="keyword">virtual</span> int64_t <a class="code hl_function" href="classiceberg_1_1Timer.html#a221670653142490dd9b0d8f503a93fe0">Count</a>() <span class="keyword">const</span> = 0;</div> |
| <div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> </div> |
| <div class="line"><a id="l00104" name="l00104"></a><span class="lineno"><a class="line" href="classiceberg_1_1Timer.html#a9cb0b951b21d13fbab08d62ce8152ee6"> 104</a></span> <span class="keyword">virtual</span> std::chrono::nanoseconds <a class="code hl_function" href="classiceberg_1_1Timer.html#a9cb0b951b21d13fbab08d62ce8152ee6">TotalDuration</a>() <span class="keyword">const</span> = 0;</div> |
| <div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> </div> |
| <div class="line"><a id="l00110" name="l00110"></a><span class="lineno"><a class="line" href="classiceberg_1_1Timer.html#aea567b5246f94785cac35eaab22472d0"> 110</a></span> <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classiceberg_1_1Timer.html#aea567b5246f94785cac35eaab22472d0">Record</a>(std::chrono::nanoseconds duration) = 0;</div> |
| <div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> </div> |
| <div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> <span class="keyword">template</span> <<span class="keyword">typename</span> Rep, <span class="keyword">typename</span> Period></div> |
| <div class="foldopen" id="foldopen00114" data-start="{" data-end="}"> |
| <div class="line"><a id="l00114" name="l00114"></a><span class="lineno"><a class="line" href="classiceberg_1_1Timer.html#a42e9476ad403c7bcd61327f585e51922"> 114</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classiceberg_1_1Timer.html#a42e9476ad403c7bcd61327f585e51922">Record</a>(std::chrono::duration<Rep, Period> duration) {</div> |
| <div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> Record(std::chrono::duration_cast<std::chrono::nanoseconds>(duration));</div> |
| <div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> }</div> |
| </div> |
| <div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> </div> |
| <div class="line"><a id="l00119" name="l00119"></a><span class="lineno"><a class="line" href="classiceberg_1_1Timer.html#a4a4910174c81ea6545a130e42412ad03"> 119</a></span> <span class="keyword">virtual</span> std::string_view <a class="code hl_function" href="classiceberg_1_1Timer.html#a4a4910174c81ea6545a130e42412ad03">Unit</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="stringliteral">"nanoseconds"</span>; }</div> |
| <div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> </div> |
| <div class="line"><a id="l00122" name="l00122"></a><span class="lineno"><a class="line" href="classiceberg_1_1Timer.html#a625487b1476a9c96e4c2be7443afc2aa"> 122</a></span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classiceberg_1_1Timer.html#a625487b1476a9c96e4c2be7443afc2aa">IsNoop</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">false</span>; }</div> |
| <div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> </div> |
| <div class="line"><a id="l00129" name="l00129"></a><span class="lineno"><a class="line" href="classiceberg_1_1Timer.html#af19032db807f4c8890aae045e3384a7f"> 129</a></span> <a class="code hl_class" href="classiceberg_1_1Timer_1_1Timed.html">Timed</a> <a class="code hl_function" href="classiceberg_1_1Timer.html#af19032db807f4c8890aae045e3384a7f">Start</a>();</div> |
| <div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> </div> |
| <div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> <span class="keyword">template</span> <<span class="keyword">typename</span> Callable></div> |
| <div class="foldopen" id="foldopen00133" data-start="{" data-end="}"> |
| <div class="line"><a id="l00133" name="l00133"></a><span class="lineno"><a class="line" href="classiceberg_1_1Timer.html#a1a40cd3e1bd699ba5cf6787ecbb59395"> 133</a></span> <span class="keyword">decltype</span>(<span class="keyword">auto</span>) <a class="code hl_function" href="classiceberg_1_1Timer.html#a1a40cd3e1bd699ba5cf6787ecbb59395">Time</a>(Callable&& fn) {</div> |
| <div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> <span class="keyword">auto</span> timed = Start();</div> |
| <div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span> <span class="keyword">using </span>ResultType = std::invoke_result_t<Callable&&>;</div> |
| <div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> <span class="keywordflow">if</span> <span class="keyword">constexpr</span> (std::is_void_v<ResultType>) {</div> |
| <div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> std::invoke(std::forward<Callable>(fn));</div> |
| <div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> } <span class="keywordflow">else</span> <span class="keywordflow">if</span> <span class="keyword">constexpr</span> (std::is_reference_v<ResultType>) {</div> |
| <div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> <span class="keywordflow">return</span> std::invoke(std::forward<Callable>(fn));</div> |
| <div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span> } <span class="keywordflow">else</span> {</div> |
| <div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span> <span class="keywordflow">return</span> std::invoke(std::forward<Callable>(fn));</div> |
| <div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span> }</div> |
| <div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span> }</div> |
| </div> |
| <div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span> </div> |
| <div class="line"><a id="l00146" name="l00146"></a><span class="lineno"><a class="line" href="classiceberg_1_1Timer.html#aa52e69efb7f9bedcdc150a46f2b7c08c"> 146</a></span> <span class="keyword">static</span> std::shared_ptr<Timer> <a class="code hl_function" href="classiceberg_1_1Timer.html#aa52e69efb7f9bedcdc150a46f2b7c08c">Noop</a>();</div> |
| <div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span>};</div> |
| </div> |
| <div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span> </div> |
| <div class="foldopen" id="foldopen00150" data-start="{" data-end="};"> |
| <div class="line"><a id="l00150" name="l00150"></a><span class="lineno"><a class="line" href="classiceberg_1_1DefaultTimer.html"> 150</a></span><span class="keyword">class </span>ICEBERG_EXPORT <a class="code hl_class" href="classiceberg_1_1DefaultTimer.html">DefaultTimer</a> : <span class="keyword">public</span> <a class="code hl_class" href="classiceberg_1_1Timer.html">Timer</a> {</div> |
| <div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> <span class="keyword">explicit</span> <a class="code hl_class" href="classiceberg_1_1DefaultTimer.html">DefaultTimer</a>(<a class="code hl_enumeration" href="namespaceiceberg.html#a392862e5026f65af0f58105ede04659a">TimerUnit</a> unit = TimerUnit::kNanoseconds);</div> |
| <div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span> </div> |
| <div class="line"><a id="l00154" name="l00154"></a><span class="lineno"><a class="line" href="classiceberg_1_1DefaultTimer.html#a0680281fb49a3b28f17b3534beeb7849"> 154</a></span> int64_t <a class="code hl_function" href="classiceberg_1_1DefaultTimer.html#a0680281fb49a3b28f17b3534beeb7849">Count</a>() <span class="keyword">const override</span>;</div> |
| <div class="line"><a id="l00155" name="l00155"></a><span class="lineno"><a class="line" href="classiceberg_1_1DefaultTimer.html#a2344941bb8e0ac6872833b067695cde0"> 155</a></span> std::chrono::nanoseconds <a class="code hl_function" href="classiceberg_1_1DefaultTimer.html#a2344941bb8e0ac6872833b067695cde0">TotalDuration</a>() <span class="keyword">const override</span>;</div> |
| <div class="line"><a id="l00156" name="l00156"></a><span class="lineno"><a class="line" href="classiceberg_1_1DefaultTimer.html#a5f12e8509b6cda2f688d175787088279"> 156</a></span> <span class="keywordtype">void</span> <a class="code hl_function" href="classiceberg_1_1DefaultTimer.html#a5f12e8509b6cda2f688d175787088279">Record</a>(std::chrono::nanoseconds duration) <span class="keyword">override</span>;</div> |
| <div class="line"><a id="l00157" name="l00157"></a><span class="lineno"><a class="line" href="classiceberg_1_1DefaultTimer.html#a730501496959c45605b4735823760a25"> 157</a></span> std::string_view <a class="code hl_function" href="classiceberg_1_1DefaultTimer.html#a730501496959c45605b4735823760a25">Unit</a>()<span class="keyword"> const override </span>{ <span class="keywordflow">return</span> ToString(unit_); }</div> |
| <div class="line"><a id="l00158" name="l00158"></a><span class="lineno"> 158</span> </div> |
| <div class="line"><a id="l00159" name="l00159"></a><span class="lineno"> 159</span> <span class="keyword">private</span>:</div> |
| <div class="line"><a id="l00160" name="l00160"></a><span class="lineno"> 160</span> std::atomic<int64_t> count_{0};</div> |
| <div class="line"><a id="l00161" name="l00161"></a><span class="lineno"> 161</span> std::atomic<int64_t> total_nanos_{0};</div> |
| <div class="line"><a id="l00162" name="l00162"></a><span class="lineno"> 162</span> <a class="code hl_enumeration" href="namespaceiceberg.html#a392862e5026f65af0f58105ede04659a">TimerUnit</a> unit_;</div> |
| <div class="line"><a id="l00163" name="l00163"></a><span class="lineno"> 163</span>};</div> |
| </div> |
| <div class="line"><a id="l00164" name="l00164"></a><span class="lineno"> 164</span> </div> |
| <div class="line"><a id="l00165" name="l00165"></a><span class="lineno"> 165</span>} <span class="comment">// namespace iceberg</span></div> |
| <div class="ttc" id="aclassiceberg_1_1DefaultTimer_html"><div class="ttname"><a href="classiceberg_1_1DefaultTimer.html">iceberg::DefaultTimer</a></div><div class="ttdoc">Thread-safe timer backed by std::atomic<int64_t>.</div><div class="ttdef"><b>Definition</b> timer.h:150</div></div> |
| <div class="ttc" id="aclassiceberg_1_1DefaultTimer_html_a0680281fb49a3b28f17b3534beeb7849"><div class="ttname"><a href="classiceberg_1_1DefaultTimer.html#a0680281fb49a3b28f17b3534beeb7849">iceberg::DefaultTimer::Count</a></div><div class="ttdeci">int64_t Count() const override</div><div class="ttdoc">Number of timing recordings made so far.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1DefaultTimer_html_a2344941bb8e0ac6872833b067695cde0"><div class="ttname"><a href="classiceberg_1_1DefaultTimer.html#a2344941bb8e0ac6872833b067695cde0">iceberg::DefaultTimer::TotalDuration</a></div><div class="ttdeci">std::chrono::nanoseconds TotalDuration() const override</div><div class="ttdoc">Total accumulated duration across all recordings.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1DefaultTimer_html_a5f12e8509b6cda2f688d175787088279"><div class="ttname"><a href="classiceberg_1_1DefaultTimer.html#a5f12e8509b6cda2f688d175787088279">iceberg::DefaultTimer::Record</a></div><div class="ttdeci">void Record(std::chrono::nanoseconds duration) override</div><div class="ttdoc">Record a nanosecond duration directly.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1DefaultTimer_html_a730501496959c45605b4735823760a25"><div class="ttname"><a href="classiceberg_1_1DefaultTimer.html#a730501496959c45605b4735823760a25">iceberg::DefaultTimer::Unit</a></div><div class="ttdeci">std::string_view Unit() const override</div><div class="ttdoc">Return the time unit used by this timer.</div><div class="ttdef"><b>Definition</b> timer.h:157</div></div> |
| <div class="ttc" id="aclassiceberg_1_1Timer_1_1Timed_html"><div class="ttname"><a href="classiceberg_1_1Timer_1_1Timed.html">iceberg::Timer::Timed</a></div><div class="ttdoc">RAII guard that records elapsed time into a non-owning Timer on destruction.</div><div class="ttdef"><b>Definition</b> timer.h:77</div></div> |
| <div class="ttc" id="aclassiceberg_1_1Timer_1_1Timed_html_a435fc292cb438022e77ff8584a6c2c40"><div class="ttname"><a href="classiceberg_1_1Timer_1_1Timed.html#a435fc292cb438022e77ff8584a6c2c40">iceberg::Timer::Timed::Stop</a></div><div class="ttdeci">void Stop()</div><div class="ttdoc">Explicitly stop timing and record the duration.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1Timer_html"><div class="ttname"><a href="classiceberg_1_1Timer.html">iceberg::Timer</a></div><div class="ttdoc">Abstract timer for measuring operation durations.</div><div class="ttdef"><b>Definition</b> timer.h:74</div></div> |
| <div class="ttc" id="aclassiceberg_1_1Timer_html_a1a40cd3e1bd699ba5cf6787ecbb59395"><div class="ttname"><a href="classiceberg_1_1Timer.html#a1a40cd3e1bd699ba5cf6787ecbb59395">iceberg::Timer::Time</a></div><div class="ttdeci">decltype(auto) Time(Callable &&fn)</div><div class="ttdoc">Execute a callable, record its wall-clock duration, and return its result.</div><div class="ttdef"><b>Definition</b> timer.h:133</div></div> |
| <div class="ttc" id="aclassiceberg_1_1Timer_html_a221670653142490dd9b0d8f503a93fe0"><div class="ttname"><a href="classiceberg_1_1Timer.html#a221670653142490dd9b0d8f503a93fe0">iceberg::Timer::Count</a></div><div class="ttdeci">virtual int64_t Count() const =0</div><div class="ttdoc">Number of timing recordings made so far.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1Timer_html_a42e9476ad403c7bcd61327f585e51922"><div class="ttname"><a href="classiceberg_1_1Timer.html#a42e9476ad403c7bcd61327f585e51922">iceberg::Timer::Record</a></div><div class="ttdeci">void Record(std::chrono::duration< Rep, Period > duration)</div><div class="ttdoc">Record a duration of any chrono type, converting to nanoseconds.</div><div class="ttdef"><b>Definition</b> timer.h:114</div></div> |
| <div class="ttc" id="aclassiceberg_1_1Timer_html_a4a4910174c81ea6545a130e42412ad03"><div class="ttname"><a href="classiceberg_1_1Timer.html#a4a4910174c81ea6545a130e42412ad03">iceberg::Timer::Unit</a></div><div class="ttdeci">virtual std::string_view Unit() const</div><div class="ttdoc">Return the time unit used by this timer.</div><div class="ttdef"><b>Definition</b> timer.h:119</div></div> |
| <div class="ttc" id="aclassiceberg_1_1Timer_html_a625487b1476a9c96e4c2be7443afc2aa"><div class="ttname"><a href="classiceberg_1_1Timer.html#a625487b1476a9c96e4c2be7443afc2aa">iceberg::Timer::IsNoop</a></div><div class="ttdeci">virtual bool IsNoop() const</div><div class="ttdoc">Return true if this timer is a no-op.</div><div class="ttdef"><b>Definition</b> timer.h:122</div></div> |
| <div class="ttc" id="aclassiceberg_1_1Timer_html_a9cb0b951b21d13fbab08d62ce8152ee6"><div class="ttname"><a href="classiceberg_1_1Timer.html#a9cb0b951b21d13fbab08d62ce8152ee6">iceberg::Timer::TotalDuration</a></div><div class="ttdeci">virtual std::chrono::nanoseconds TotalDuration() const =0</div><div class="ttdoc">Total accumulated duration across all recordings.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1Timer_html_aa52e69efb7f9bedcdc150a46f2b7c08c"><div class="ttname"><a href="classiceberg_1_1Timer.html#aa52e69efb7f9bedcdc150a46f2b7c08c">iceberg::Timer::Noop</a></div><div class="ttdeci">static std::shared_ptr< Timer > Noop()</div><div class="ttdoc">Return a shared no-op timer singleton.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1Timer_html_aea567b5246f94785cac35eaab22472d0"><div class="ttname"><a href="classiceberg_1_1Timer.html#aea567b5246f94785cac35eaab22472d0">iceberg::Timer::Record</a></div><div class="ttdeci">virtual void Record(std::chrono::nanoseconds duration)=0</div><div class="ttdoc">Record a nanosecond duration directly.</div></div> |
| <div class="ttc" id="aclassiceberg_1_1Timer_html_af19032db807f4c8890aae045e3384a7f"><div class="ttname"><a href="classiceberg_1_1Timer.html#af19032db807f4c8890aae045e3384a7f">iceberg::Timer::Start</a></div><div class="ttdeci">Timed Start()</div><div class="ttdoc">Start timing and return a RAII Timed guard.</div></div> |
| <div class="ttc" id="aiceberg__export_8h_html"><div class="ttname"><a href="iceberg__export_8h.html">iceberg_export.h</a></div><div class="ttdoc">Define symbol visibility macros for core Iceberg APIs.</div></div> |
| <div class="ttc" id="anamespaceiceberg_html"><div class="ttname"><a href="namespaceiceberg.html">iceberg</a></div><div class="ttdoc">Core Apache Iceberg C++ APIs.</div><div class="ttdef"><b>Definition</b> arrow_io_util.h:33</div></div> |
| <div class="ttc" id="anamespaceiceberg_html_a392862e5026f65af0f58105ede04659a"><div class="ttname"><a href="namespaceiceberg.html#a392862e5026f65af0f58105ede04659a">iceberg::TimerUnit</a></div><div class="ttdeci">TimerUnit</div><div class="ttdoc">Time units supported by Timer.</div><div class="ttdef"><b>Definition</b> timer.h:39</div></div> |
| <div class="ttc" id="anamespaceiceberg_html_a67197636ef5578a5ddd401c59a449164"><div class="ttname"><a href="namespaceiceberg.html#a67197636ef5578a5ddd401c59a449164">iceberg::ToString</a></div><div class="ttdeci">ICEBERG_EXPORT std::string_view ToString(Expression::Operation op)</div><div class="ttdoc">Returns a string representation of an expression operation.</div></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <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> |
