201 lines
12 KiB
HTML
201 lines
12 KiB
HTML
<!DOCTYPE html>
|
||
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||
|
||
<title>gRPC Health Checking — gRPC Python 1.64.0 documentation</title>
|
||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=4f649999" />
|
||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=8090fdca" />
|
||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=057799ce"></script>
|
||
<script src="_static/doctools.js?v=888ff710"></script>
|
||
<script src="_static/sphinx_highlight.js?v=4825356b"></script>
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="next" title="gRPC Reflection" href="grpc_reflection.html" />
|
||
<link rel="prev" title="gRPC CSDS" href="grpc_csds.html" />
|
||
|
||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||
|
||
</head><body>
|
||
<div class="document">
|
||
|
||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||
<div class="sphinxsidebarwrapper">
|
||
<h1 class="logo"><a href="index.html">gRPC Python</a></h1>
|
||
|
||
|
||
|
||
<p class="blurb">1.64.0</p>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<h3>Navigation</h3>
|
||
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="grpc.html">gRPC</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="grpc_asyncio.html">gRPC AsyncIO API</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="grpc_admin.html">gRPC Admin</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="grpc_channelz.html">gRPC Channelz</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="grpc_csds.html">gRPC CSDS</a></li>
|
||
<li class="toctree-l1 current"><a class="current reference internal" href="#">gRPC Health Checking</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="#module-contents">Module Contents</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="#grpc_health.v1.health.HealthServicer"><code class="docutils literal notranslate"><span class="pre">HealthServicer</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#grpc_health.v1.health.HealthServicer.Check"><code class="docutils literal notranslate"><span class="pre">HealthServicer.Check()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#grpc_health.v1.health.HealthServicer.Watch"><code class="docutils literal notranslate"><span class="pre">HealthServicer.Watch()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#grpc_health.v1.health.HealthServicer.enter_graceful_shutdown"><code class="docutils literal notranslate"><span class="pre">HealthServicer.enter_graceful_shutdown()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#grpc_health.v1.health.HealthServicer.set"><code class="docutils literal notranslate"><span class="pre">HealthServicer.set()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="grpc_reflection.html">gRPC Reflection</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="grpc_status.html">gRPC Status</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="grpc_testing.html">gRPC Testing</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="grpc_observability.html">gRPC Python Observability</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li>
|
||
</ul>
|
||
|
||
<div class="relations">
|
||
<h3>Related Topics</h3>
|
||
<ul>
|
||
<li><a href="index.html">Documentation overview</a><ul>
|
||
<li>Previous: <a href="grpc_csds.html" title="previous chapter">gRPC CSDS</a></li>
|
||
<li>Next: <a href="grpc_reflection.html" title="next chapter">gRPC Reflection</a></li>
|
||
</ul></li>
|
||
</ul>
|
||
</div>
|
||
<div id="searchbox" style="display: none" role="search">
|
||
<h3 id="searchlabel">Quick search</h3>
|
||
<div class="searchformwrapper">
|
||
<form class="search" action="search.html" method="get">
|
||
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||
<input type="submit" value="Go" />
|
||
</form>
|
||
</div>
|
||
</div>
|
||
<script>document.getElementById('searchbox').style.display = "block"</script>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
|
||
|
||
<div class="body" role="main">
|
||
|
||
<section id="grpc-health-checking">
|
||
<h1>gRPC Health Checking<a class="headerlink" href="#grpc-health-checking" title="Permalink to this heading">¶</a></h1>
|
||
<section id="module-contents">
|
||
<h2>Module Contents<a class="headerlink" href="#module-contents" title="Permalink to this heading">¶</a></h2>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="grpc_health.v1.health.HealthServicer">
|
||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">grpc_health.v1.health.</span></span><span class="sig-name descname"><span class="pre">HealthServicer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">experimental_non_blocking</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">experimental_thread_pool</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_health/v1/health.html#HealthServicer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_health.v1.health.HealthServicer" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Servicer handling RPCs for service statuses.</p>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="grpc_health.v1.health.HealthServicer.Check">
|
||
<span class="sig-name descname"><span class="pre">Check</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_health/v1/health.html#HealthServicer.Check"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_health.v1.health.HealthServicer.Check" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>If the requested service is unknown, the call will fail with status
|
||
NOT_FOUND.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="grpc_health.v1.health.HealthServicer.Watch">
|
||
<span class="sig-name descname"><span class="pre">Watch</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">send_response_callback</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_health/v1/health.html#HealthServicer.Watch"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_health.v1.health.HealthServicer.Watch" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Performs a watch for the serving status of the requested service.
|
||
The server will immediately send back a message indicating the current
|
||
serving status. It will then subsequently send a new message whenever
|
||
the service’s serving status changes.</p>
|
||
<p>If the requested service is unknown when the call is received, the
|
||
server will send a message setting the serving status to
|
||
SERVICE_UNKNOWN but will <em>not</em> terminate the call. If at some
|
||
future point, the serving status of the service becomes known, the
|
||
server will send a new message with the service’s serving status.</p>
|
||
<p>If the call terminates with status UNIMPLEMENTED, then clients
|
||
should assume this method is not supported and should not retry the
|
||
call. If the call terminates with any other status (including OK),
|
||
clients should retry the call with appropriate exponential backoff.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="grpc_health.v1.health.HealthServicer.enter_graceful_shutdown">
|
||
<span class="sig-name descname"><span class="pre">enter_graceful_shutdown</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_health/v1/health.html#HealthServicer.enter_graceful_shutdown"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_health.v1.health.HealthServicer.enter_graceful_shutdown" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Permanently sets the status of all services to NOT_SERVING.</p>
|
||
<p>This should be invoked when the server is entering a graceful shutdown
|
||
period. After this method is invoked, future attempts to set the status
|
||
of a service will be ignored.</p>
|
||
<p>This is an EXPERIMENTAL API.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="grpc_health.v1.health.HealthServicer.set">
|
||
<span class="sig-name descname"><span class="pre">set</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">service</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_health/v1/health.html#HealthServicer.set"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#grpc_health.v1.health.HealthServicer.set" title="Permalink to this definition">¶</a></dt>
|
||
<dd><p>Sets the status of a service.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>service</strong> – string, the name of the service.</p></li>
|
||
<li><p><strong>status</strong> – HealthCheckResponse.status enum value indicating the status of
|
||
the service</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
<div class="clearer"></div>
|
||
</div>
|
||
<div class="footer">
|
||
©2020, The gRPC Authors.
|
||
|
||
|
|
||
<a href="_sources/grpc_health_checking.rst.txt"
|
||
rel="nofollow">Page source</a>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<script type="text/javascript">
|
||
|
||
var _gaq = _gaq || [];
|
||
_gaq.push(['_setAccount', 'UA-60127042-1']);
|
||
_gaq.push(['_setDomainName', 'none']);
|
||
_gaq.push(['_setAllowLinker', true]);
|
||
_gaq.push(['_trackPageview']);
|
||
|
||
(function() {
|
||
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
|
||
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
|
||
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
|
||
})();
|
||
|
||
</script>
|
||
|
||
</body>
|
||
</html> |