classgrpc_1_1_health_check_service_server_builder_option.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>GRPC C++: grpc::HealthCheckServiceServerBuilderOption 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. </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.36.1</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.17 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */</script>
  48. <div id="main-nav"></div>
  49. <!-- window showing the filter options -->
  50. <div id="MSearchSelectWindow"
  51. onmouseover="return searchBox.OnSearchSelectShow()"
  52. onmouseout="return searchBox.OnSearchSelectHide()"
  53. onkeydown="return searchBox.OnSearchSelectKey(event)">
  54. </div>
  55. <!-- iframe showing the search results (closed by default) -->
  56. <div id="MSearchResultsWindow">
  57. <iframe src="javascript:void(0)" frameborder="0"
  58. name="MSearchResults" id="MSearchResults">
  59. </iframe>
  60. </div>
  61. <div id="nav-path" class="navpath">
  62. <ul>
  63. <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_server_builder_option.html">HealthCheckServiceServerBuilderOption</a></li> </ul>
  64. </div>
  65. </div><!-- top -->
  66. <div class="header">
  67. <div class="summary">
  68. <a href="#pub-methods">Public Member Functions</a> </div>
  69. <div class="headertitle">
  70. <div class="title">grpc::HealthCheckServiceServerBuilderOption Class Reference</div> </div>
  71. </div><!--header-->
  72. <div class="contents">
  73. <p><code>#include &lt;<a class="el" href="grpcpp_2ext_2health__check__service__server__builder__option_8h_source.html">health_check_service_server_builder_option.h</a>&gt;</code></p>
  74. <table class="memberdecls">
  75. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  76. Public Member Functions</h2></td></tr>
  77. <tr class="memitem:a11d309e8f1809097e5defcaa386e6ce7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_health_check_service_server_builder_option.html#a11d309e8f1809097e5defcaa386e6ce7">HealthCheckServiceServerBuilderOption</a> (std::unique_ptr&lt; <a class="el" href="classgrpc_1_1_health_check_service_interface.html">HealthCheckServiceInterface</a> &gt; hc)</td></tr>
  78. <tr class="memdesc:a11d309e8f1809097e5defcaa386e6ce7"><td class="mdescLeft">&#160;</td><td class="mdescRight">The ownership of <em>hc</em> will be taken and transferred to the grpc server. <a href="classgrpc_1_1_health_check_service_server_builder_option.html#a11d309e8f1809097e5defcaa386e6ce7">More...</a><br /></td></tr>
  79. <tr class="separator:a11d309e8f1809097e5defcaa386e6ce7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:a2992017c359ca2512ffcf43a31c704fe"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_health_check_service_server_builder_option.html#a2992017c359ca2512ffcf43a31c704fe">~HealthCheckServiceServerBuilderOption</a> () override</td></tr>
  81. <tr class="separator:a2992017c359ca2512ffcf43a31c704fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:a194b4e3f33c4f7463098c919dab93fb6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_health_check_service_server_builder_option.html#a194b4e3f33c4f7463098c919dab93fb6">UpdateArguments</a> (<a class="el" href="classgrpc_1_1_channel_arguments.html">ChannelArguments</a> *args) override</td></tr>
  83. <tr class="memdesc:a194b4e3f33c4f7463098c919dab93fb6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Alter the <em><a class="el" href="classgrpc_1_1_channel_arguments.html" title="Options for channel creation.">ChannelArguments</a></em> used to create the gRPC server. <a href="classgrpc_1_1_health_check_service_server_builder_option.html#a194b4e3f33c4f7463098c919dab93fb6">More...</a><br /></td></tr>
  84. <tr class="separator:a194b4e3f33c4f7463098c919dab93fb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:a24614ed26168e443d768884359480e02"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_health_check_service_server_builder_option.html#a24614ed26168e443d768884359480e02">UpdatePlugins</a> (std::vector&lt; std::unique_ptr&lt; <a class="el" href="classgrpc_1_1_server_builder_plugin.html">ServerBuilderPlugin</a> &gt;&gt; *plugins) override</td></tr>
  86. <tr class="separator:a24614ed26168e443d768884359480e02"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="inherit_header pub_methods_classgrpc_1_1_server_builder_option"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1_server_builder_option')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc_1_1_server_builder_option.html">grpc::ServerBuilderOption</a></td></tr>
  88. <tr class="memitem:aa0a884edb26d286e0d56b867a0cf928c inherit pub_methods_classgrpc_1_1_server_builder_option"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder_option.html#aa0a884edb26d286e0d56b867a0cf928c">~ServerBuilderOption</a> ()</td></tr>
  89. <tr class="separator:aa0a884edb26d286e0d56b867a0cf928c inherit pub_methods_classgrpc_1_1_server_builder_option"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a5879a733eef508e8d93ab1061a97aa06 inherit pub_methods_classgrpc_1_1_server_builder_option"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_builder_option.html#a5879a733eef508e8d93ab1061a97aa06">UpdatePlugins</a> (std::vector&lt; std::unique_ptr&lt; <a class="el" href="classgrpc_1_1_server_builder_plugin.html">grpc::ServerBuilderPlugin</a> &gt;&gt; *plugins)=0</td></tr>
  91. <tr class="memdesc:a5879a733eef508e8d93ab1061a97aa06 inherit pub_methods_classgrpc_1_1_server_builder_option"><td class="mdescLeft">&#160;</td><td class="mdescRight">Alter the <a class="el" href="classgrpc_1_1_server_builder_plugin.html" title="This interface is meant for internal usage only.">ServerBuilderPlugin</a> map that will be added into <a class="el" href="classgrpc_1_1_server_builder.html" title="A builder class for the creation and startup of grpc::Server instances.">ServerBuilder</a>. <a href="classgrpc_1_1_server_builder_option.html#a5879a733eef508e8d93ab1061a97aa06">More...</a><br /></td></tr>
  92. <tr class="separator:a5879a733eef508e8d93ab1061a97aa06 inherit pub_methods_classgrpc_1_1_server_builder_option"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. </table>
  94. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  95. <a id="a11d309e8f1809097e5defcaa386e6ce7"></a>
  96. <h2 class="memtitle"><span class="permalink"><a href="#a11d309e8f1809097e5defcaa386e6ce7">&#9670;&nbsp;</a></span>HealthCheckServiceServerBuilderOption()</h2>
  97. <div class="memitem">
  98. <div class="memproto">
  99. <table class="mlabels">
  100. <tr>
  101. <td class="mlabels-left">
  102. <table class="memname">
  103. <tr>
  104. <td class="memname">grpc::HealthCheckServiceServerBuilderOption::HealthCheckServiceServerBuilderOption </td>
  105. <td>(</td>
  106. <td class="paramtype">std::unique_ptr&lt; <a class="el" href="classgrpc_1_1_health_check_service_interface.html">HealthCheckServiceInterface</a> &gt;&#160;</td>
  107. <td class="paramname"><em>hc</em></td><td>)</td>
  108. <td></td>
  109. </tr>
  110. </table>
  111. </td>
  112. <td class="mlabels-right">
  113. <span class="mlabels"><span class="mlabel">explicit</span></span> </td>
  114. </tr>
  115. </table>
  116. </div><div class="memdoc">
  117. <p>The ownership of <em>hc</em> will be taken and transferred to the grpc server. </p>
  118. <p>To explicitly disable default service, pass in a nullptr. </p>
  119. </div>
  120. </div>
  121. <a id="a2992017c359ca2512ffcf43a31c704fe"></a>
  122. <h2 class="memtitle"><span class="permalink"><a href="#a2992017c359ca2512ffcf43a31c704fe">&#9670;&nbsp;</a></span>~HealthCheckServiceServerBuilderOption()</h2>
  123. <div class="memitem">
  124. <div class="memproto">
  125. <table class="mlabels">
  126. <tr>
  127. <td class="mlabels-left">
  128. <table class="memname">
  129. <tr>
  130. <td class="memname">grpc::HealthCheckServiceServerBuilderOption::~HealthCheckServiceServerBuilderOption </td>
  131. <td>(</td>
  132. <td class="paramname"></td><td>)</td>
  133. <td></td>
  134. </tr>
  135. </table>
  136. </td>
  137. <td class="mlabels-right">
  138. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span></span> </td>
  139. </tr>
  140. </table>
  141. </div><div class="memdoc">
  142. </div>
  143. </div>
  144. <h2 class="groupheader">Member Function Documentation</h2>
  145. <a id="a194b4e3f33c4f7463098c919dab93fb6"></a>
  146. <h2 class="memtitle"><span class="permalink"><a href="#a194b4e3f33c4f7463098c919dab93fb6">&#9670;&nbsp;</a></span>UpdateArguments()</h2>
  147. <div class="memitem">
  148. <div class="memproto">
  149. <table class="mlabels">
  150. <tr>
  151. <td class="mlabels-left">
  152. <table class="memname">
  153. <tr>
  154. <td class="memname">void grpc::HealthCheckServiceServerBuilderOption::UpdateArguments </td>
  155. <td>(</td>
  156. <td class="paramtype"><a class="el" href="classgrpc_1_1_channel_arguments.html">ChannelArguments</a> *&#160;</td>
  157. <td class="paramname"><em>args</em></td><td>)</td>
  158. <td></td>
  159. </tr>
  160. </table>
  161. </td>
  162. <td class="mlabels-right">
  163. <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  164. </tr>
  165. </table>
  166. </div><div class="memdoc">
  167. <p>Alter the <em><a class="el" href="classgrpc_1_1_channel_arguments.html" title="Options for channel creation.">ChannelArguments</a></em> used to create the gRPC server. </p>
  168. <p>Implements <a class="el" href="classgrpc_1_1_server_builder_option.html#a132394317bdda21a184de14aeb75876d">grpc::ServerBuilderOption</a>.</p>
  169. </div>
  170. </div>
  171. <a id="a24614ed26168e443d768884359480e02"></a>
  172. <h2 class="memtitle"><span class="permalink"><a href="#a24614ed26168e443d768884359480e02">&#9670;&nbsp;</a></span>UpdatePlugins()</h2>
  173. <div class="memitem">
  174. <div class="memproto">
  175. <table class="mlabels">
  176. <tr>
  177. <td class="mlabels-left">
  178. <table class="memname">
  179. <tr>
  180. <td class="memname">void grpc::HealthCheckServiceServerBuilderOption::UpdatePlugins </td>
  181. <td>(</td>
  182. <td class="paramtype">std::vector&lt; std::unique_ptr&lt; <a class="el" href="classgrpc_1_1_server_builder_plugin.html">ServerBuilderPlugin</a> &gt;&gt; *&#160;</td>
  183. <td class="paramname"><em>plugins</em></td><td>)</td>
  184. <td></td>
  185. </tr>
  186. </table>
  187. </td>
  188. <td class="mlabels-right">
  189. <span class="mlabels"><span class="mlabel">override</span></span> </td>
  190. </tr>
  191. </table>
  192. </div><div class="memdoc">
  193. </div>
  194. </div>
  195. <hr/>The documentation for this class was generated from the following file:<ul>
  196. <li>include/grpcpp/ext/<a class="el" href="grpcpp_2ext_2health__check__service__server__builder__option_8h_source.html">health_check_service_server_builder_option.h</a></li>
  197. </ul>
  198. </div><!-- contents -->
  199. <!-- start footer part -->
  200. <hr class="footer"/><address class="footer"><small>
  201. Generated on Wed Mar 3 2021 19:17:24 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  202. <img class="footer" src="doxygen.png" alt="doxygen"/>
  203. </a> 1.8.17
  204. </small></address>
  205. </body>
  206. </html>