| <!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/profiler.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> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">profiler.hpp</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="profiler_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_PROFILER_HPP__</span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor"></span><span class="preprocessor">#define __PROCESS_PROFILER_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 <string></span></div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include <<a class="code" href="future_8hpp.html">process/future.hpp</a>></span></div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include <<a class="code" href="3rdparty_2libprocess_2include_2process_2http_8hpp.html">process/http.hpp</a>></span></div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <<a class="code" href="libprocess_2include_2process_2process_8hpp.html">process/process.hpp</a>></span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">namespace </span><a class="code" href="namespaceos.html#ae19e4161a51b86a1f330f3bf1dc75389">process</a> {</div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> </div> |
| <div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="classprocess_1_1Profiler.html"> 24</a></span> <span class="keyword">class </span><a class="code" href="classprocess_1_1Profiler.html">Profiler</a> : <span class="keyword">public</span> <a class="code" href="classprocess_1_1Process.html">Process</a><Profiler></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="keyword">public</span>:</div> |
| <div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="classprocess_1_1Profiler.html#ac3603ac30749c5f0bc2321769b9bb9a8"> 27</a></span>  <a class="code" href="classprocess_1_1Profiler.html#ac3603ac30749c5f0bc2321769b9bb9a8">Profiler</a>(<span class="keyword">const</span> <a class="code" href="classOption.html">Option<std::string></a>& _authenticationRealm)</div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  : <a class="code" href="classprocess_1_1ProcessBase.html">ProcessBase</a>(<span class="stringliteral">"profiler"</span>),</div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  authenticationRealm(_authenticationRealm) {}</div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div> |
| <div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classprocess_1_1Profiler.html#aa52326399566831ab756a60cd341182b"> 31</a></span>  <span class="keyword">virtual</span> <a class="code" href="classprocess_1_1Profiler.html#aa52326399566831ab756a60cd341182b">~Profiler</a>() {}</div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">protected</span>:</div> |
| <div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="classprocess_1_1Profiler.html#a9131797d93999031d9e732c8a2d45da4"> 34</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classprocess_1_1Profiler.html#a9131797d93999031d9e732c8a2d45da4">initialize</a>()</div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  {</div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keywordflow">if</span> (authenticationRealm.<a class="code" href="classOption.html#a4e3bf8416d95246f43c91f1b5c309323">isSome</a>()) {</div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <a class="code" href="classprocess_1_1ProcessBase.html#af0d1a6f8da798dfb2b6ea92550b8c6f5">route</a>(<span class="stringliteral">"/start"</span>,</div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  authenticationRealm.<a class="code" href="classOption.html#a21358442c0fac1cc978a67a9a9089a79">get</a>(),</div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  START_HELP(),</div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  &Profiler::start);</div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> </div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <a class="code" href="classprocess_1_1ProcessBase.html#af0d1a6f8da798dfb2b6ea92550b8c6f5">route</a>(<span class="stringliteral">"/stop"</span>,</div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  authenticationRealm.<a class="code" href="classOption.html#a21358442c0fac1cc978a67a9a9089a79">get</a>(),</div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  STOP_HELP(),</div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  &Profiler::stop);</div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  } <span class="keywordflow">else</span> {</div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <a class="code" href="classprocess_1_1ProcessBase.html#af0d1a6f8da798dfb2b6ea92550b8c6f5">route</a>(<span class="stringliteral">"/start"</span>,</div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  START_HELP(),</div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  [<span class="keyword">this</span>](<span class="keyword">const</span> <a class="code" href="structprocess_1_1http_1_1Request.html">http::Request</a>& <a class="code" href="namespaceprocess_1_1http.html#ad8f400b5e54038df7e5662ec35da05fa">request</a>) {</div> |
| <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordflow">return</span> Profiler::start(request, <a class="code" href="structNone.html">None</a>());</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> </div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <a class="code" href="classprocess_1_1ProcessBase.html#af0d1a6f8da798dfb2b6ea92550b8c6f5">route</a>(<span class="stringliteral">"/stop"</span>,</div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  STOP_HELP(),</div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  [<span class="keyword">this</span>](<span class="keyword">const</span> <a class="code" href="structprocess_1_1http_1_1Request.html">http::Request</a>& request) {</div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordflow">return</span> Profiler::stop(request, <a class="code" href="structNone.html">None</a>());</div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  });</div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  }</div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  }</div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div> |
| <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="keyword">private</span>:</div> |
| <div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">static</span> <span class="keyword">const</span> std::string START_HELP();</div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">static</span> <span class="keyword">const</span> std::string STOP_HELP();</div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div> |
| <div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="comment">// HTTP endpoints.</span></div> |
| <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div> |
| <div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="comment">// Starts the profiler. There are no request parameters.</span></div> |
| <div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <a class="code" href="classprocess_1_1Future.html">Future<http::Response></a> start(</div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  <span class="keyword">const</span> <a class="code" href="structprocess_1_1http_1_1Request.html">http::Request</a>& <a class="code" href="namespaceprocess_1_1http.html#ad8f400b5e54038df7e5662ec35da05fa">request</a>,</div> |
| <div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">const</span> <a class="code" href="classOption.html">Option<http::authentication::Principal></a>&);</div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div> |
| <div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="comment">// Stops the profiler. There are no request parameters.</span></div> |
| <div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="comment">// This returns the profile output, it will also remain present</span></div> |
| <div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="comment">// in the working directory.</span></div> |
| <div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <a class="code" href="classprocess_1_1Future.html">Future<http::Response></a> stop(</div> |
| <div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keyword">const</span> <a class="code" href="structprocess_1_1http_1_1Request.html">http::Request</a>& <a class="code" href="namespaceprocess_1_1http.html#ad8f400b5e54038df7e5662ec35da05fa">request</a>,</div> |
| <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keyword">const</span> <a class="code" href="classOption.html">Option<http::authentication::Principal></a>&);</div> |
| <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> </div> |
| <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="comment">// The authentication realm that the profiler's HTTP endpoints will be</span></div> |
| <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="comment">// installed into.</span></div> |
| <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <a class="code" href="classOption.html">Option<std::string></a> authenticationRealm;</div> |
| <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> };</div> |
| <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div> |
| <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> } <span class="comment">// namespace process {</span></div> |
| <div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div> |
| <div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="preprocessor">#endif // __PROCESS_PROCESS_HPP__</span></div> |
| <div class="ttc" id="classOption_html"><div class="ttname"><a href="classOption.html">Option< std::string ></a></div></div> |
| <div class="ttc" id="classprocess_1_1Profiler_html_a9131797d93999031d9e732c8a2d45da4"><div class="ttname"><a href="classprocess_1_1Profiler.html#a9131797d93999031d9e732c8a2d45da4">process::Profiler::initialize</a></div><div class="ttdeci">virtual void initialize()</div><div class="ttdoc">Invoked when a process gets spawned. </div><div class="ttdef"><b>Definition:</b> profiler.hpp:34</div></div> |
| <div class="ttc" id="classprocess_1_1Profiler_html_ac3603ac30749c5f0bc2321769b9bb9a8"><div class="ttname"><a href="classprocess_1_1Profiler.html#ac3603ac30749c5f0bc2321769b9bb9a8">process::Profiler::Profiler</a></div><div class="ttdeci">Profiler(const Option< std::string > &_authenticationRealm)</div><div class="ttdef"><b>Definition:</b> profiler.hpp:27</div></div> |
| <div class="ttc" id="namespaceprocess_1_1http_html_ad8f400b5e54038df7e5662ec35da05fa"><div class="ttname"><a href="namespaceprocess_1_1http.html#ad8f400b5e54038df7e5662ec35da05fa">process::http::request</a></div><div class="ttdeci">Future< Response > request(const Request &request, bool streamedResponse=false)</div><div class="ttdoc">Asynchronously sends an HTTP request to the process and returns the HTTP response once the entire res...</div></div> |
| <div class="ttc" id="classprocess_1_1Profiler_html"><div class="ttname"><a href="classprocess_1_1Profiler.html">process::Profiler</a></div><div class="ttdef"><b>Definition:</b> profiler.hpp:24</div></div> |
| <div class="ttc" id="classprocess_1_1ProcessBase_html"><div class="ttname"><a href="classprocess_1_1ProcessBase.html">process::ProcessBase</a></div><div class="ttdef"><b>Definition:</b> process.hpp:69</div></div> |
| <div class="ttc" id="classprocess_1_1ProcessBase_html_af0d1a6f8da798dfb2b6ea92550b8c6f5"><div class="ttname"><a href="classprocess_1_1ProcessBase.html#af0d1a6f8da798dfb2b6ea92550b8c6f5">process::ProcessBase::route</a></div><div class="ttdeci">void route(const std::string &name, const Option< std::string > &help, const HttpRequestHandler &handler, const RouteOptions &options=RouteOptions())</div><div class="ttdoc">Sets up a handler for HTTP requests with the specified name. </div></div> |
| <div class="ttc" id="classOption_html_a4e3bf8416d95246f43c91f1b5c309323"><div class="ttname"><a href="classOption.html#a4e3bf8416d95246f43c91f1b5c309323">Option::isSome</a></div><div class="ttdeci">bool isSome() const </div><div class="ttdef"><b>Definition:</b> option.hpp:108</div></div> |
| <div class="ttc" id="structprocess_1_1http_1_1Request_html"><div class="ttname"><a href="structprocess_1_1http_1_1Request.html">process::http::Request</a></div><div class="ttdef"><b>Definition:</b> http.hpp:511</div></div> |
| <div class="ttc" id="classOption_html_a21358442c0fac1cc978a67a9a9089a79"><div class="ttname"><a href="classOption.html#a21358442c0fac1cc978a67a9a9089a79">Option::get</a></div><div class="ttdeci">const T & get() const &</div><div class="ttdef"><b>Definition:</b> option.hpp:111</div></div> |
| <div class="ttc" id="future_8hpp_html"><div class="ttname"><a href="future_8hpp.html">future.hpp</a></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_1Profiler_html_aa52326399566831ab756a60cd341182b"><div class="ttname"><a href="classprocess_1_1Profiler.html#aa52326399566831ab756a60cd341182b">process::Profiler::~Profiler</a></div><div class="ttdeci">virtual ~Profiler()</div><div class="ttdef"><b>Definition:</b> profiler.hpp:31</div></div> |
| <div class="ttc" id="3rdparty_2libprocess_2include_2process_2http_8hpp_html"><div class="ttname"><a href="3rdparty_2libprocess_2include_2process_2http_8hpp.html">http.hpp</a></div></div> |
| <div class="ttc" id="classprocess_1_1Process_html"><div class="ttname"><a href="classprocess_1_1Process.html">process::Process</a></div><div class="ttdef"><b>Definition:</b> process.hpp:490</div></div> |
| <div class="ttc" id="libprocess_2include_2process_2process_8hpp_html"><div class="ttname"><a href="libprocess_2include_2process_2process_8hpp.html">process.hpp</a></div></div> |
| <div class="ttc" id="classprocess_1_1Future_html"><div class="ttname"><a href="classprocess_1_1Future.html">process::Future< http::Response ></a></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> |
