grpc.framework.common.html 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283
  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.common package &mdash; grpcio 1.0.0rc1 documentation</title>
  8. <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  9. <link rel="top" title="grpcio 1.0.0rc1 documentation" href="index.html"/>
  10. <link rel="up" title="grpc.framework package" href="grpc.framework.html"/>
  11. <link rel="next" title="grpc.framework.foundation package" href="grpc.framework.foundation.html"/>
  12. <link rel="prev" title="grpc.framework package" href="grpc.framework.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. 1.0.0rc1
  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="reference internal" href="grpc.framework.html">grpc.framework package</a><ul class="current">
  39. <li class="toctree-l4 current"><a class="reference internal" href="grpc.framework.html#subpackages">Subpackages</a></li>
  40. <li class="toctree-l4"><a class="reference internal" href="grpc.framework.html#module-grpc.framework">Module contents</a></li>
  41. </ul>
  42. </li>
  43. </ul>
  44. </li>
  45. <li class="toctree-l2"><a class="reference internal" href="grpc.html#module-grpc">Module contents</a></li>
  46. </ul>
  47. </li>
  48. <li class="toctree-l1"><a class="reference internal" href="grpc.html#glossary">Glossary</a></li>
  49. </ul>
  50. </div>
  51. </div>
  52. </nav>
  53. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  54. <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
  55. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  56. <a href="index.html">grpcio</a>
  57. </nav>
  58. <div class="wy-nav-content">
  59. <div class="rst-content">
  60. <div role="navigation" aria-label="breadcrumbs navigation">
  61. <ul class="wy-breadcrumbs">
  62. <li><a href="index.html">Docs</a> &raquo;</li>
  63. <li><a href="grpc.html">grpc package</a> &raquo;</li>
  64. <li><a href="grpc.framework.html">grpc.framework package</a> &raquo;</li>
  65. <li>grpc.framework.common package</li>
  66. <li class="wy-breadcrumbs-aside">
  67. <a href="_sources/grpc.framework.common.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-framework-common-package">
  75. <h1>grpc.framework.common package<a class="headerlink" href="#grpc-framework-common-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.framework.common.cardinality">
  80. <span id="grpc-framework-common-cardinality-module"></span><h2>grpc.framework.common.cardinality module<a class="headerlink" href="#module-grpc.framework.common.cardinality" title="Permalink to this headline">¶</a></h2>
  81. <p>Defines an enum for classifying RPC methods by streaming semantics.</p>
  82. <dl class="class">
  83. <dt id="grpc.framework.common.cardinality.Cardinality">
  84. <em class="property">class </em><code class="descclassname">grpc.framework.common.cardinality.</code><code class="descname">Cardinality</code><a class="reference internal" href="_modules/grpc/framework/common/cardinality.html#Cardinality"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.common.cardinality.Cardinality" title="Permalink to this definition">¶</a></dt>
  85. <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">enum.Enum</span></code></p>
  86. <p>Describes the streaming semantics of an RPC method.</p>
  87. <dl class="attribute">
  88. <dt id="grpc.framework.common.cardinality.Cardinality.STREAM_STREAM">
  89. <code class="descname">STREAM_STREAM</code><em class="property"> = &lt;Cardinality.STREAM_STREAM: 'request-streaming/response-streaming'&gt;</em><a class="headerlink" href="#grpc.framework.common.cardinality.Cardinality.STREAM_STREAM" title="Permalink to this definition">¶</a></dt>
  90. <dd></dd></dl>
  91. <dl class="attribute">
  92. <dt id="grpc.framework.common.cardinality.Cardinality.STREAM_UNARY">
  93. <code class="descname">STREAM_UNARY</code><em class="property"> = &lt;Cardinality.STREAM_UNARY: 'request-streaming/response-unary'&gt;</em><a class="headerlink" href="#grpc.framework.common.cardinality.Cardinality.STREAM_UNARY" title="Permalink to this definition">¶</a></dt>
  94. <dd></dd></dl>
  95. <dl class="attribute">
  96. <dt id="grpc.framework.common.cardinality.Cardinality.UNARY_STREAM">
  97. <code class="descname">UNARY_STREAM</code><em class="property"> = &lt;Cardinality.UNARY_STREAM: 'request-unary/response-streaming'&gt;</em><a class="headerlink" href="#grpc.framework.common.cardinality.Cardinality.UNARY_STREAM" title="Permalink to this definition">¶</a></dt>
  98. <dd></dd></dl>
  99. <dl class="attribute">
  100. <dt id="grpc.framework.common.cardinality.Cardinality.UNARY_UNARY">
  101. <code class="descname">UNARY_UNARY</code><em class="property"> = &lt;Cardinality.UNARY_UNARY: 'request-unary/response-unary'&gt;</em><a class="headerlink" href="#grpc.framework.common.cardinality.Cardinality.UNARY_UNARY" title="Permalink to this definition">¶</a></dt>
  102. <dd></dd></dl>
  103. </dd></dl>
  104. </div>
  105. <div class="section" id="module-grpc.framework.common.style">
  106. <span id="grpc-framework-common-style-module"></span><h2>grpc.framework.common.style module<a class="headerlink" href="#module-grpc.framework.common.style" title="Permalink to this headline">¶</a></h2>
  107. <p>Defines an enum for classifying RPC methods by control flow semantics.</p>
  108. <dl class="class">
  109. <dt id="grpc.framework.common.style.Service">
  110. <em class="property">class </em><code class="descclassname">grpc.framework.common.style.</code><code class="descname">Service</code><a class="reference internal" href="_modules/grpc/framework/common/style.html#Service"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.common.style.Service" title="Permalink to this definition">¶</a></dt>
  111. <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">enum.Enum</span></code></p>
  112. <p>Describes the control flow style of RPC method implementation.</p>
  113. <dl class="attribute">
  114. <dt id="grpc.framework.common.style.Service.EVENT">
  115. <code class="descname">EVENT</code><em class="property"> = &lt;Service.EVENT: 'event'&gt;</em><a class="headerlink" href="#grpc.framework.common.style.Service.EVENT" title="Permalink to this definition">¶</a></dt>
  116. <dd></dd></dl>
  117. <dl class="attribute">
  118. <dt id="grpc.framework.common.style.Service.INLINE">
  119. <code class="descname">INLINE</code><em class="property"> = &lt;Service.INLINE: 'inline'&gt;</em><a class="headerlink" href="#grpc.framework.common.style.Service.INLINE" title="Permalink to this definition">¶</a></dt>
  120. <dd></dd></dl>
  121. </dd></dl>
  122. </div>
  123. <div class="section" id="module-grpc.framework.common">
  124. <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-grpc.framework.common" title="Permalink to this headline">¶</a></h2>
  125. </div>
  126. </div>
  127. </div>
  128. </div>
  129. <footer>
  130. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  131. <a href="grpc.framework.foundation.html" class="btn btn-neutral float-right" title="grpc.framework.foundation package" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
  132. <a href="grpc.framework.html" class="btn btn-neutral" title="grpc.framework package" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
  133. </div>
  134. <hr/>
  135. <div role="contentinfo">
  136. <p>
  137. &copy; Copyright 2016, Author.
  138. </p>
  139. </div>
  140. 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>.
  141. </footer>
  142. </div>
  143. </div>
  144. </section>
  145. </div>
  146. <script type="text/javascript">
  147. var DOCUMENTATION_OPTIONS = {
  148. URL_ROOT:'./',
  149. VERSION:'1.0.0rc1',
  150. COLLAPSE_INDEX:false,
  151. FILE_SUFFIX:'.html',
  152. HAS_SOURCE: true
  153. };
  154. </script>
  155. <script type="text/javascript" src="_static/jquery.js"></script>
  156. <script type="text/javascript" src="_static/underscore.js"></script>
  157. <script type="text/javascript" src="_static/doctools.js"></script>
  158. <script type="text/javascript" src="_static/js/theme.js"></script>
  159. <script type="text/javascript">
  160. jQuery(function () {
  161. SphinxRtdTheme.StickyNav.enable();
  162. });
  163. </script>
  164. </body>
  165. </html>