carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GRPC C++: include/grpcpp/health_check_service_interface.h 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.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 id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">GRPC C++
   &#160;<span id="projectnumber">1.36.1</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_412f9a3d5dfcba8716486cd870ef4586.html">grpcpp</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">health_check_service_interface.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="grpcpp_2health__check__service__interface_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> * Copyright 2016 gRPC authors.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> * you may not use this file except in compliance with the License.</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * You may obtain a copy of the License at</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> *     http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> * distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * See the License for the specific language governing permissions and</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> * limitations under the License.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor">#ifndef GRPCPP_HEALTH_CHECK_SERVICE_INTERFACE_H</span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#define GRPCPP_HEALTH_CHECK_SERVICE_INTERFACE_H</span></div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160; </div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="grpcpp_2support_2config_8h.html">grpcpp/support/config.h</a>&gt;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacegrpc.html">grpc</a> {</div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="namespacegrpc.html#a7252666b30ae42dcc5336bb4a701d7ba">   26</a></span>&#160;<span class="keyword">const</span> <span class="keywordtype">char</span> <a class="code" href="namespacegrpc.html#a7252666b30ae42dcc5336bb4a701d7ba">kHealthCheckServiceInterfaceArg</a>[] =</div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;    <span class="stringliteral">&quot;grpc.health_check_service_interface&quot;</span>;</div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160; </div>
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classgrpc_1_1_health_check_service_interface.html">   31</a></span>&#160;<span class="keyword">class </span><a class="code" href="classgrpc_1_1_health_check_service_interface.html">HealthCheckServiceInterface</a> {</div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160; <span class="keyword">public</span>:</div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="classgrpc_1_1_health_check_service_interface.html#af72a34e5ec5cc058fd7648e235816c60">   33</a></span>&#160;  <span class="keyword">virtual</span> <a class="code" href="classgrpc_1_1_health_check_service_interface.html#af72a34e5ec5cc058fd7648e235816c60">~HealthCheckServiceInterface</a>() {}</div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160; </div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classgrpc_1_1_health_check_service_interface.html#a1e7a4131b8ccdd1cea34fb2ffc540fdd">SetServingStatus</a>(<span class="keyword">const</span> std::string&amp; service_name,</div>
<div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;                                <span class="keywordtype">bool</span> serving) = 0;</div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classgrpc_1_1_health_check_service_interface.html#a1e7a4131b8ccdd1cea34fb2ffc540fdd">SetServingStatus</a>(<span class="keywordtype">bool</span> serving) = 0;</div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160; </div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classgrpc_1_1_health_check_service_interface.html#a520a6c15acec341dc65a638e55b0798b">   43</a></span>&#160;  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classgrpc_1_1_health_check_service_interface.html#a520a6c15acec341dc65a638e55b0798b">Shutdown</a>() {}</div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;};</div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160; </div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="keywordtype">void</span> <a class="code" href="namespacegrpc.html#a892b88cf1c9b9c9a3d2438286413218c">EnableDefaultHealthCheckService</a>(<span class="keywordtype">bool</span> enable);</div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160; </div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="keywordtype">bool</span> <a class="code" href="namespacegrpc.html#ac6cb56443dd770ee50262a69abdb0b40">DefaultHealthCheckServiceEnabled</a>();</div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160; </div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;}  <span class="comment">// namespace grpc</span></div>
<div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160; </div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="preprocessor">#endif  // GRPCPP_HEALTH_CHECK_SERVICE_INTERFACE_H</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="anamespacegrpc_html"><div class="ttname"><a href="namespacegrpc.html">grpc</a></div><div class="ttdoc">An Alarm posts the user-provided tag to its associated completion queue or invokes the user-provided ...</div><div class="ttdef"><b>Definition:</b> alarm.h:33</div></div>
<div class="ttc" id="anamespacegrpc_html_a892b88cf1c9b9c9a3d2438286413218c"><div class="ttname"><a href="namespacegrpc.html#a892b88cf1c9b9c9a3d2438286413218c">grpc::EnableDefaultHealthCheckService</a></div><div class="ttdeci">void EnableDefaultHealthCheckService(bool enable)</div><div class="ttdoc">Enable/disable the default health checking service.</div></div>
<div class="ttc" id="aclassgrpc_1_1_health_check_service_interface_html"><div class="ttname"><a href="classgrpc_1_1_health_check_service_interface.html">grpc::HealthCheckServiceInterface</a></div><div class="ttdoc">The gRPC server uses this interface to expose the health checking service without depending on protob...</div><div class="ttdef"><b>Definition:</b> health_check_service_interface.h:31</div></div>
<div class="ttc" id="aclassgrpc_1_1_health_check_service_interface_html_a1e7a4131b8ccdd1cea34fb2ffc540fdd"><div class="ttname"><a href="classgrpc_1_1_health_check_service_interface.html#a1e7a4131b8ccdd1cea34fb2ffc540fdd">grpc::HealthCheckServiceInterface::SetServingStatus</a></div><div class="ttdeci">virtual void SetServingStatus(const std::string &amp;service_name, bool serving)=0</div><div class="ttdoc">Set or change the serving status of the given service_name.</div></div>
<div class="ttc" id="anamespacegrpc_html_a7252666b30ae42dcc5336bb4a701d7ba"><div class="ttname"><a href="namespacegrpc.html#a7252666b30ae42dcc5336bb4a701d7ba">grpc::kHealthCheckServiceInterfaceArg</a></div><div class="ttdeci">const char kHealthCheckServiceInterfaceArg[]</div><div class="ttdef"><b>Definition:</b> health_check_service_interface.h:26</div></div>
<div class="ttc" id="aclassgrpc_1_1_health_check_service_interface_html_af72a34e5ec5cc058fd7648e235816c60"><div class="ttname"><a href="classgrpc_1_1_health_check_service_interface.html#af72a34e5ec5cc058fd7648e235816c60">grpc::HealthCheckServiceInterface::~HealthCheckServiceInterface</a></div><div class="ttdeci">virtual ~HealthCheckServiceInterface()</div><div class="ttdef"><b>Definition:</b> health_check_service_interface.h:33</div></div>
<div class="ttc" id="agrpcpp_2support_2config_8h_html"><div class="ttname"><a href="grpcpp_2support_2config_8h.html">config.h</a></div></div>
<div class="ttc" id="aclassgrpc_1_1_health_check_service_interface_html_a520a6c15acec341dc65a638e55b0798b"><div class="ttname"><a href="classgrpc_1_1_health_check_service_interface.html#a520a6c15acec341dc65a638e55b0798b">grpc::HealthCheckServiceInterface::Shutdown</a></div><div class="ttdeci">virtual void Shutdown()</div><div class="ttdoc">Set all registered service names to not serving and prevent future state changes.</div><div class="ttdef"><b>Definition:</b> health_check_service_interface.h:43</div></div>
<div class="ttc" id="anamespacegrpc_html_ac6cb56443dd770ee50262a69abdb0b40"><div class="ttname"><a href="namespacegrpc.html#ac6cb56443dd770ee50262a69abdb0b40">grpc::DefaultHealthCheckServiceEnabled</a></div><div class="ttdeci">bool DefaultHealthCheckServiceEnabled()</div><div class="ttdoc">Returns whether the default health checking service is enabled.</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 3 2021 19:17:17 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>