blob: 49e78ab3e414db9d8a73bfbff70d17713c6525a0 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>Apache Mesos: 3rdparty/libprocess/include/process/metrics/counter.hpp 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="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 style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Apache Mesos
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_8cab8f464681f7cc51cee77e79a434cd.html">3rdparty</a></li><li class="navelem"><a class="el" href="dir_043a76de98701f9bddf61b5e98f305ff.html">libprocess</a></li><li class="navelem"><a class="el" href="dir_eac18f7a64f6f8afbd1493ef4e09abdb.html">include</a></li><li class="navelem"><a class="el" href="dir_1894286df79cf582d947dbc4268b06cf.html">process</a></li><li class="navelem"><a class="el" href="dir_0c2042cbda9076eebbde73e7b1892dff.html">metrics</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">counter.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="counter_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">// you may not use this file except in compliance with the License.</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">// http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">//</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">// Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">// distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// limitations under the License</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#ifndef __PROCESS_METRICS_COUNTER_HPP__</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define __PROCESS_METRICS_COUNTER_HPP__</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &lt;memory&gt;</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="metric_8hpp.html">process/metrics/metric.hpp</a>&gt;</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceos.html#ae19e4161a51b86a1f330f3bf1dc75389">process</a> {</div>
<div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="namespaceprocess_1_1metrics.html"> 22</a></span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceprocess_1_1metrics_1_1internal.html#aaa37243f659788386a13de558eba70a7">metrics</a> {</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment">// A Metric that represents an integer value that can be incremented and</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="comment">// decremented.</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="classprocess_1_1metrics_1_1Counter.html"> 26</a></span>&#160;<span class="keyword">class </span><a class="code" href="classprocess_1_1metrics_1_1Counter.html">Counter</a> : <span class="keyword">public</span> <a class="code" href="classprocess_1_1metrics_1_1Metric.html">Metric</a></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;{</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="keyword">public</span>:</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; <span class="comment">// &#39;name&#39; is the unique name for the instance of Counter being constructed.</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <span class="comment">// This is what will be used as the key in the JSON endpoint.</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="comment">// &#39;window&#39; is the amount of history to keep for this Metric.</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <a class="code" href="classprocess_1_1metrics_1_1Counter.html">Counter</a>(<span class="keyword">const</span> std::string&amp; <a class="code" href="classprocess_1_1metrics_1_1Metric.html#a5b8063ac3b08d202c2f1736661ba1950">name</a>, <span class="keyword">const</span> <a class="code" href="classOption.html">Option&lt;Duration&gt;</a>&amp; <a class="code" href="classprocess_1_1metrics_1_1Counter.html#aa238bccd62145967b0db2c9624353d7b">window</a> = <a class="code" href="structNone.html">None</a>())</div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="classprocess_1_1metrics_1_1Counter.html#aa238bccd62145967b0db2c9624353d7b"> 33</a></span>&#160; : <a class="code" href="classprocess_1_1metrics_1_1Metric.html">Metric</a>(name, <a class="code" href="classprocess_1_1metrics_1_1Counter.html#aa238bccd62145967b0db2c9624353d7b">window</a>),</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; data(new Data())</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; {</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <a class="code" href="classprocess_1_1metrics_1_1Metric.html#a062843ad9a1376532c176370a09e29d2">push</a>(static_cast&lt;double&gt;(data-&gt;value.load()));</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; }</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;</div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classprocess_1_1metrics_1_1Counter.html#af423056f1c102a5660ed8984fd3b8120"> 39</a></span>&#160; <span class="keyword">virtual</span> <a class="code" href="classprocess_1_1metrics_1_1Counter.html#af423056f1c102a5660ed8984fd3b8120">~Counter</a>() {}</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;</div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="classprocess_1_1metrics_1_1Counter.html#a5c3ebc2a8264cd0bb05ce6196e290d08"> 41</a></span>&#160; <span class="keyword">virtual</span> <a class="code" href="classprocess_1_1Future.html">Future&lt;double&gt;</a> <a class="code" href="classprocess_1_1metrics_1_1Counter.html#a5c3ebc2a8264cd0bb05ce6196e290d08">value</a>()<span class="keyword"> const</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="keyword"> </span>{</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <span class="keywordflow">return</span> <span class="keyword">static_cast&lt;</span><span class="keywordtype">double</span><span class="keyword">&gt;</span>(data-&gt;value.load());</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; }</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="classprocess_1_1metrics_1_1Counter.html#a17afc8a0d6eb1b014fffcd6b43c2f796"> 46</a></span>&#160; <span class="keywordtype">void</span> <a class="code" href="classprocess_1_1metrics_1_1Counter.html#a17afc8a0d6eb1b014fffcd6b43c2f796">reset</a>()</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; {</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; data-&gt;value.store(0);</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <a class="code" href="classprocess_1_1metrics_1_1Metric.html#a062843ad9a1376532c176370a09e29d2">push</a>(0);</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; }</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div>
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="classprocess_1_1metrics_1_1Counter.html#ae85a67e0df8790e45fe573b8891c5aa3"> 52</a></span>&#160; <a class="code" href="classprocess_1_1metrics_1_1Counter.html">Counter</a>&amp; <a class="code" href="classprocess_1_1metrics_1_1Counter.html#ae85a67e0df8790e45fe573b8891c5aa3">operator++</a>()</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; {</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keywordflow">return</span> *<span class="keyword">this</span> += 1;</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; }</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;</div>
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="classprocess_1_1metrics_1_1Counter.html#aed0d801636195217cace5fa9ba551368"> 57</a></span>&#160; <a class="code" href="classprocess_1_1metrics_1_1Counter.html">Counter</a> <a class="code" href="classprocess_1_1metrics_1_1Counter.html#aed0d801636195217cace5fa9ba551368">operator++</a>(<span class="keywordtype">int</span>)</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; {</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; <a class="code" href="classprocess_1_1metrics_1_1Counter.html">Counter</a> c(*<span class="keyword">this</span>);</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; ++(*this);</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; <span class="keywordflow">return</span> c;</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; }</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160;</div>
<div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="classprocess_1_1metrics_1_1Counter.html#ad6c58e7eb5f6d5827894234f6c88a047"> 64</a></span>&#160; <a class="code" href="classprocess_1_1metrics_1_1Counter.html">Counter</a>&amp; <a class="code" href="classprocess_1_1metrics_1_1Counter.html#ad6c58e7eb5f6d5827894234f6c88a047">operator+=</a>(int64_t v)</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; {</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; int64_t prev = data-&gt;value.fetch_add(v);</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <a class="code" href="classprocess_1_1metrics_1_1Metric.html#a062843ad9a1376532c176370a09e29d2">push</a>(static_cast&lt;double&gt;(prev + v));</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; <span class="keywordflow">return</span> *<span class="keyword">this</span>;</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; }</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160;</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;<span class="keyword">private</span>:</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; <span class="keyword">struct </span>Data</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; {</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160; <span class="keyword">explicit</span> Data() : <a class="code" href="classprocess_1_1metrics_1_1Counter.html#a5c3ebc2a8264cd0bb05ce6196e290d08">value</a>(0) {}</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; std::atomic&lt;int64_t&gt; <a class="code" href="classprocess_1_1metrics_1_1Counter.html#a5c3ebc2a8264cd0bb05ce6196e290d08">value</a>;</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; };</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160;</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; std::shared_ptr&lt;Data&gt; data;</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;};</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;} <span class="comment">// namespace metrics {</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160;} <span class="comment">// namespace process {</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160;<span class="preprocessor">#endif // __PROCESS_METRICS_COUNTER_HPP__</span></div>
<div class="ttc" id="classOption_html"><div class="ttname"><a href="classOption.html">Option&lt; Duration &gt;</a></div></div>
<div class="ttc" id="metric_8hpp_html"><div class="ttname"><a href="metric_8hpp.html">metric.hpp</a></div></div>
<div class="ttc" id="classprocess_1_1metrics_1_1Counter_html_af423056f1c102a5660ed8984fd3b8120"><div class="ttname"><a href="classprocess_1_1metrics_1_1Counter.html#af423056f1c102a5660ed8984fd3b8120">process::metrics::Counter::~Counter</a></div><div class="ttdeci">virtual ~Counter()</div><div class="ttdef"><b>Definition:</b> counter.hpp:39</div></div>
<div class="ttc" id="classprocess_1_1metrics_1_1Counter_html_a5c3ebc2a8264cd0bb05ce6196e290d08"><div class="ttname"><a href="classprocess_1_1metrics_1_1Counter.html#a5c3ebc2a8264cd0bb05ce6196e290d08">process::metrics::Counter::value</a></div><div class="ttdeci">virtual Future&lt; double &gt; value() const </div><div class="ttdef"><b>Definition:</b> counter.hpp:41</div></div>
<div class="ttc" id="classprocess_1_1metrics_1_1Metric_html"><div class="ttname"><a href="classprocess_1_1metrics_1_1Metric.html">process::metrics::Metric</a></div><div class="ttdef"><b>Definition:</b> metric.hpp:33</div></div>
<div class="ttc" id="classprocess_1_1metrics_1_1Counter_html_ae85a67e0df8790e45fe573b8891c5aa3"><div class="ttname"><a href="classprocess_1_1metrics_1_1Counter.html#ae85a67e0df8790e45fe573b8891c5aa3">process::metrics::Counter::operator++</a></div><div class="ttdeci">Counter &amp; operator++()</div><div class="ttdef"><b>Definition:</b> counter.hpp:52</div></div>
<div class="ttc" id="classprocess_1_1metrics_1_1Counter_html"><div class="ttname"><a href="classprocess_1_1metrics_1_1Counter.html">process::metrics::Counter</a></div><div class="ttdef"><b>Definition:</b> counter.hpp:26</div></div>
<div class="ttc" id="classprocess_1_1metrics_1_1Counter_html_aed0d801636195217cace5fa9ba551368"><div class="ttname"><a href="classprocess_1_1metrics_1_1Counter.html#aed0d801636195217cace5fa9ba551368">process::metrics::Counter::operator++</a></div><div class="ttdeci">Counter operator++(int)</div><div class="ttdef"><b>Definition:</b> counter.hpp:57</div></div>
<div class="ttc" id="classprocess_1_1metrics_1_1Counter_html_a17afc8a0d6eb1b014fffcd6b43c2f796"><div class="ttname"><a href="classprocess_1_1metrics_1_1Counter.html#a17afc8a0d6eb1b014fffcd6b43c2f796">process::metrics::Counter::reset</a></div><div class="ttdeci">void reset()</div><div class="ttdef"><b>Definition:</b> counter.hpp:46</div></div>
<div class="ttc" id="classprocess_1_1metrics_1_1Counter_html_ad6c58e7eb5f6d5827894234f6c88a047"><div class="ttname"><a href="classprocess_1_1metrics_1_1Counter.html#ad6c58e7eb5f6d5827894234f6c88a047">process::metrics::Counter::operator+=</a></div><div class="ttdeci">Counter &amp; operator+=(int64_t v)</div><div class="ttdef"><b>Definition:</b> counter.hpp:64</div></div>
<div class="ttc" id="namespaceos_html_ae19e4161a51b86a1f330f3bf1dc75389"><div class="ttname"><a href="namespaceos.html#ae19e4161a51b86a1f330f3bf1dc75389">os::process</a></div><div class="ttdeci">Result&lt; Process &gt; process(pid_t pid)</div><div class="ttdef"><b>Definition:</b> freebsd.hpp:30</div></div>
<div class="ttc" id="structNone_html"><div class="ttname"><a href="structNone.html">None</a></div><div class="ttdef"><b>Definition:</b> none.hpp:27</div></div>
<div class="ttc" id="classprocess_1_1metrics_1_1Metric_html_a5b8063ac3b08d202c2f1736661ba1950"><div class="ttname"><a href="classprocess_1_1metrics_1_1Metric.html#a5b8063ac3b08d202c2f1736661ba1950">process::metrics::Metric::name</a></div><div class="ttdeci">const std::string &amp; name() const </div><div class="ttdef"><b>Definition:</b> metric.hpp:39</div></div>
<div class="ttc" id="classprocess_1_1metrics_1_1Counter_html_aa238bccd62145967b0db2c9624353d7b"><div class="ttname"><a href="classprocess_1_1metrics_1_1Counter.html#aa238bccd62145967b0db2c9624353d7b">process::metrics::Counter::window</a></div><div class="ttdeci">window</div><div class="ttdef"><b>Definition:</b> counter.hpp:33</div></div>
<div class="ttc" id="classprocess_1_1metrics_1_1Metric_html_a062843ad9a1376532c176370a09e29d2"><div class="ttname"><a href="classprocess_1_1metrics_1_1Metric.html#a062843ad9a1376532c176370a09e29d2">process::metrics::Metric::push</a></div><div class="ttdeci">void push(double value)</div><div class="ttdef"><b>Definition:</b> metric.hpp:63</div></div>
<div class="ttc" id="namespaceprocess_1_1metrics_1_1internal_html_aaa37243f659788386a13de558eba70a7"><div class="ttname"><a href="namespaceprocess_1_1metrics_1_1internal.html#aaa37243f659788386a13de558eba70a7">process::metrics::internal::metrics</a></div><div class="ttdeci">PID&lt; MetricsProcess &gt; metrics</div></div>
<div class="ttc" id="classprocess_1_1Future_html"><div class="ttname"><a href="classprocess_1_1Future.html">process::Future</a></div><div class="ttdef"><b>Definition:</b> future.hpp:56</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>