grpc.framework.crust.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301
  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.framework.crust package &mdash; grpcio 0.11.0b0 documentation</title>
  8. <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  9. <link rel="top" title="grpcio 0.11.0b0 documentation" href="index.html"/>
  10. <link rel="up" title="grpc.framework package" href="grpc.framework.html"/>
  11. <link rel="next" title="grpc.framework.face package" href="grpc.framework.face.html"/>
  12. <link rel="prev" title="grpc.framework.core package" href="grpc.framework.core.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"><a class="reference internal" href="grpc.beta.html">grpc.beta package</a><ul>
  34. <li class="toctree-l4"><a class="reference internal" href="grpc.beta.html#submodules">Submodules</a></li>
  35. <li class="toctree-l4"><a class="reference internal" href="grpc.beta.html#module-grpc.beta.implementations">grpc.beta.implementations module</a></li>
  36. <li class="toctree-l4"><a class="reference internal" href="grpc.beta.html#module-grpc.beta.interfaces">grpc.beta.interfaces module</a></li>
  37. <li class="toctree-l4"><a class="reference internal" href="grpc.beta.html#module-grpc.beta.utilities">grpc.beta.utilities module</a></li>
  38. <li class="toctree-l4"><a class="reference internal" href="grpc.beta.html#module-grpc.beta">Module contents</a></li>
  39. </ul>
  40. </li>
  41. <li class="toctree-l3"><a class="reference internal" href="grpc.early_adopter.html">grpc.early_adopter package</a><ul>
  42. <li class="toctree-l4"><a class="reference internal" href="grpc.early_adopter.html#submodules">Submodules</a></li>
  43. <li class="toctree-l4"><a class="reference internal" href="grpc.early_adopter.html#module-grpc.early_adopter.implementations">grpc.early_adopter.implementations module</a></li>
  44. <li class="toctree-l4"><a class="reference internal" href="grpc.early_adopter.html#module-grpc.early_adopter">Module contents</a></li>
  45. </ul>
  46. </li>
  47. <li class="toctree-l3 current"><a class="reference internal" href="grpc.framework.html">grpc.framework package</a><ul class="current">
  48. <li class="toctree-l4 current"><a class="reference internal" href="grpc.framework.html#subpackages">Subpackages</a></li>
  49. <li class="toctree-l4"><a class="reference internal" href="grpc.framework.html#module-grpc.framework">Module contents</a></li>
  50. </ul>
  51. </li>
  52. </ul>
  53. </li>
  54. <li class="toctree-l2"><a class="reference internal" href="grpc.html#module-grpc">Module contents</a></li>
  55. </ul>
  56. </li>
  57. </ul>
  58. </div>
  59. &nbsp;
  60. </nav>
  61. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  62. <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
  63. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  64. <a href="index.html">grpcio</a>
  65. </nav>
  66. <div class="wy-nav-content">
  67. <div class="rst-content">
  68. <div role="navigation" aria-label="breadcrumbs navigation">
  69. <ul class="wy-breadcrumbs">
  70. <li><a href="index.html">Docs</a> &raquo;</li>
  71. <li><a href="grpc.html">grpc package</a> &raquo;</li>
  72. <li><a href="grpc.framework.html">grpc.framework package</a> &raquo;</li>
  73. <li>grpc.framework.crust package</li>
  74. <li class="wy-breadcrumbs-aside">
  75. <a href="_sources/grpc.framework.crust.txt" rel="nofollow"> View page source</a>
  76. </li>
  77. </ul>
  78. <hr/>
  79. </div>
  80. <div role="main" class="document">
  81. <div class="section" id="grpc-framework-crust-package">
  82. <h1>grpc.framework.crust package<a class="headerlink" href="#grpc-framework-crust-package" title="Permalink to this headline">¶</a></h1>
  83. <div class="section" id="submodules">
  84. <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
  85. </div>
  86. <div class="section" id="module-grpc.framework.crust.implementations">
  87. <span id="grpc-framework-crust-implementations-module"></span><h2>grpc.framework.crust.implementations module<a class="headerlink" href="#module-grpc.framework.crust.implementations" title="Permalink to this headline">¶</a></h2>
  88. <p>Entry points into the Crust layer of RPC Framework.</p>
  89. <dl class="function">
  90. <dt id="grpc.framework.crust.implementations.dynamic_stub">
  91. <code class="descclassname">grpc.framework.crust.implementations.</code><code class="descname">dynamic_stub</code><span class="sig-paren">(</span><em>end</em>, <em>group</em>, <em>cardinalities</em>, <em>pool</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/crust/implementations.html#dynamic_stub"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.crust.implementations.dynamic_stub" title="Permalink to this definition">¶</a></dt>
  92. <dd><p>Creates an face.DynamicStub.</p>
  93. <table class="docutils field-list" frame="void" rules="none">
  94. <col class="field-name" />
  95. <col class="field-body" />
  96. <tbody valign="top">
  97. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  98. <li><strong>end</strong> &#8211; A base.End.</li>
  99. <li><strong>group</strong> &#8211; The group identifier for all RPCs to be made with the created
  100. face.DynamicStub.</li>
  101. <li><strong>cardinalities</strong> &#8211; A dict from method identifier to cardinality.Cardinality
  102. value identifying the cardinality of every RPC method to be supported by
  103. the created face.DynamicStub.</li>
  104. <li><strong>pool</strong> &#8211; A futures.ThreadPoolExecutor.</li>
  105. </ul>
  106. </td>
  107. </tr>
  108. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A face.DynamicStub that performs RPCs via the given base.End.</p>
  109. </td>
  110. </tr>
  111. </tbody>
  112. </table>
  113. </dd></dl>
  114. <dl class="function">
  115. <dt id="grpc.framework.crust.implementations.generic_stub">
  116. <code class="descclassname">grpc.framework.crust.implementations.</code><code class="descname">generic_stub</code><span class="sig-paren">(</span><em>end</em>, <em>pool</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/crust/implementations.html#generic_stub"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.crust.implementations.generic_stub" title="Permalink to this definition">¶</a></dt>
  117. <dd><p>Creates an face.GenericStub.</p>
  118. <table class="docutils field-list" frame="void" rules="none">
  119. <col class="field-name" />
  120. <col class="field-body" />
  121. <tbody valign="top">
  122. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  123. <li><strong>end</strong> &#8211; A base.End.</li>
  124. <li><strong>pool</strong> &#8211; A futures.ThreadPoolExecutor.</li>
  125. </ul>
  126. </td>
  127. </tr>
  128. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A face.GenericStub that performs RPCs via the given base.End.</p>
  129. </td>
  130. </tr>
  131. </tbody>
  132. </table>
  133. </dd></dl>
  134. <dl class="function">
  135. <dt id="grpc.framework.crust.implementations.servicer">
  136. <code class="descclassname">grpc.framework.crust.implementations.</code><code class="descname">servicer</code><span class="sig-paren">(</span><em>method_implementations</em>, <em>multi_method_implementation</em>, <em>pool</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/crust/implementations.html#servicer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.crust.implementations.servicer" title="Permalink to this definition">¶</a></dt>
  137. <dd><p>Creates a base.Servicer.</p>
  138. <p>It is guaranteed that any passed face.MultiMethodImplementation will
  139. only be called to service an RPC if there is no
  140. face.MethodImplementation for the RPC method in the passed
  141. method_implementations dictionary.</p>
  142. <table class="docutils field-list" frame="void" rules="none">
  143. <col class="field-name" />
  144. <col class="field-body" />
  145. <tbody valign="top">
  146. <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
  147. <li><strong>method_implementations</strong> &#8211; A dictionary from RPC method name to
  148. face.MethodImplementation object to be used to service the named
  149. RPC method.</li>
  150. <li><strong>multi_method_implementation</strong> &#8211; An face.MultiMethodImplementation to be
  151. used to service any RPCs not serviced by the
  152. face.MethodImplementations given in the method_implementations
  153. dictionary, or None.</li>
  154. <li><strong>pool</strong> &#8211; A thread pool.</li>
  155. </ul>
  156. </td>
  157. </tr>
  158. <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A base.Servicer that services RPCs via the given implementations.</p>
  159. </td>
  160. </tr>
  161. </tbody>
  162. </table>
  163. </dd></dl>
  164. </div>
  165. <div class="section" id="module-grpc.framework.crust">
  166. <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-grpc.framework.crust" title="Permalink to this headline">¶</a></h2>
  167. </div>
  168. </div>
  169. </div>
  170. <footer>
  171. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  172. <a href="grpc.framework.face.html" class="btn btn-neutral float-right" title="grpc.framework.face package" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
  173. <a href="grpc.framework.core.html" class="btn btn-neutral" title="grpc.framework.core package" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
  174. </div>
  175. <hr/>
  176. <div role="contentinfo">
  177. <p>
  178. &copy; Copyright 2015, Author.
  179. </p>
  180. </div>
  181. 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>.
  182. </footer>
  183. </div>
  184. </div>
  185. </section>
  186. </div>
  187. <script type="text/javascript">
  188. var DOCUMENTATION_OPTIONS = {
  189. URL_ROOT:'./',
  190. VERSION:'0.11.0b0',
  191. COLLAPSE_INDEX:false,
  192. FILE_SUFFIX:'.html',
  193. HAS_SOURCE: true
  194. };
  195. </script>
  196. <script type="text/javascript" src="_static/jquery.js"></script>
  197. <script type="text/javascript" src="_static/underscore.js"></script>
  198. <script type="text/javascript" src="_static/doctools.js"></script>
  199. <script type="text/javascript" src="_static/js/theme.js"></script>
  200. <script type="text/javascript">
  201. jQuery(function () {
  202. SphinxRtdTheme.StickyNav.enable();
  203. });
  204. </script>
  205. </body>
  206. </html>