classgrpc_1_1_health_check_service_interface.html 9.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.13"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>GRPC C++: grpc::HealthCheckServiceInterface Class Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. <script type="text/javascript"> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-60127042-1', 'auto'); ga('send', 'pageview'); </script></head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">GRPC C++
  25. &#160;<span id="projectnumber">1.13.0-dev</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.13 -->
  34. <script type="text/javascript">
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36. </script>
  37. <script type="text/javascript" src="menudata.js"></script>
  38. <script type="text/javascript" src="menu.js"></script>
  39. <script type="text/javascript">
  40. $(function() {
  41. initMenu('',true,false,'search.php','Search');
  42. $(document).ready(function() { init_search(); });
  43. });
  44. </script>
  45. <div id="main-nav"></div>
  46. <!-- window showing the filter options -->
  47. <div id="MSearchSelectWindow"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. onkeydown="return searchBox.OnSearchSelectKey(event)">
  51. </div>
  52. <!-- iframe showing the search results (closed by default) -->
  53. <div id="MSearchResultsWindow">
  54. <iframe src="javascript:void(0)" frameborder="0"
  55. name="MSearchResults" id="MSearchResults">
  56. </iframe>
  57. </div>
  58. <div id="nav-path" class="navpath">
  59. <ul>
  60. <li class="navelem"><a class="el" href="namespacegrpc.html">grpc</a></li><li class="navelem"><a class="el" href="classgrpc_1_1_health_check_service_interface.html">HealthCheckServiceInterface</a></li> </ul>
  61. </div>
  62. </div><!-- top -->
  63. <div class="header">
  64. <div class="summary">
  65. <a href="#pub-methods">Public Member Functions</a> </div>
  66. <div class="headertitle">
  67. <div class="title">grpc::HealthCheckServiceInterface Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
  68. </div><!--header-->
  69. <div class="contents">
  70. <p>The gRPC server uses this interface to expose the health checking service without depending on protobuf.
  71. <a href="classgrpc_1_1_health_check_service_interface.html#details">More...</a></p>
  72. <p><code>#include &lt;<a class="el" href="grpcpp_2health__check__service__interface_8h_source.html">health_check_service_interface.h</a>&gt;</code></p>
  73. <table class="memberdecls">
  74. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  75. Public Member Functions</h2></td></tr>
  76. <tr class="memitem:af72a34e5ec5cc058fd7648e235816c60"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_health_check_service_interface.html#af72a34e5ec5cc058fd7648e235816c60">~HealthCheckServiceInterface</a> ()</td></tr>
  77. <tr class="separator:af72a34e5ec5cc058fd7648e235816c60"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:a9d99470b4074938af24e5ae723301f80"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_health_check_service_interface.html#a9d99470b4074938af24e5ae723301f80">SetServingStatus</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;service_name, bool serving)=0</td></tr>
  79. <tr class="memdesc:a9d99470b4074938af24e5ae723301f80"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set or change the serving status of the given <em>service_name</em>. <a href="#a9d99470b4074938af24e5ae723301f80">More...</a><br /></td></tr>
  80. <tr class="separator:a9d99470b4074938af24e5ae723301f80"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:a2db64a471c343d96f4e8e191efce8c08"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_health_check_service_interface.html#a2db64a471c343d96f4e8e191efce8c08">SetServingStatus</a> (bool serving)=0</td></tr>
  82. <tr class="memdesc:a2db64a471c343d96f4e8e191efce8c08"><td class="mdescLeft">&#160;</td><td class="mdescRight">Apply to all registered service names. <a href="#a2db64a471c343d96f4e8e191efce8c08">More...</a><br /></td></tr>
  83. <tr class="separator:a2db64a471c343d96f4e8e191efce8c08"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. </table>
  85. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  86. <div class="textblock"><p>The gRPC server uses this interface to expose the health checking service without depending on protobuf. </p>
  87. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  88. <a id="af72a34e5ec5cc058fd7648e235816c60"></a>
  89. <h2 class="memtitle"><span class="permalink"><a href="#af72a34e5ec5cc058fd7648e235816c60">&#9670;&nbsp;</a></span>~HealthCheckServiceInterface()</h2>
  90. <div class="memitem">
  91. <div class="memproto">
  92. <table class="mlabels">
  93. <tr>
  94. <td class="mlabels-left">
  95. <table class="memname">
  96. <tr>
  97. <td class="memname">virtual grpc::HealthCheckServiceInterface::~HealthCheckServiceInterface </td>
  98. <td>(</td>
  99. <td class="paramname"></td><td>)</td>
  100. <td></td>
  101. </tr>
  102. </table>
  103. </td>
  104. <td class="mlabels-right">
  105. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  106. </tr>
  107. </table>
  108. </div><div class="memdoc">
  109. </div>
  110. </div>
  111. <h2 class="groupheader">Member Function Documentation</h2>
  112. <a id="a9d99470b4074938af24e5ae723301f80"></a>
  113. <h2 class="memtitle"><span class="permalink"><a href="#a9d99470b4074938af24e5ae723301f80">&#9670;&nbsp;</a></span>SetServingStatus() <span class="overload">[1/2]</span></h2>
  114. <div class="memitem">
  115. <div class="memproto">
  116. <table class="mlabels">
  117. <tr>
  118. <td class="mlabels-left">
  119. <table class="memname">
  120. <tr>
  121. <td class="memname">virtual void grpc::HealthCheckServiceInterface::SetServingStatus </td>
  122. <td>(</td>
  123. <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;&#160;</td>
  124. <td class="paramname"><em>service_name</em>, </td>
  125. </tr>
  126. <tr>
  127. <td class="paramkey"></td>
  128. <td></td>
  129. <td class="paramtype">bool&#160;</td>
  130. <td class="paramname"><em>serving</em>&#160;</td>
  131. </tr>
  132. <tr>
  133. <td></td>
  134. <td>)</td>
  135. <td></td><td></td>
  136. </tr>
  137. </table>
  138. </td>
  139. <td class="mlabels-right">
  140. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  141. </tr>
  142. </table>
  143. </div><div class="memdoc">
  144. <p>Set or change the serving status of the given <em>service_name</em>. </p>
  145. </div>
  146. </div>
  147. <a id="a2db64a471c343d96f4e8e191efce8c08"></a>
  148. <h2 class="memtitle"><span class="permalink"><a href="#a2db64a471c343d96f4e8e191efce8c08">&#9670;&nbsp;</a></span>SetServingStatus() <span class="overload">[2/2]</span></h2>
  149. <div class="memitem">
  150. <div class="memproto">
  151. <table class="mlabels">
  152. <tr>
  153. <td class="mlabels-left">
  154. <table class="memname">
  155. <tr>
  156. <td class="memname">virtual void grpc::HealthCheckServiceInterface::SetServingStatus </td>
  157. <td>(</td>
  158. <td class="paramtype">bool&#160;</td>
  159. <td class="paramname"><em>serving</em></td><td>)</td>
  160. <td></td>
  161. </tr>
  162. </table>
  163. </td>
  164. <td class="mlabels-right">
  165. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  166. </tr>
  167. </table>
  168. </div><div class="memdoc">
  169. <p>Apply to all registered service names. </p>
  170. </div>
  171. </div>
  172. <hr/>The documentation for this class was generated from the following file:<ul>
  173. <li>include/grpcpp/<a class="el" href="grpcpp_2health__check__service__interface_8h_source.html">health_check_service_interface.h</a></li>
  174. </ul>
  175. </div><!-- contents -->
  176. <!-- start footer part -->
  177. <hr class="footer"/><address class="footer"><small>
  178. Generated on Tue May 15 2018 17:01:01 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  179. <img class="footer" src="doxygen.png" alt="doxygen"/>
  180. </a> 1.8.13
  181. </small></address>
  182. </body>
  183. </html>