grpc.framework.common.html 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282
  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 0.15.0 documentation</title>
  8. <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  9. <link rel="top" title="grpcio 0.15.0 documentation" href="index.html"/>
  10. <link rel="up" title="grpc.framework package" href="grpc.framework.html"/>
  11. <link rel="next" title="grpc.framework.core package" href="grpc.framework.core.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. 0.15.0
  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. </ul>
  49. </div>
  50. </div>
  51. </nav>
  52. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  53. <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
  54. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  55. <a href="index.html">grpcio</a>
  56. </nav>
  57. <div class="wy-nav-content">
  58. <div class="rst-content">
  59. <div role="navigation" aria-label="breadcrumbs navigation">
  60. <ul class="wy-breadcrumbs">
  61. <li><a href="index.html">Docs</a> &raquo;</li>
  62. <li><a href="grpc.html">grpc package</a> &raquo;</li>
  63. <li><a href="grpc.framework.html">grpc.framework package</a> &raquo;</li>
  64. <li>grpc.framework.common package</li>
  65. <li class="wy-breadcrumbs-aside">
  66. <a href="_sources/grpc.framework.common.txt" rel="nofollow"> View page source</a>
  67. </li>
  68. </ul>
  69. <hr/>
  70. </div>
  71. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  72. <div itemprop="articleBody">
  73. <div class="section" id="grpc-framework-common-package">
  74. <h1>grpc.framework.common package<a class="headerlink" href="#grpc-framework-common-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.framework.common.cardinality">
  79. <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>
  80. <p>Defines an enum for classifying RPC methods by streaming semantics.</p>
  81. <dl class="class">
  82. <dt id="grpc.framework.common.cardinality.Cardinality">
  83. <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>
  84. <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">enum.Enum</span></code></p>
  85. <p>Describes the streaming semantics of an RPC method.</p>
  86. <dl class="attribute">
  87. <dt id="grpc.framework.common.cardinality.Cardinality.STREAM_STREAM">
  88. <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>
  89. <dd></dd></dl>
  90. <dl class="attribute">
  91. <dt id="grpc.framework.common.cardinality.Cardinality.STREAM_UNARY">
  92. <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>
  93. <dd></dd></dl>
  94. <dl class="attribute">
  95. <dt id="grpc.framework.common.cardinality.Cardinality.UNARY_STREAM">
  96. <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>
  97. <dd></dd></dl>
  98. <dl class="attribute">
  99. <dt id="grpc.framework.common.cardinality.Cardinality.UNARY_UNARY">
  100. <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>
  101. <dd></dd></dl>
  102. </dd></dl>
  103. </div>
  104. <div class="section" id="module-grpc.framework.common.style">
  105. <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>
  106. <p>Defines an enum for classifying RPC methods by control flow semantics.</p>
  107. <dl class="class">
  108. <dt id="grpc.framework.common.style.Service">
  109. <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>
  110. <dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">enum.Enum</span></code></p>
  111. <p>Describes the control flow style of RPC method implementation.</p>
  112. <dl class="attribute">
  113. <dt id="grpc.framework.common.style.Service.EVENT">
  114. <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>
  115. <dd></dd></dl>
  116. <dl class="attribute">
  117. <dt id="grpc.framework.common.style.Service.INLINE">
  118. <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>
  119. <dd></dd></dl>
  120. </dd></dl>
  121. </div>
  122. <div class="section" id="module-grpc.framework.common">
  123. <span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-grpc.framework.common" title="Permalink to this headline">¶</a></h2>
  124. </div>
  125. </div>
  126. </div>
  127. </div>
  128. <footer>
  129. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  130. <a href="grpc.framework.core.html" class="btn btn-neutral float-right" title="grpc.framework.core package" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
  131. <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>
  132. </div>
  133. <hr/>
  134. <div role="contentinfo">
  135. <p>
  136. &copy; Copyright 2016, Author.
  137. </p>
  138. </div>
  139. 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>.
  140. </footer>
  141. </div>
  142. </div>
  143. </section>
  144. </div>
  145. <script type="text/javascript">
  146. var DOCUMENTATION_OPTIONS = {
  147. URL_ROOT:'./',
  148. VERSION:'0.15.0',
  149. COLLAPSE_INDEX:false,
  150. FILE_SUFFIX:'.html',
  151. HAS_SOURCE: true
  152. };
  153. </script>
  154. <script type="text/javascript" src="_static/jquery.js"></script>
  155. <script type="text/javascript" src="_static/underscore.js"></script>
  156. <script type="text/javascript" src="_static/doctools.js"></script>
  157. <script type="text/javascript" src="_static/js/theme.js"></script>
  158. <script type="text/javascript">
  159. jQuery(function () {
  160. SphinxRtdTheme.StickyNav.enable();
  161. });
  162. </script>
  163. </body>
  164. </html>