grpc.framework.common.html 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311
  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.2.0 documentation</title>
  8. <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  9. <link rel="index" title="Index"
  10. href="genindex.html"/>
  11. <link rel="search" title="Search" href="search.html"/>
  12. <link rel="top" title="grpcio 1.2.0 documentation" href="index.html"/>
  13. <link rel="up" title="grpc.framework package" href="grpc.framework.html"/>
  14. <link rel="next" title="grpc.framework.foundation package" href="grpc.framework.foundation.html"/>
  15. <link rel="prev" title="grpc.framework package" href="grpc.framework.html"/>
  16. <script src="_static/js/modernizr.min.js"></script>
  17. </head>
  18. <body class="wy-body-for-nav" role="document">
  19. <div class="wy-grid-for-nav">
  20. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  21. <div class="wy-side-scroll">
  22. <div class="wy-side-nav-search">
  23. <a href="index.html" class="icon icon-home"> grpcio
  24. </a>
  25. <div class="version">
  26. 1.2.0
  27. </div>
  28. <div role="search">
  29. <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
  30. <input type="text" name="q" placeholder="Search docs" />
  31. <input type="hidden" name="check_keywords" value="yes" />
  32. <input type="hidden" name="area" value="default" />
  33. </form>
  34. </div>
  35. </div>
  36. <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  37. <p class="caption"><span class="caption-text">Contents:</span></p>
  38. <ul class="current">
  39. <li class="toctree-l1 current"><a class="reference internal" href="grpc.html">grpc package</a><ul class="current">
  40. <li class="toctree-l2 current"><a class="reference internal" href="grpc.html#subpackages">Subpackages</a><ul class="current">
  41. <li class="toctree-l3"><a class="reference internal" href="grpc.beta.html">grpc.beta package</a></li>
  42. <li class="toctree-l3 current"><a class="reference internal" href="grpc.framework.html">grpc.framework package</a><ul class="current">
  43. <li class="toctree-l4 current"><a class="reference internal" href="grpc.framework.html#subpackages">Subpackages</a></li>
  44. <li class="toctree-l4"><a class="reference internal" href="grpc.framework.html#module-grpc.framework">Module contents</a></li>
  45. </ul>
  46. </li>
  47. </ul>
  48. </li>
  49. <li class="toctree-l2"><a class="reference internal" href="grpc.html#module-grpc">Module contents</a></li>
  50. </ul>
  51. </li>
  52. <li class="toctree-l1"><a class="reference internal" href="grpc.html#glossary">Glossary</a></li>
  53. </ul>
  54. </div>
  55. </div>
  56. </nav>
  57. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  58. <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
  59. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  60. <a href="index.html">grpcio</a>
  61. </nav>
  62. <div class="wy-nav-content">
  63. <div class="rst-content">
  64. <div role="navigation" aria-label="breadcrumbs navigation">
  65. <ul class="wy-breadcrumbs">
  66. <li><a href="index.html">Docs</a> &raquo;</li>
  67. <li><a href="grpc.html">grpc package</a> &raquo;</li>
  68. <li><a href="grpc.framework.html">grpc.framework package</a> &raquo;</li>
  69. <li>grpc.framework.common package</li>
  70. <li class="wy-breadcrumbs-aside">
  71. <a href="_sources/grpc.framework.common.rst.txt" rel="nofollow"> View page source</a>
  72. </li>
  73. </ul>
  74. <hr/>
  75. </div>
  76. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  77. <div itemprop="articleBody">
  78. <div class="section" id="grpc-framework-common-package">
  79. <h1>grpc.framework.common package<a class="headerlink" href="#grpc-framework-common-package" title="Permalink to this headline">¶</a></h1>
  80. <div class="section" id="submodules">
  81. <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
  82. </div>
  83. <div class="section" id="module-grpc.framework.common.cardinality">
  84. <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>
  85. <p>Defines an enum for classifying RPC methods by streaming semantics.</p>
  86. <dl class="class">
  87. <dt id="grpc.framework.common.cardinality.Cardinality">
  88. <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>
  89. <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">enum.Enum</span></code></p>
  90. <p>Describes the streaming semantics of an RPC method.</p>
  91. <dl class="attribute">
  92. <dt id="grpc.framework.common.cardinality.Cardinality.STREAM_STREAM">
  93. <code class="descname">STREAM_STREAM</code><em class="property"> = 'request-streaming/response-streaming'</em><a class="headerlink" href="#grpc.framework.common.cardinality.Cardinality.STREAM_STREAM" title="Permalink to this definition">¶</a></dt>
  94. <dd></dd></dl>
  95. <dl class="attribute">
  96. <dt id="grpc.framework.common.cardinality.Cardinality.STREAM_UNARY">
  97. <code class="descname">STREAM_UNARY</code><em class="property"> = 'request-streaming/response-unary'</em><a class="headerlink" href="#grpc.framework.common.cardinality.Cardinality.STREAM_UNARY" title="Permalink to this definition">¶</a></dt>
  98. <dd></dd></dl>
  99. <dl class="attribute">
  100. <dt id="grpc.framework.common.cardinality.Cardinality.UNARY_STREAM">
  101. <code class="descname">UNARY_STREAM</code><em class="property"> = 'request-unary/response-streaming'</em><a class="headerlink" href="#grpc.framework.common.cardinality.Cardinality.UNARY_STREAM" title="Permalink to this definition">¶</a></dt>
  102. <dd></dd></dl>
  103. <dl class="attribute">
  104. <dt id="grpc.framework.common.cardinality.Cardinality.UNARY_UNARY">
  105. <code class="descname">UNARY_UNARY</code><em class="property"> = 'request-unary/response-unary'</em><a class="headerlink" href="#grpc.framework.common.cardinality.Cardinality.UNARY_UNARY" title="Permalink to this definition">¶</a></dt>
  106. <dd></dd></dl>
  107. </dd></dl>
  108. </div>
  109. <div class="section" id="module-grpc.framework.common.style">
  110. <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>
  111. <p>Defines an enum for classifying RPC methods by control flow semantics.</p>
  112. <dl class="class">
  113. <dt id="grpc.framework.common.style.Service">
  114. <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>
  115. <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">enum.Enum</span></code></p>
  116. <p>Describes the control flow style of RPC method implementation.</p>
  117. <dl class="attribute">
  118. <dt id="grpc.framework.common.style.Service.EVENT">
  119. <code class="descname">EVENT</code><em class="property"> = 'event'</em><a class="headerlink" href="#grpc.framework.common.style.Service.EVENT" title="Permalink to this definition">¶</a></dt>
  120. <dd></dd></dl>
  121. <dl class="attribute">
  122. <dt id="grpc.framework.common.style.Service.INLINE">
  123. <code class="descname">INLINE</code><em class="property"> = 'inline'</em><a class="headerlink" href="#grpc.framework.common.style.Service.INLINE" title="Permalink to this definition">¶</a></dt>
  124. <dd></dd></dl>
  125. </dd></dl>
  126. </div>
  127. <div class="section" id="module-grpc.framework.common">
  128. <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-grpc.framework.common" title="Permalink to this headline">¶</a></h2>
  129. </div>
  130. </div>
  131. </div>
  132. <div class="articleComments">
  133. </div>
  134. </div>
  135. <footer>
  136. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  137. <a href="grpc.framework.foundation.html" class="btn btn-neutral float-right" title="grpc.framework.foundation package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
  138. <a href="grpc.framework.html" class="btn btn-neutral" title="grpc.framework package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
  139. </div>
  140. <hr/>
  141. <div role="contentinfo">
  142. <p>
  143. &copy; Copyright 2016, The gRPC Authors.
  144. </p>
  145. </div>
  146. 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>.
  147. </footer>
  148. </div>
  149. </div>
  150. </section>
  151. </div>
  152. <script type="text/javascript">
  153. var DOCUMENTATION_OPTIONS = {
  154. URL_ROOT:'./',
  155. VERSION:'1.2.0',
  156. COLLAPSE_INDEX:false,
  157. FILE_SUFFIX:'.html',
  158. HAS_SOURCE: true,
  159. SOURCELINK_SUFFIX: '.txt'
  160. };
  161. </script>
  162. <script type="text/javascript" src="_static/jquery.js"></script>
  163. <script type="text/javascript" src="_static/underscore.js"></script>
  164. <script type="text/javascript" src="_static/doctools.js"></script>
  165. <script type="text/javascript" src="_static/js/theme.js"></script>
  166. <script type="text/javascript">
  167. jQuery(function () {
  168. SphinxRtdTheme.StickyNav.enable();
  169. });
  170. </script>
  171. </body>
  172. </html>