grpc.early_adopter.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326
  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.10.0a0 documentation</title>
  8. <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  9. <link rel="top" title="grpcio 0.10.0a0 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 package" href="grpc.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-nav-search">
  19. <a href="index.html" class="icon icon-home"> grpcio
  20. </a>
  21. <div role="search">
  22. <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
  23. <input type="text" name="q" placeholder="Search docs" />
  24. <input type="hidden" name="check_keywords" value="yes" />
  25. <input type="hidden" name="area" value="default" />
  26. </form>
  27. </div>
  28. </div>
  29. <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  30. <ul class="current">
  31. <li class="toctree-l1 current"><a class="reference internal" href="grpc.html">grpc package</a><ul class="current">
  32. <li class="toctree-l2 current"><a class="reference internal" href="grpc.html#subpackages">Subpackages</a><ul class="current">
  33. <li class="toctree-l3 current"><a class="current reference internal" href="">grpc.early_adopter package</a><ul>
  34. <li class="toctree-l4"><a class="reference internal" href="#submodules">Submodules</a></li>
  35. <li class="toctree-l4"><a class="reference internal" href="#module-grpc.early_adopter.implementations">grpc.early_adopter.implementations module</a></li>
  36. <li class="toctree-l4"><a class="reference internal" href="#module-grpc.early_adopter.implementations_test">grpc.early_adopter.implementations_test module</a></li>
  37. <li class="toctree-l4"><a class="reference internal" href="#module-grpc.early_adopter">Module contents</a></li>
  38. </ul>
  39. </li>
  40. <li class="toctree-l3"><a class="reference internal" href="grpc.framework.html">grpc.framework package</a><ul>
  41. <li class="toctree-l4"><a class="reference internal" href="grpc.framework.html#subpackages">Subpackages</a></li>
  42. <li class="toctree-l4"><a class="reference internal" href="grpc.framework.html#module-grpc.framework">Module contents</a></li>
  43. </ul>
  44. </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. &nbsp;
  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">
  73. <div class="section" id="grpc-early-adopter-package">
  74. <h1>grpc.early_adopter package<a class="headerlink" href="#grpc-early-adopter-package" title="Permalink to this headline">¶</a></h1>
  75. <div class="section" id="submodules">
  76. <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
  77. </div>
  78. <div class="section" id="module-grpc.early_adopter.implementations">
  79. <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>
  80. <p>Entry points into GRPC.</p>
  81. <dl class="function">
  82. <dt id="grpc.early_adopter.implementations.server">
  83. <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><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>
  84. <dd><p>Constructs an interfaces.Server.</p>
  85. <table class="docutils field-list" frame="void" rules="none">
  86. <col class="field-name" />
  87. <col class="field-body" />
  88. <tbody valign="top">
  89. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  90. <li><strong>service_name</strong> &#8211; The package-qualified full name of the service.</li>
  91. <li><strong>methods</strong> &#8211; A dictionary from RPC method name to
  92. interfaces.RpcMethodServiceDescription describing the RPCs to
  93. be serviced by the created server. The RPC method names in the dictionary
  94. are not qualified by the service name or decorated in any other way.</li>
  95. <li><strong>port</strong> &#8211; The port on which to serve or zero to ask for a port to be
  96. automatically selected.</li>
  97. <li><strong>private_key</strong> &#8211; A pem-encoded private key, or None for an insecure server.</li>
  98. <li><strong>certificate_chain</strong> &#8211; A pem-encoded certificate chain, or None for an insecure
  99. server.</li>
  100. </ul>
  101. </td>
  102. </tr>
  103. <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>
  104. </td>
  105. </tr>
  106. </tbody>
  107. </table>
  108. </dd></dl>
  109. <dl class="function">
  110. <dt id="grpc.early_adopter.implementations.stub">
  111. <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><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>
  112. <dd><p>Constructs an interfaces.Stub.</p>
  113. <table class="docutils field-list" frame="void" rules="none">
  114. <col class="field-name" />
  115. <col class="field-body" />
  116. <tbody valign="top">
  117. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  118. <li><strong>service_name</strong> &#8211; The package-qualified full name of the service.</li>
  119. <li><strong>methods</strong> &#8211; A dictionary from RPC method name to
  120. interfaces.RpcMethodInvocationDescription describing the RPCs to be
  121. supported by the created stub. The RPC method names in the dictionary are
  122. not qualified by the service name or decorated in any other way.</li>
  123. <li><strong>host</strong> &#8211; The host to which to connect for RPC service.</li>
  124. <li><strong>port</strong> &#8211; The port to which to connect for RPC service.</li>
  125. <li><strong>metadata_transformer</strong> &#8211; A callable that given a metadata object produces
  126. another metadata object to be used in the underlying communication on the
  127. wire.</li>
  128. <li><strong>secure</strong> &#8211; Whether or not to construct the stub with a secure connection.</li>
  129. <li><strong>root_certificates</strong> &#8211; The PEM-encoded root certificates or None to ask for
  130. them to be retrieved from a default location.</li>
  131. <li><strong>private_key</strong> &#8211; The PEM-encoded private key to use or None if no private key
  132. should be used.</li>
  133. <li><strong>certificate_chain</strong> &#8211; The PEM-encoded certificate chain to use or None if no
  134. certificate chain should be used.</li>
  135. <li><strong>server_host_override</strong> &#8211; (For testing only) the target name used for SSL
  136. host name checking.</li>
  137. </ul>
  138. </td>
  139. </tr>
  140. <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>
  141. </td>
  142. </tr>
  143. </tbody>
  144. </table>
  145. </dd></dl>
  146. </div>
  147. <div class="section" id="module-grpc.early_adopter.implementations_test">
  148. <span id="grpc-early-adopter-implementations-test-module"></span><h2>grpc.early_adopter.implementations_test module<a class="headerlink" href="#module-grpc.early_adopter.implementations_test" title="Permalink to this headline">¶</a></h2>
  149. <p>Test of the GRPC-backed ForeLink and RearLink.</p>
  150. <dl class="class">
  151. <dt id="grpc.early_adopter.implementations_test.EarlyAdopterImplementationsTest">
  152. <em class="property">class </em><code class="descclassname">grpc.early_adopter.implementations_test.</code><code class="descname">EarlyAdopterImplementationsTest</code><span class="sig-paren">(</span><em>methodName='runTest'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/early_adopter/implementations_test.html#EarlyAdopterImplementationsTest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.early_adopter.implementations_test.EarlyAdopterImplementationsTest" title="Permalink to this definition">¶</a></dt>
  153. <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">unittest.case.TestCase</span></code></p>
  154. <dl class="method">
  155. <dt id="grpc.early_adopter.implementations_test.EarlyAdopterImplementationsTest.setUp">
  156. <code class="descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/early_adopter/implementations_test.html#EarlyAdopterImplementationsTest.setUp"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.early_adopter.implementations_test.EarlyAdopterImplementationsTest.setUp" title="Permalink to this definition">¶</a></dt>
  157. <dd></dd></dl>
  158. <dl class="method">
  159. <dt id="grpc.early_adopter.implementations_test.EarlyAdopterImplementationsTest.tearDown">
  160. <code class="descname">tearDown</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/early_adopter/implementations_test.html#EarlyAdopterImplementationsTest.tearDown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.early_adopter.implementations_test.EarlyAdopterImplementationsTest.tearDown" title="Permalink to this definition">¶</a></dt>
  161. <dd></dd></dl>
  162. <dl class="method">
  163. <dt id="grpc.early_adopter.implementations_test.EarlyAdopterImplementationsTest.testStreamStream">
  164. <code class="descname">testStreamStream</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/early_adopter/implementations_test.html#EarlyAdopterImplementationsTest.testStreamStream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.early_adopter.implementations_test.EarlyAdopterImplementationsTest.testStreamStream" title="Permalink to this definition">¶</a></dt>
  165. <dd></dd></dl>
  166. <dl class="method">
  167. <dt id="grpc.early_adopter.implementations_test.EarlyAdopterImplementationsTest.testStreamUnary">
  168. <code class="descname">testStreamUnary</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/early_adopter/implementations_test.html#EarlyAdopterImplementationsTest.testStreamUnary"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.early_adopter.implementations_test.EarlyAdopterImplementationsTest.testStreamUnary" title="Permalink to this definition">¶</a></dt>
  169. <dd></dd></dl>
  170. <dl class="method">
  171. <dt id="grpc.early_adopter.implementations_test.EarlyAdopterImplementationsTest.testUnaryStream">
  172. <code class="descname">testUnaryStream</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/early_adopter/implementations_test.html#EarlyAdopterImplementationsTest.testUnaryStream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.early_adopter.implementations_test.EarlyAdopterImplementationsTest.testUnaryStream" title="Permalink to this definition">¶</a></dt>
  173. <dd></dd></dl>
  174. <dl class="method">
  175. <dt id="grpc.early_adopter.implementations_test.EarlyAdopterImplementationsTest.testUnaryUnary">
  176. <code class="descname">testUnaryUnary</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/early_adopter/implementations_test.html#EarlyAdopterImplementationsTest.testUnaryUnary"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.early_adopter.implementations_test.EarlyAdopterImplementationsTest.testUnaryUnary" title="Permalink to this definition">¶</a></dt>
  177. <dd></dd></dl>
  178. <dl class="method">
  179. <dt id="grpc.early_adopter.implementations_test.EarlyAdopterImplementationsTest.testUpAndDown">
  180. <code class="descname">testUpAndDown</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/early_adopter/implementations_test.html#EarlyAdopterImplementationsTest.testUpAndDown"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.early_adopter.implementations_test.EarlyAdopterImplementationsTest.testUpAndDown" title="Permalink to this definition">¶</a></dt>
  181. <dd></dd></dl>
  182. </dd></dl>
  183. </div>
  184. <div class="section" id="module-grpc.early_adopter">
  185. <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-grpc.early_adopter" title="Permalink to this headline">¶</a></h2>
  186. </div>
  187. </div>
  188. </div>
  189. <footer>
  190. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  191. <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>
  192. <a href="grpc.html" class="btn btn-neutral" title="grpc package" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
  193. </div>
  194. <hr/>
  195. <div role="contentinfo">
  196. <p>
  197. &copy; Copyright 2015, Author.
  198. </p>
  199. </div>
  200. 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>.
  201. </footer>
  202. </div>
  203. </div>
  204. </section>
  205. </div>
  206. <script type="text/javascript">
  207. var DOCUMENTATION_OPTIONS = {
  208. URL_ROOT:'./',
  209. VERSION:'0.10.0a0',
  210. COLLAPSE_INDEX:false,
  211. FILE_SUFFIX:'.html',
  212. HAS_SOURCE: true
  213. };
  214. </script>
  215. <script type="text/javascript" src="_static/jquery.js"></script>
  216. <script type="text/javascript" src="_static/underscore.js"></script>
  217. <script type="text/javascript" src="_static/doctools.js"></script>
  218. <script type="text/javascript" src="_static/js/theme.js"></script>
  219. <script type="text/javascript">
  220. jQuery(function () {
  221. SphinxRtdTheme.StickyNav.enable();
  222. });
  223. </script>
  224. </body>
  225. </html>