| <!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::Counter 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&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> |
| <!-- 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_1Counter.html">Counter</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="classiceberg_1_1Counter-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">iceberg::Counter Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Abstract counter for tracking event totals. |
| <a href="classiceberg_1_1Counter.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="counter_8h_source.html">counter.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for iceberg::Counter:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classiceberg_1_1Counter.png" usemap="#iceberg::Counter_map" alt=""/> |
| <map id="iceberg::Counter_map" name="iceberg::Counter_map"> |
| <area href="classiceberg_1_1DefaultCounter.html" title="Thread-safe counter backed by std::atomic<int64_t>." alt="iceberg::DefaultCounter" shape="rect" coords="0,56,146,80"/> |
| </map> |
| </div></div> |
| <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:a0965723bf9e3f7b4009bc4a7bd89018b" id="r_a0965723bf9e3f7b4009bc4a7bd89018b"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Counter.html#a0965723bf9e3f7b4009bc4a7bd89018b">Increment</a> ()</td></tr> |
| <tr class="memdesc:a0965723bf9e3f7b4009bc4a7bd89018b"><td class="mdescLeft"> </td><td class="mdescRight">Increment the counter by 1. <br /></td></tr> |
| <tr class="separator:a0965723bf9e3f7b4009bc4a7bd89018b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aad8a97ad01443e996ed96a1a9c3a5f5e" id="r_aad8a97ad01443e996ed96a1a9c3a5f5e"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Counter.html#aad8a97ad01443e996ed96a1a9c3a5f5e">Increment</a> (int64_t amount)=0</td></tr> |
| <tr class="memdesc:aad8a97ad01443e996ed96a1a9c3a5f5e"><td class="mdescLeft"> </td><td class="mdescRight">Increment the counter by the given amount. <br /></td></tr> |
| <tr class="separator:aad8a97ad01443e996ed96a1a9c3a5f5e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa4eba5ccee954626fc99ffd160231544" id="r_aa4eba5ccee954626fc99ffd160231544"><td class="memItemLeft" align="right" valign="top">virtual int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Counter.html#aa4eba5ccee954626fc99ffd160231544">value</a> () const =0</td></tr> |
| <tr class="memdesc:aa4eba5ccee954626fc99ffd160231544"><td class="mdescLeft"> </td><td class="mdescRight">Return the current count. <br /></td></tr> |
| <tr class="separator:aa4eba5ccee954626fc99ffd160231544"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af8acff891a14876b873ea95a6cb28416" id="r_af8acff891a14876b873ea95a6cb28416"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceiceberg.html#ab43be837ffa520a0d8a9186d90edac43">CounterUnit</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1Counter.html#af8acff891a14876b873ea95a6cb28416">unit</a> () const</td></tr> |
| <tr class="memdesc:af8acff891a14876b873ea95a6cb28416"><td class="mdescLeft"> </td><td class="mdescRight">Return the unit for this counter. <br /></td></tr> |
| <tr class="separator:af8acff891a14876b873ea95a6cb28416"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4cbbb6328f3e3a62a91dd3584b5bce93" id="r_a4cbbb6328f3e3a62a91dd3584b5bce93"><td class="memItemLeft" align="right" valign="top"><a id="a4cbbb6328f3e3a62a91dd3584b5bce93" name="a4cbbb6328f3e3a62a91dd3584b5bce93"></a> |
| virtual bool </td><td class="memItemRight" valign="bottom"><b>IsNoop</b> () const</td></tr> |
| <tr class="memdesc:a4cbbb6328f3e3a62a91dd3584b5bce93"><td class="mdescLeft"> </td><td class="mdescRight">Return true if this counter is a no-op. <br /></td></tr> |
| <tr class="separator:a4cbbb6328f3e3a62a91dd3584b5bce93"><td class="memSeparator" colspan="2"> </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:a2d986f9ececc9fb8ed392f4bf717efc5" id="r_a2d986f9ececc9fb8ed392f4bf717efc5"><td class="memItemLeft" align="right" valign="top"><a id="a2d986f9ececc9fb8ed392f4bf717efc5" name="a2d986f9ececc9fb8ed392f4bf717efc5"></a> |
| static std::shared_ptr< <a class="el" href="classiceberg_1_1Counter.html">Counter</a> > </td><td class="memItemRight" valign="bottom"><b>Noop</b> ()</td></tr> |
| <tr class="memdesc:a2d986f9ececc9fb8ed392f4bf717efc5"><td class="mdescLeft"> </td><td class="mdescRight">Return a shared no-op counter singleton. <br /></td></tr> |
| <tr class="separator:a2d986f9ececc9fb8ed392f4bf717efc5"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Abstract counter for tracking event totals. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a0965723bf9e3f7b4009bc4a7bd89018b" name="a0965723bf9e3f7b4009bc4a7bd89018b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a0965723bf9e3f7b4009bc4a7bd89018b">◆ </a></span>Increment() <span class="overload">[1/2]</span></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::Counter::Increment </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></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>Increment the counter by 1. </p> |
| |
| <p>Reimplemented in <a class="el" href="classiceberg_1_1DefaultCounter.html#a0965723bf9e3f7b4009bc4a7bd89018b">iceberg::DefaultCounter</a>.</p> |
| |
| </div> |
| </div> |
| <a id="aad8a97ad01443e996ed96a1a9c3a5f5e" name="aad8a97ad01443e996ed96a1a9c3a5f5e"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aad8a97ad01443e996ed96a1a9c3a5f5e">◆ </a></span>Increment() <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">virtual void iceberg::Counter::Increment </td> |
| <td>(</td> |
| <td class="paramtype">int64_t </td> |
| <td class="paramname"><em>amount</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>Increment the counter by the given amount. </p> |
| |
| <p>Implemented in <a class="el" href="classiceberg_1_1DefaultCounter.html#ae97b2a6181277ee88b02c24a9df22617">iceberg::DefaultCounter</a>, and <a class="el" href="classiceberg_1_1DefaultCounter.html#aad8a97ad01443e996ed96a1a9c3a5f5e">iceberg::DefaultCounter</a>.</p> |
| |
| </div> |
| </div> |
| <a id="af8acff891a14876b873ea95a6cb28416" name="af8acff891a14876b873ea95a6cb28416"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#af8acff891a14876b873ea95a6cb28416">◆ </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 <a class="el" href="namespaceiceberg.html#ab43be837ffa520a0d8a9186d90edac43">CounterUnit</a> iceberg::Counter::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 unit for this counter. </p> |
| |
| <p>Reimplemented in <a class="el" href="classiceberg_1_1DefaultCounter.html#ad3683916f690d75bc3bb55d1c52808fc">iceberg::DefaultCounter</a>.</p> |
| |
| </div> |
| </div> |
| <a id="aa4eba5ccee954626fc99ffd160231544" name="aa4eba5ccee954626fc99ffd160231544"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa4eba5ccee954626fc99ffd160231544">◆ </a></span>value()</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::Counter::value </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>Return the current count. </p> |
| |
| <p>Implemented in <a class="el" href="classiceberg_1_1DefaultCounter.html#ac68e8d544e1d509bf78073b6417db888">iceberg::DefaultCounter</a>.</p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>iceberg/metrics/<a class="el" href="counter_8h_source.html">counter.h</a></li> |
| </ul> |
| </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> |
