| <!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: mesos::internal::checks::HealthChecker 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="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 class="current"><a href="annotated.html"><span>Classes</span></a></li> |
| <li><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="annotated.html"><span>Class List</span></a></li> |
| <li><a href="classes.html"><span>Class Index</span></a></li> |
| <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
| <li><a href="functions.html"><span>Class Members</span></a></li> |
| </ul> |
| </div> |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespacemesos.html">mesos</a></li><li class="navelem"><a class="el" href="namespacemesos_1_1internal.html">internal</a></li><li class="navelem"><a class="el" href="namespacemesos_1_1internal_1_1checks.html">checks</a></li><li class="navelem"><a class="el" href="classmesos_1_1internal_1_1checks_1_1HealthChecker.html">HealthChecker</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="classmesos_1_1internal_1_1checks_1_1HealthChecker-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">mesos::internal::checks::HealthChecker Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><code>#include <<a class="el" href="health__checker_8hpp_source.html">health_checker.hpp</a>></code></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a0b8dffb78c37dafcec2bba0b3e9c7f12"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmesos_1_1internal_1_1checks_1_1HealthChecker.html#a0b8dffb78c37dafcec2bba0b3e9c7f12">~HealthChecker</a> ()</td></tr> |
| <tr class="separator:a0b8dffb78c37dafcec2bba0b3e9c7f12"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a283bbc16f7b3bfe466850a44fa9cc25f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classmesos_1_1internal_1_1checks_1_1HealthChecker.html#a283bbc16f7b3bfe466850a44fa9cc25f">stop</a> ()</td></tr> |
| <tr class="memdesc:a283bbc16f7b3bfe466850a44fa9cc25f"><td class="mdescLeft"> </td><td class="mdescRight">Immediately stops health checking. <a href="#a283bbc16f7b3bfe466850a44fa9cc25f">More...</a><br/></td></tr> |
| <tr class="separator:a283bbc16f7b3bfe466850a44fa9cc25f"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:a022047285af3643ea7dfe0cbfe5c0bf2"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classTry.html">Try</a>< <a class="el" href="classprocess_1_1Owned.html">process::Owned</a><br class="typebreak"/> |
| < <a class="el" href="classmesos_1_1internal_1_1checks_1_1HealthChecker.html">HealthChecker</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classmesos_1_1internal_1_1checks_1_1HealthChecker.html#a022047285af3643ea7dfe0cbfe5c0bf2">create</a> (const HealthCheck &check, const std::string &launcherDir, const lambda::function< void(const TaskHealthStatus &)> &callback, const TaskID &taskId, const <a class="el" href="classOption.html">Option</a>< <a class="el" href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#ab03ced250ed239bc3b50b669493997f9">pid_t</a> > &taskPid, const std::vector< std::string > &namespaces)</td></tr> |
| <tr class="memdesc:a022047285af3643ea7dfe0cbfe5c0bf2"><td class="mdescLeft"> </td><td class="mdescRight">Attempts to create a <code><a class="el" href="classmesos_1_1internal_1_1checks_1_1HealthChecker.html">HealthChecker</a></code> object. <a href="#a022047285af3643ea7dfe0cbfe5c0bf2">More...</a><br/></td></tr> |
| <tr class="separator:a022047285af3643ea7dfe0cbfe5c0bf2"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a class="anchor" id="a0b8dffb78c37dafcec2bba0b3e9c7f12"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">mesos::internal::checks::HealthChecker::~HealthChecker </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a022047285af3643ea7dfe0cbfe5c0bf2"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">static <a class="el" href="classTry.html">Try</a><<a class="el" href="classprocess_1_1Owned.html">process::Owned</a><<a class="el" href="classmesos_1_1internal_1_1checks_1_1HealthChecker.html">HealthChecker</a>> > mesos::internal::checks::HealthChecker::create </td> |
| <td>(</td> |
| <td class="paramtype">const HealthCheck & </td> |
| <td class="paramname"><em>check</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>launcherDir</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const lambda::function< void(const TaskHealthStatus &)> & </td> |
| <td class="paramname"><em>callback</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const TaskID & </td> |
| <td class="paramname"><em>taskId</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="classOption.html">Option</a>< <a class="el" href="3rdparty_2stout_2include_2stout_2windows_8hpp.html#ab03ced250ed239bc3b50b669493997f9">pid_t</a> > & </td> |
| <td class="paramname"><em>taskPid</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const std::vector< std::string > & </td> |
| <td class="paramname"><em>namespaces</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">static</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Attempts to create a <code><a class="el" href="classmesos_1_1internal_1_1checks_1_1HealthChecker.html">HealthChecker</a></code> object. </p> |
| <p>In case of success, health checking starts immediately after initialization.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">check</td><td>The protobuf message definition of health check. </td></tr> |
| <tr><td class="paramname">launcherDir</td><td>A directory where Mesos helper binaries are located. </td></tr> |
| <tr><td class="paramname">callback</td><td>A callback <a class="el" href="classmesos_1_1internal_1_1checks_1_1HealthChecker.html">HealthChecker</a> uses to send health status updates to its owner (usually an executor). </td></tr> |
| <tr><td class="paramname">taskId</td><td>The TaskID of the target task. </td></tr> |
| <tr><td class="paramname">taskPid</td><td>The target task's pid used to enter the specified namespaces. </td></tr> |
| <tr><td class="paramname">namespaces</td><td>The namespaces to enter prior to performing the health check. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>A <code><a class="el" href="classmesos_1_1internal_1_1checks_1_1HealthChecker.html">HealthChecker</a></code> object or an error if <code>create</code> fails.</dd></dl> |
| <dl class="todo"><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd>A better approach would be to return a stream of updates, e.g., <code>process::Stream<TaskHealthStatus></code> rather than invoking a callback. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a283bbc16f7b3bfe466850a44fa9cc25f"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void mesos::internal::checks::HealthChecker::stop </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Immediately stops health checking. </p> |
| <p>Any in-flight health checks are dropped. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>src/checks/<a class="el" href="health__checker_8hpp_source.html">health_checker.hpp</a></li> |
| </ul> |
| </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> |
