index.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  6. <title>Welcome to gRPC Python’s documentation! &#8212; gRPC Python 1.36.1 documentation</title>
  7. <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
  8. <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
  9. <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
  10. <script src="_static/jquery.js"></script>
  11. <script src="_static/underscore.js"></script>
  12. <script src="_static/doctools.js"></script>
  13. <link rel="index" title="Index" href="genindex.html" />
  14. <link rel="search" title="Search" href="search.html" />
  15. <link rel="next" title="gRPC" href="grpc.html" />
  16. <link rel="stylesheet" href="_static/custom.css" type="text/css" />
  17. <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
  18. </head><body>
  19. <div class="document">
  20. <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  21. <div class="sphinxsidebarwrapper">
  22. <h1 class="logo"><a href="#">gRPC Python</a></h1>
  23. <p class="blurb">1.36.1</p>
  24. <h3>Navigation</h3>
  25. <p class="caption"><span class="caption-text">Contents:</span></p>
  26. <ul>
  27. <li class="toctree-l1"><a class="reference internal" href="grpc.html">gRPC</a></li>
  28. <li class="toctree-l1"><a class="reference internal" href="grpc_asyncio.html">gRPC AsyncIO API</a></li>
  29. <li class="toctree-l1"><a class="reference internal" href="grpc_channelz.html">gRPC Channelz</a></li>
  30. <li class="toctree-l1"><a class="reference internal" href="grpc_health_checking.html">gRPC Health Checking</a></li>
  31. <li class="toctree-l1"><a class="reference internal" href="grpc_reflection.html">gRPC Reflection</a></li>
  32. <li class="toctree-l1"><a class="reference internal" href="grpc_status.html">gRPC Status</a></li>
  33. <li class="toctree-l1"><a class="reference internal" href="grpc_testing.html">gRPC Testing</a></li>
  34. <li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li>
  35. </ul>
  36. <div class="relations">
  37. <h3>Related Topics</h3>
  38. <ul>
  39. <li><a href="#">Documentation overview</a><ul>
  40. <li>Next: <a href="grpc.html" title="next chapter">gRPC</a></li>
  41. </ul></li>
  42. </ul>
  43. </div>
  44. <div id="searchbox" style="display: none" role="search">
  45. <h3 id="searchlabel">Quick search</h3>
  46. <div class="searchformwrapper">
  47. <form class="search" action="search.html" method="get">
  48. <input type="text" name="q" aria-labelledby="searchlabel" />
  49. <input type="submit" value="Go" />
  50. </form>
  51. </div>
  52. </div>
  53. <script>$('#searchbox').show(0);</script>
  54. </div>
  55. </div>
  56. <div class="documentwrapper">
  57. <div class="bodywrapper">
  58. <div class="body" role="main">
  59. <div class="section" id="welcome-to-grpc-python-s-documentation">
  60. <h1>Welcome to gRPC Python’s documentation!<a class="headerlink" href="#welcome-to-grpc-python-s-documentation" title="Permalink to this headline">¶</a></h1>
  61. <p>Version: 1.36.1 Release: 1.36.1</p>
  62. </div>
  63. <div class="section" id="api-reference">
  64. <h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline">¶</a></h1>
  65. <div class="toctree-wrapper compound">
  66. <p class="caption"><span class="caption-text">Contents:</span></p>
  67. <ul>
  68. <li class="toctree-l1"><a class="reference internal" href="grpc.html">gRPC</a><ul>
  69. <li class="toctree-l2"><a class="reference internal" href="grpc.html#module-contents">Module Contents</a><ul>
  70. <li class="toctree-l3"><a class="reference internal" href="grpc.html#version">Version</a></li>
  71. <li class="toctree-l3"><a class="reference internal" href="grpc.html#create-client">Create Client</a></li>
  72. <li class="toctree-l3"><a class="reference internal" href="grpc.html#create-client-credentials">Create Client Credentials</a></li>
  73. <li class="toctree-l3"><a class="reference internal" href="grpc.html#create-server">Create Server</a></li>
  74. <li class="toctree-l3"><a class="reference internal" href="grpc.html#create-server-credentials">Create Server Credentials</a></li>
  75. <li class="toctree-l3"><a class="reference internal" href="grpc.html#local-connection-type">Local Connection Type</a></li>
  76. <li class="toctree-l3"><a class="reference internal" href="grpc.html#rpc-method-handlers">RPC Method Handlers</a></li>
  77. <li class="toctree-l3"><a class="reference internal" href="grpc.html#channel-ready-future">Channel Ready Future</a></li>
  78. <li class="toctree-l3"><a class="reference internal" href="grpc.html#channel-connectivity">Channel Connectivity</a></li>
  79. <li class="toctree-l3"><a class="reference internal" href="grpc.html#grpc-status-code">gRPC Status Code</a></li>
  80. <li class="toctree-l3"><a class="reference internal" href="grpc.html#channel-object">Channel Object</a></li>
  81. <li class="toctree-l3"><a class="reference internal" href="grpc.html#server-object">Server Object</a></li>
  82. <li class="toctree-l3"><a class="reference internal" href="grpc.html#authentication-authorization-objects">Authentication &amp; Authorization Objects</a></li>
  83. <li class="toctree-l3"><a class="reference internal" href="grpc.html#grpc-exceptions">gRPC Exceptions</a></li>
  84. <li class="toctree-l3"><a class="reference internal" href="grpc.html#shared-context">Shared Context</a></li>
  85. <li class="toctree-l3"><a class="reference internal" href="grpc.html#client-side-context">Client-Side Context</a></li>
  86. <li class="toctree-l3"><a class="reference internal" href="grpc.html#client-side-interceptor">Client-Side Interceptor</a></li>
  87. <li class="toctree-l3"><a class="reference internal" href="grpc.html#service-side-context">Service-Side Context</a></li>
  88. <li class="toctree-l3"><a class="reference internal" href="grpc.html#service-side-handler">Service-Side Handler</a></li>
  89. <li class="toctree-l3"><a class="reference internal" href="grpc.html#service-side-interceptor">Service-Side Interceptor</a></li>
  90. <li class="toctree-l3"><a class="reference internal" href="grpc.html#multi-callable-interfaces">Multi-Callable Interfaces</a></li>
  91. <li class="toctree-l3"><a class="reference internal" href="grpc.html#future-interfaces">Future Interfaces</a></li>
  92. <li class="toctree-l3"><a class="reference internal" href="grpc.html#compression">Compression</a></li>
  93. <li class="toctree-l3"><a class="reference internal" href="grpc.html#runtime-protobuf-parsing">Runtime Protobuf Parsing</a></li>
  94. </ul>
  95. </li>
  96. </ul>
  97. </li>
  98. <li class="toctree-l1"><a class="reference internal" href="grpc_asyncio.html">gRPC AsyncIO API</a><ul>
  99. <li class="toctree-l2"><a class="reference internal" href="grpc_asyncio.html#overview">Overview</a></li>
  100. <li class="toctree-l2"><a class="reference internal" href="grpc_asyncio.html#caveats">Caveats</a></li>
  101. <li class="toctree-l2"><a class="reference internal" href="grpc_asyncio.html#blocking-code-in-asyncio">Blocking Code in AsyncIO</a></li>
  102. <li class="toctree-l2"><a class="reference internal" href="grpc_asyncio.html#module-contents">Module Contents</a><ul>
  103. <li class="toctree-l3"><a class="reference internal" href="grpc_asyncio.html#create-channel">Create Channel</a></li>
  104. <li class="toctree-l3"><a class="reference internal" href="grpc_asyncio.html#channel-object">Channel Object</a></li>
  105. <li class="toctree-l3"><a class="reference internal" href="grpc_asyncio.html#create-server">Create Server</a></li>
  106. <li class="toctree-l3"><a class="reference internal" href="grpc_asyncio.html#server-object">Server Object</a></li>
  107. <li class="toctree-l3"><a class="reference internal" href="grpc_asyncio.html#grpc-exceptions">gRPC Exceptions</a></li>
  108. <li class="toctree-l3"><a class="reference internal" href="grpc_asyncio.html#shared-context">Shared Context</a></li>
  109. <li class="toctree-l3"><a class="reference internal" href="grpc_asyncio.html#client-side-context">Client-Side Context</a></li>
  110. <li class="toctree-l3"><a class="reference internal" href="grpc_asyncio.html#server-side-context">Server-Side Context</a></li>
  111. <li class="toctree-l3"><a class="reference internal" href="grpc_asyncio.html#client-side-interceptor">Client-Side Interceptor</a></li>
  112. <li class="toctree-l3"><a class="reference internal" href="grpc_asyncio.html#server-side-interceptor">Server-Side Interceptor</a></li>
  113. <li class="toctree-l3"><a class="reference internal" href="grpc_asyncio.html#multi-callable-interfaces">Multi-Callable Interfaces</a></li>
  114. </ul>
  115. </li>
  116. </ul>
  117. </li>
  118. <li class="toctree-l1"><a class="reference internal" href="grpc_channelz.html">gRPC Channelz</a><ul>
  119. <li class="toctree-l2"><a class="reference internal" href="grpc_channelz.html#what-is-grpc-channelz">What is gRPC Channelz?</a></li>
  120. <li class="toctree-l2"><a class="reference internal" href="grpc_channelz.html#module-grpc_channelz.v1.channelz">Module Contents</a></li>
  121. </ul>
  122. </li>
  123. <li class="toctree-l1"><a class="reference internal" href="grpc_health_checking.html">gRPC Health Checking</a><ul>
  124. <li class="toctree-l2"><a class="reference internal" href="grpc_health_checking.html#module-contents">Module Contents</a></li>
  125. </ul>
  126. </li>
  127. <li class="toctree-l1"><a class="reference internal" href="grpc_reflection.html">gRPC Reflection</a><ul>
  128. <li class="toctree-l2"><a class="reference internal" href="grpc_reflection.html#what-is-grpc-reflection">What is gRPC reflection?</a></li>
  129. <li class="toctree-l2"><a class="reference internal" href="grpc_reflection.html#example">Example</a></li>
  130. <li class="toctree-l2"><a class="reference internal" href="grpc_reflection.html#module-grpc_reflection.v1alpha.reflection">Module Contents</a></li>
  131. </ul>
  132. </li>
  133. <li class="toctree-l1"><a class="reference internal" href="grpc_status.html">gRPC Status</a><ul>
  134. <li class="toctree-l2"><a class="reference internal" href="grpc_status.html#module-grpc_status.rpc_status">Module Contents</a></li>
  135. </ul>
  136. </li>
  137. <li class="toctree-l1"><a class="reference internal" href="grpc_testing.html">gRPC Testing</a><ul>
  138. <li class="toctree-l2"><a class="reference internal" href="grpc_testing.html#module-grpc_testing">Module Contents</a></li>
  139. </ul>
  140. </li>
  141. <li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li>
  142. </ul>
  143. </div>
  144. </div>
  145. <div class="section" id="indices-and-tables">
  146. <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
  147. <ul class="simple">
  148. <li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
  149. <li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
  150. <li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
  151. </ul>
  152. </div>
  153. </div>
  154. </div>
  155. </div>
  156. <div class="clearer"></div>
  157. </div>
  158. <div class="footer">
  159. &copy;2020, The gRPC Authors.
  160. |
  161. <a href="_sources/index.rst.txt"
  162. rel="nofollow">Page source</a>
  163. </div>
  164. <script type="text/javascript">
  165. var _gaq = _gaq || [];
  166. _gaq.push(['_setAccount', 'UA-60127042-1']);
  167. _gaq.push(['_setDomainName', 'none']);
  168. _gaq.push(['_setAllowLinker', true]);
  169. _gaq.push(['_trackPageview']);
  170. (function() {
  171. var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
  172. ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
  173. var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
  174. })();
  175. </script>
  176. </body>
  177. </html>