grpc_reflection.html 7.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" lang="en">
  4. <head>
  5. <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
  6. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  7. <title>gRPC Reflection &#8212; gRPC Python 1.23.0 documentation</title>
  8. <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
  9. <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
  10. <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
  11. <script type="text/javascript" src="_static/jquery.js"></script>
  12. <script type="text/javascript" src="_static/underscore.js"></script>
  13. <script type="text/javascript" src="_static/doctools.js"></script>
  14. <script type="text/javascript" src="_static/language_data.js"></script>
  15. <link rel="index" title="Index" href="genindex.html" />
  16. <link rel="search" title="Search" href="search.html" />
  17. <link rel="next" title="gRPC Status" href="grpc_status.html" />
  18. <link rel="prev" title="gRPC Health Checking" href="grpc_health_checking.html" />
  19. <link rel="stylesheet" href="_static/custom.css" type="text/css" />
  20. <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
  21. </head><body>
  22. <div class="document">
  23. <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  24. <div class="sphinxsidebarwrapper">
  25. <h1 class="logo"><a href="index.html">gRPC Python</a></h1>
  26. <p class="blurb">1.23.0</p>
  27. <h3>Navigation</h3>
  28. <p class="caption"><span class="caption-text">Contents:</span></p>
  29. <ul class="current">
  30. <li class="toctree-l1"><a class="reference internal" href="grpc.html">gRPC</a></li>
  31. <li class="toctree-l1"><a class="reference internal" href="grpc_channelz.html">gRPC Channelz</a></li>
  32. <li class="toctree-l1"><a class="reference internal" href="grpc_health_checking.html">gRPC Health Checking</a></li>
  33. <li class="toctree-l1 current"><a class="current reference internal" href="#">gRPC Reflection</a><ul>
  34. <li class="toctree-l2"><a class="reference internal" href="#what-is-grpc-reflection">What is gRPC reflection?</a></li>
  35. <li class="toctree-l2"><a class="reference internal" href="#example">Example</a></li>
  36. <li class="toctree-l2"><a class="reference internal" href="#module-grpc_reflection.v1alpha.reflection">Module Contents</a></li>
  37. </ul>
  38. </li>
  39. <li class="toctree-l1"><a class="reference internal" href="grpc_status.html">gRPC Status</a></li>
  40. <li class="toctree-l1"><a class="reference internal" href="grpc_testing.html">gRPC Testing</a></li>
  41. <li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li>
  42. </ul>
  43. <div class="relations">
  44. <h3>Related Topics</h3>
  45. <ul>
  46. <li><a href="index.html">Documentation overview</a><ul>
  47. <li>Previous: <a href="grpc_health_checking.html" title="previous chapter">gRPC Health Checking</a></li>
  48. <li>Next: <a href="grpc_status.html" title="next chapter">gRPC Status</a></li>
  49. </ul></li>
  50. </ul>
  51. </div>
  52. <div id="searchbox" style="display: none" role="search">
  53. <h3>Quick search</h3>
  54. <div class="searchformwrapper">
  55. <form class="search" action="search.html" method="get">
  56. <input type="text" name="q" />
  57. <input type="submit" value="Go" />
  58. <input type="hidden" name="check_keywords" value="yes" />
  59. <input type="hidden" name="area" value="default" />
  60. </form>
  61. </div>
  62. </div>
  63. <script type="text/javascript">$('#searchbox').show(0);</script>
  64. </div>
  65. </div>
  66. <div class="documentwrapper">
  67. <div class="bodywrapper">
  68. <div class="body" role="main">
  69. <div class="section" id="grpc-reflection">
  70. <h1>gRPC Reflection<a class="headerlink" href="#grpc-reflection" title="Permalink to this headline">¶</a></h1>
  71. <div class="section" id="what-is-grpc-reflection">
  72. <h2>What is gRPC reflection?<a class="headerlink" href="#what-is-grpc-reflection" title="Permalink to this headline">¶</a></h2>
  73. <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>
  74. </div>
  75. <div class="section" id="example">
  76. <h2>Example<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h2>
  77. <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>
  78. </div>
  79. <div class="section" id="module-grpc_reflection.v1alpha.reflection">
  80. <span id="module-contents"></span><h2>Module Contents<a class="headerlink" href="#module-grpc_reflection.v1alpha.reflection" title="Permalink to this headline">¶</a></h2>
  81. <p>Reference implementation for reflection in gRPC Python.</p>
  82. <dl class="class">
  83. <dt id="grpc_reflection.v1alpha.reflection.ReflectionServicer">
  84. <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>
  85. <dd><p>Servicer handling RPCs for service statuses.</p>
  86. </dd></dl>
  87. <dl class="function">
  88. <dt id="grpc_reflection.v1alpha.reflection.enable_server_reflection">
  89. <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>
  90. <dd><p>Enables server reflection on a server.</p>
  91. <table class="docutils field-list" frame="void" rules="none">
  92. <col class="field-name" />
  93. <col class="field-body" />
  94. <tbody valign="top">
  95. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
  96. <li><strong>service_names</strong> – Iterable of fully-qualified service names available.</li>
  97. <li><strong>server</strong> – grpc.Server to which reflection service will be added.</li>
  98. <li><strong>pool</strong> – DescriptorPool object to use (descriptor_pool.Default() if None).</li>
  99. </ul>
  100. </td>
  101. </tr>
  102. </tbody>
  103. </table>
  104. </dd></dl>
  105. </div>
  106. </div>
  107. </div>
  108. </div>
  109. </div>
  110. <div class="clearer"></div>
  111. </div>
  112. <div class="footer">
  113. &copy;2018, The gRPC Authors.
  114. |
  115. <a href="_sources/grpc_reflection.rst.txt"
  116. rel="nofollow">Page source</a>
  117. </div>
  118. <script type="text/javascript">
  119. var _gaq = _gaq || [];
  120. _gaq.push(['_setAccount', 'UA-60127042-1']);
  121. _gaq.push(['_setDomainName', 'none']);
  122. _gaq.push(['_setAllowLinker', true]);
  123. _gaq.push(['_trackPageview']);
  124. (function() {
  125. var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
  126. ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
  127. var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
  128. })();
  129. </script>
  130. </body>
  131. </html>