| <!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/gauge.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 Page</span></a></li> |
| <li><a href="pages.html"><span>Related 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 List</span></a></li> |
| <li><a href="globals.html"><span>File 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">gauge.hpp</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="gauge_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> <span class="comment">// Licensed under the Apache License, Version 2.0 (the "License");</span></div> |
| <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <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> <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> <span class="comment">//</span></div> |
| <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <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> <span class="comment">//</span></div> |
| <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <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> <span class="comment">// distributed under the License is distributed on an "AS IS" BASIS,</span></div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <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> <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> <span class="comment">// limitations under the License</span></div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div> |
| <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#ifndef __PROCESS_METRICS_GAUGE_HPP__</span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor"></span><span class="preprocessor">#define __PROCESS_METRICS_GAUGE_HPP__</span></div> |
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor"></span></div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#include <memory></span></div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#include <string></span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <<a class="code" href="defer_8hpp.html">process/defer.hpp</a>></span></div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <<a class="code" href="metric_8hpp.html">process/metrics/metric.hpp</a>></span></div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">namespace </span><a class="code" href="namespaceos.html#ae19e4161a51b86a1f330f3bf1dc75389">process</a> {</div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="keyword">namespace </span><a class="code" href="namespaceprocess_1_1metrics_1_1internal.html#aaa37243f659788386a13de558eba70a7">metrics</a> {</div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">// A Metric that represents an instantaneous value evaluated when</span></div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">// 'value' is called.</span></div> |
| <div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="classprocess_1_1metrics_1_1Gauge.html"> 28</a></span> <span class="keyword">class </span><a class="code" href="classprocess_1_1metrics_1_1Gauge.html">Gauge</a> : <span class="keyword">public</span> <a class="code" href="classprocess_1_1metrics_1_1Metric.html">Metric</a></div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> {</div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="comment">// 'name' is the unique name for the instance of Gauge being constructed.</span></div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="comment">// It will be the key exposed in the JSON endpoint.</span></div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="comment">// 'f' is the deferred object called when the Metric value is requested.</span></div> |
| <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <a class="code" href="classprocess_1_1metrics_1_1Gauge.html">Gauge</a>(<span class="keyword">const</span> std::string& <a class="code" href="classprocess_1_1metrics_1_1Metric.html#a5b8063ac3b08d202c2f1736661ba1950">name</a>, <span class="keyword">const</span> <a class="code" href="structprocess_1_1Deferred.html">Deferred</a><<a class="code" href="classprocess_1_1Future.html">Future<double></a>()>& <a class="code" href="namespaceprocess.html#a62d5333e8ec1817c249cf83e15d568b4">f</a>)</div> |
| <div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="classprocess_1_1metrics_1_1Gauge.html#a5e6c3b399455a55fec650f2378c21e96"> 35</a></span>  : <a class="code" href="classprocess_1_1metrics_1_1Metric.html">Metric</a>(name, <a class="code" href="structNone.html">None</a>()), data(new Data(<a class="code" href="namespaceprocess.html#a62d5333e8ec1817c249cf83e15d568b4">f</a>)) {}</div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div> |
| <div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classprocess_1_1metrics_1_1Gauge.html#a8a783b21fba945adfb163fdcb2dc4c1c"> 37</a></span>  <span class="keyword">virtual</span> <a class="code" href="classprocess_1_1metrics_1_1Gauge.html#a8a783b21fba945adfb163fdcb2dc4c1c">~Gauge</a>() {}</div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div> |
| <div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classprocess_1_1metrics_1_1Gauge.html#a0568e9b2c5b9b2ac72ed6cf71dc24fdc"> 39</a></span>  <span class="keyword">virtual</span> <a class="code" href="classprocess_1_1Future.html">Future<double></a> <a class="code" href="classprocess_1_1metrics_1_1Gauge.html#a0568e9b2c5b9b2ac72ed6cf71dc24fdc">value</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> data->f(); }</div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">private</span>:</div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">struct </span>Data</div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  {</div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">explicit</span> Data(<span class="keyword">const</span> <a class="code" href="structprocess_1_1Deferred.html">Deferred</a><<a class="code" href="classprocess_1_1Future.html">Future<double></a>()>& _f) : <a class="code" href="namespaceprocess.html#a62d5333e8ec1817c249cf83e15d568b4">f</a>(_f) {}</div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">const</span> <a class="code" href="structprocess_1_1Deferred.html">Deferred<Future<double></a>()> <a class="code" href="namespaceprocess.html#a62d5333e8ec1817c249cf83e15d568b4">f</a>;</div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  };</div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  std::shared_ptr<Data> data;</div> |
| <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> };</div> |
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> } <span class="comment">// namespace metrics {</span></div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> } <span class="comment">// namespace process {</span></div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor">#endif // __PROCESS_METRICS_GAUGE_HPP__</span></div> |
| <div class="ttc" id="namespaceprocess_html_a62d5333e8ec1817c249cf83e15d568b4"><div class="ttname"><a href="namespaceprocess.html#a62d5333e8ec1817c249cf83e15d568b4">process::f</a></div><div class="ttdeci">F && f</div><div class="ttdef"><b>Definition:</b> defer.hpp:239</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_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_1Gauge_html_a0568e9b2c5b9b2ac72ed6cf71dc24fdc"><div class="ttname"><a href="classprocess_1_1metrics_1_1Gauge.html#a0568e9b2c5b9b2ac72ed6cf71dc24fdc">process::metrics::Gauge::value</a></div><div class="ttdeci">virtual Future< double > value() const </div><div class="ttdef"><b>Definition:</b> gauge.hpp:39</div></div> |
| <div class="ttc" id="structprocess_1_1Deferred_html"><div class="ttname"><a href="structprocess_1_1Deferred.html">process::Deferred</a></div><div class="ttdef"><b>Definition:</b> deferred.hpp:29</div></div> |
| <div class="ttc" id="classprocess_1_1metrics_1_1Gauge_html"><div class="ttname"><a href="classprocess_1_1metrics_1_1Gauge.html">process::metrics::Gauge</a></div><div class="ttdef"><b>Definition:</b> gauge.hpp:28</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< Process > 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 & name() const </div><div class="ttdef"><b>Definition:</b> metric.hpp:39</div></div> |
| <div class="ttc" id="classprocess_1_1metrics_1_1Gauge_html_a8a783b21fba945adfb163fdcb2dc4c1c"><div class="ttname"><a href="classprocess_1_1metrics_1_1Gauge.html#a8a783b21fba945adfb163fdcb2dc4c1c">process::metrics::Gauge::~Gauge</a></div><div class="ttdeci">virtual ~Gauge()</div><div class="ttdef"><b>Definition:</b> gauge.hpp:37</div></div> |
| <div class="ttc" id="defer_8hpp_html"><div class="ttname"><a href="defer_8hpp.html">defer.hpp</a></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< MetricsProcess > 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  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.5 |
| </small></address> |
| </body> |
| </html> |
