grpc.early_adopter.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300
  1. <!DOCTYPE html>
  2. <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
  3. <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
  4. <head>
  5. <meta charset="utf-8">
  6. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  7. <title>grpc.early_adopter package &mdash; grpcio 0.11.0b1 documentation</title>
  8. <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  9. <link rel="top" title="grpcio 0.11.0b1 documentation" href="index.html"/>
  10. <link rel="up" title="grpc package" href="grpc.html"/>
  11. <link rel="next" title="grpc.framework package" href="grpc.framework.html"/>
  12. <link rel="prev" title="grpc.beta package" href="grpc.beta.html"/>
  13. <script src="_static/js/modernizr.min.js"></script>
  14. </head>
  15. <body class="wy-body-for-nav" role="document">
  16. <div class="wy-grid-for-nav">
  17. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  18. <div class="wy-side-scroll">
  19. <div class="wy-side-nav-search">
  20. <a href="index.html" class="icon icon-home"> grpcio
  21. </a>
  22. <div class="version">
  23. 0.11.0b1
  24. </div>
  25. <div role="search">
  26. <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
  27. <input type="text" name="q" placeholder="Search docs" />
  28. <input type="hidden" name="check_keywords" value="yes" />
  29. <input type="hidden" name="area" value="default" />
  30. </form>
  31. </div>
  32. </div>
  33. <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  34. <ul class="current">
  35. <li class="toctree-l1 current"><a class="reference internal" href="grpc.html">grpc package</a><ul class="current">
  36. <li class="toctree-l2 current"><a class="reference internal" href="grpc.html#subpackages">Subpackages</a><ul class="current">
  37. <li class="toctree-l3"><a class="reference internal" href="grpc.beta.html">grpc.beta package</a></li>
  38. <li class="toctree-l3 current"><a class="current reference internal" href="">grpc.early_adopter package</a><ul>
  39. <li class="toctree-l4"><a class="reference internal" href="#submodules">Submodules</a></li>
  40. <li class="toctree-l4"><a class="reference internal" href="#module-grpc.early_adopter.implementations">grpc.early_adopter.implementations module</a></li>
  41. <li class="toctree-l4"><a class="reference internal" href="#module-grpc.early_adopter">Module contents</a></li>
  42. </ul>
  43. </li>
  44. <li class="toctree-l3"><a class="reference internal" href="grpc.framework.html">grpc.framework package</a></li>
  45. </ul>
  46. </li>
  47. <li class="toctree-l2"><a class="reference internal" href="grpc.html#module-grpc">Module contents</a></li>
  48. </ul>
  49. </li>
  50. </ul>
  51. </div>
  52. </div>
  53. </nav>
  54. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  55. <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
  56. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  57. <a href="index.html">grpcio</a>
  58. </nav>
  59. <div class="wy-nav-content">
  60. <div class="rst-content">
  61. <div role="navigation" aria-label="breadcrumbs navigation">
  62. <ul class="wy-breadcrumbs">
  63. <li><a href="index.html">Docs</a> &raquo;</li>
  64. <li><a href="grpc.html">grpc package</a> &raquo;</li>
  65. <li>grpc.early_adopter package</li>
  66. <li class="wy-breadcrumbs-aside">
  67. <a href="_sources/grpc.early_adopter.txt" rel="nofollow"> View page source</a>
  68. </li>
  69. </ul>
  70. <hr/>
  71. </div>
  72. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  73. <div itemprop="articleBody">
  74. <div class="section" id="grpc-early-adopter-package">
  75. <h1>grpc.early_adopter package<a class="headerlink" href="#grpc-early-adopter-package" title="Permalink to this headline">¶</a></h1>
  76. <div class="section" id="submodules">
  77. <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
  78. </div>
  79. <div class="section" id="module-grpc.early_adopter.implementations">
  80. <span id="grpc-early-adopter-implementations-module"></span><h2>grpc.early_adopter.implementations module<a class="headerlink" href="#module-grpc.early_adopter.implementations" title="Permalink to this headline">¶</a></h2>
  81. <p>Entry points into GRPC.</p>
  82. <dl class="function">
  83. <dt id="grpc.early_adopter.implementations.server">
  84. <code class="descclassname">grpc.early_adopter.implementations.</code><code class="descname">server</code><span class="sig-paren">(</span><em>service_name</em>, <em>methods</em>, <em>port</em>, <em>private_key=None</em>, <em>certificate_chain=None</em>, <em>thread_pool_size=8</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/early_adopter/implementations.html#server"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.early_adopter.implementations.server" title="Permalink to this definition">¶</a></dt>
  85. <dd><p>Constructs an interfaces.Server.</p>
  86. <table class="docutils field-list" frame="void" rules="none">
  87. <col class="field-name" />
  88. <col class="field-body" />
  89. <tbody valign="top">
  90. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  91. <li><strong>service_name</strong> &#8211; The package-qualified full name of the service.</li>
  92. <li><strong>methods</strong> &#8211; A dictionary from RPC method name to
  93. interfaces.RpcMethodServiceDescription describing the RPCs to
  94. be serviced by the created server. The RPC method names in the dictionary
  95. are not qualified by the service name or decorated in any other way.</li>
  96. <li><strong>port</strong> &#8211; The port on which to serve or zero to ask for a port to be
  97. automatically selected.</li>
  98. <li><strong>private_key</strong> &#8211; A pem-encoded private key, or None for an insecure server.</li>
  99. <li><strong>certificate_chain</strong> &#8211; A pem-encoded certificate chain, or None for an insecure
  100. server.</li>
  101. <li><strong>thread_pool_size</strong> &#8211; The maximum number of threads to allow in the backing
  102. thread pool.</li>
  103. </ul>
  104. </td>
  105. </tr>
  106. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">An interfaces.Server that will serve secure traffic.</p>
  107. </td>
  108. </tr>
  109. </tbody>
  110. </table>
  111. </dd></dl>
  112. <dl class="function">
  113. <dt id="grpc.early_adopter.implementations.stub">
  114. <code class="descclassname">grpc.early_adopter.implementations.</code><code class="descname">stub</code><span class="sig-paren">(</span><em>service_name</em>, <em>methods</em>, <em>host</em>, <em>port</em>, <em>metadata_transformer=None</em>, <em>secure=False</em>, <em>root_certificates=None</em>, <em>private_key=None</em>, <em>certificate_chain=None</em>, <em>server_host_override=None</em>, <em>thread_pool_size=8</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/early_adopter/implementations.html#stub"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.early_adopter.implementations.stub" title="Permalink to this definition">¶</a></dt>
  115. <dd><p>Constructs an interfaces.Stub.</p>
  116. <table class="docutils field-list" frame="void" rules="none">
  117. <col class="field-name" />
  118. <col class="field-body" />
  119. <tbody valign="top">
  120. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  121. <li><strong>service_name</strong> &#8211; The package-qualified full name of the service.</li>
  122. <li><strong>methods</strong> &#8211; A dictionary from RPC method name to
  123. interfaces.RpcMethodInvocationDescription describing the RPCs to be
  124. supported by the created stub. The RPC method names in the dictionary are
  125. not qualified by the service name or decorated in any other way.</li>
  126. <li><strong>host</strong> &#8211; The host to which to connect for RPC service.</li>
  127. <li><strong>port</strong> &#8211; The port to which to connect for RPC service.</li>
  128. <li><strong>metadata_transformer</strong> &#8211; A callable that given a metadata object produces
  129. another metadata object to be used in the underlying communication on the
  130. wire.</li>
  131. <li><strong>secure</strong> &#8211; Whether or not to construct the stub with a secure connection.</li>
  132. <li><strong>root_certificates</strong> &#8211; The PEM-encoded root certificates or None to ask for
  133. them to be retrieved from a default location.</li>
  134. <li><strong>private_key</strong> &#8211; The PEM-encoded private key to use or None if no private key
  135. should be used.</li>
  136. <li><strong>certificate_chain</strong> &#8211; The PEM-encoded certificate chain to use or None if no
  137. certificate chain should be used.</li>
  138. <li><strong>server_host_override</strong> &#8211; (For testing only) the target name used for SSL
  139. host name checking.</li>
  140. <li><strong>thread_pool_size</strong> &#8211; The maximum number of threads to allow in the backing
  141. thread pool.</li>
  142. </ul>
  143. </td>
  144. </tr>
  145. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">An interfaces.Stub affording RPC invocation.</p>
  146. </td>
  147. </tr>
  148. </tbody>
  149. </table>
  150. </dd></dl>
  151. </div>
  152. <div class="section" id="module-grpc.early_adopter">
  153. <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-grpc.early_adopter" title="Permalink to this headline">¶</a></h2>
  154. </div>
  155. </div>
  156. </div>
  157. </div>
  158. <footer>
  159. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  160. <a href="grpc.framework.html" class="btn btn-neutral float-right" title="grpc.framework package" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
  161. <a href="grpc.beta.html" class="btn btn-neutral" title="grpc.beta package" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
  162. </div>
  163. <hr/>
  164. <div role="contentinfo">
  165. <p>
  166. &copy; Copyright 2015, Author.
  167. </p>
  168. </div>
  169. Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
  170. </footer>
  171. </div>
  172. </div>
  173. </section>
  174. </div>
  175. <script type="text/javascript">
  176. var DOCUMENTATION_OPTIONS = {
  177. URL_ROOT:'./',
  178. VERSION:'0.11.0b1',
  179. COLLAPSE_INDEX:false,
  180. FILE_SUFFIX:'.html',
  181. HAS_SOURCE: true
  182. };
  183. </script>
  184. <script type="text/javascript" src="_static/jquery.js"></script>
  185. <script type="text/javascript" src="_static/underscore.js"></script>
  186. <script type="text/javascript" src="_static/doctools.js"></script>
  187. <script type="text/javascript" src="_static/js/theme.js"></script>
  188. <script type="text/javascript">
  189. jQuery(function () {
  190. SphinxRtdTheme.StickyNav.enable();
  191. });
  192. </script>
  193. </body>
  194. </html>