grpc/python/grpc_reflection.html

173 lines
7.7 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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" lang="en">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>gRPC Reflection &#8212; gRPC Python 1.22.0 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="gRPC Status" href="grpc_status.html" />
<link rel="prev" title="gRPC Health Checking" href="grpc_health_checking.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.22.0</p>
<h3>Navigation</h3>
<p class="caption"><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_channelz.html">gRPC Channelz</a></li>
<li class="toctree-l1"><a class="reference internal" href="grpc_health_checking.html">gRPC Health Checking</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">gRPC Reflection</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#what-is-grpc-reflection">What is gRPC reflection?</a></li>
<li class="toctree-l2"><a class="reference internal" href="#example">Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-grpc_reflection.v1alpha.reflection">Module Contents</a></li>
</ul>
</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="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_health_checking.html" title="previous chapter">gRPC Health Checking</a></li>
<li>Next: <a href="grpc_status.html" title="next chapter">gRPC Status</a></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="grpc-reflection">
<h1>gRPC Reflection<a class="headerlink" href="#grpc-reflection" title="Permalink to this headline"></a></h1>
<div class="section" id="what-is-grpc-reflection">
<h2>What is gRPC reflection?<a class="headerlink" href="#what-is-grpc-reflection" title="Permalink to this headline"></a></h2>
<p>Check this out <a class="reference external" href="https://github.com/grpc/grpc/blob/master/doc/python/server_reflection.md">gRPC Python Server Reflection</a></p>
</div>
<div class="section" id="example">
<h2>Example<a class="headerlink" href="#example" title="Permalink to this headline"></a></h2>
<p>Refer to the GitHub <a class="reference external" href="https://github.com/grpc/grpc/blob/master/examples/python/helloworld/greeter_server_with_reflection.py">reflection example</a></p>
</div>
<div class="section" id="module-grpc_reflection.v1alpha.reflection">
<span id="module-contents"></span><h2>Module Contents<a class="headerlink" href="#module-grpc_reflection.v1alpha.reflection" title="Permalink to this headline"></a></h2>
<p>Reference implementation for reflection in gRPC Python.</p>
<dl class="class">
<dt id="grpc_reflection.v1alpha.reflection.ReflectionServicer">
<em class="property">class </em><code class="descclassname">grpc_reflection.v1alpha.reflection.</code><code class="descname">ReflectionServicer</code><span class="sig-paren">(</span><em>service_names</em>, <em>pool=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_reflection/v1alpha/reflection.html#ReflectionServicer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc_reflection.v1alpha.reflection.ReflectionServicer" title="Permalink to this definition"></a></dt>
<dd><p>Servicer handling RPCs for service statuses.</p>
</dd></dl>
<dl class="function">
<dt id="grpc_reflection.v1alpha.reflection.enable_server_reflection">
<code class="descclassname">grpc_reflection.v1alpha.reflection.</code><code class="descname">enable_server_reflection</code><span class="sig-paren">(</span><em>service_names</em>, <em>server</em>, <em>pool=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc_reflection/v1alpha/reflection.html#enable_server_reflection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc_reflection.v1alpha.reflection.enable_server_reflection" title="Permalink to this definition"></a></dt>
<dd><p>Enables server reflection on a server.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>service_names</strong> Iterable of fully-qualified service names available.</li>
<li><strong>server</strong> grpc.Server to which reflection service will be added.</li>
<li><strong>pool</strong> DescriptorPool object to use (descriptor_pool.Default() if None).</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2018, The gRPC Authors.
|
<a href="_sources/grpc_reflection.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>