in_memory.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298
  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.base.in_memory &mdash; grpcio 0.13.1rc1 documentation</title>
  8. <link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
  9. <link rel="top" title="grpcio 0.13.1rc1 documentation" href="../../../../index.html"/>
  10. <link rel="up" title="Module code" href="../../../index.html"/>
  11. <script src="../../../../_static/js/modernizr.min.js"></script>
  12. </head>
  13. <body class="wy-body-for-nav" role="document">
  14. <div class="wy-grid-for-nav">
  15. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  16. <div class="wy-side-scroll">
  17. <div class="wy-side-nav-search">
  18. <a href="../../../../index.html" class="icon icon-home"> grpcio
  19. </a>
  20. <div class="version">
  21. 0.13.1rc1
  22. </div>
  23. <div role="search">
  24. <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
  25. <input type="text" name="q" placeholder="Search docs" />
  26. <input type="hidden" name="check_keywords" value="yes" />
  27. <input type="hidden" name="area" value="default" />
  28. </form>
  29. </div>
  30. </div>
  31. <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  32. <ul>
  33. <li class="toctree-l1"><a class="reference internal" href="../../../../grpc.html">grpc package</a></li>
  34. </ul>
  35. </div>
  36. </div>
  37. </nav>
  38. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  39. <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
  40. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  41. <a href="../../../../index.html">grpcio</a>
  42. </nav>
  43. <div class="wy-nav-content">
  44. <div class="rst-content">
  45. <div role="navigation" aria-label="breadcrumbs navigation">
  46. <ul class="wy-breadcrumbs">
  47. <li><a href="../../../../index.html">Docs</a> &raquo;</li>
  48. <li><a href="../../../index.html">Module code</a> &raquo;</li>
  49. <li>grpc.framework.base.in_memory</li>
  50. <li class="wy-breadcrumbs-aside">
  51. </li>
  52. </ul>
  53. <hr/>
  54. </div>
  55. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  56. <div itemprop="articleBody">
  57. <h1>Source code for grpc.framework.base.in_memory</h1><div class="highlight"><pre>
  58. <span></span><span class="c1"># Copyright 2015, Google Inc.</span>
  59. <span class="c1"># All rights reserved.</span>
  60. <span class="c1">#</span>
  61. <span class="c1"># Redistribution and use in source and binary forms, with or without</span>
  62. <span class="c1"># modification, are permitted provided that the following conditions are</span>
  63. <span class="c1"># met:</span>
  64. <span class="c1">#</span>
  65. <span class="c1"># * Redistributions of source code must retain the above copyright</span>
  66. <span class="c1"># notice, this list of conditions and the following disclaimer.</span>
  67. <span class="c1"># * Redistributions in binary form must reproduce the above</span>
  68. <span class="c1"># copyright notice, this list of conditions and the following disclaimer</span>
  69. <span class="c1"># in the documentation and/or other materials provided with the</span>
  70. <span class="c1"># distribution.</span>
  71. <span class="c1"># * Neither the name of Google Inc. nor the names of its</span>
  72. <span class="c1"># contributors may be used to endorse or promote products derived from</span>
  73. <span class="c1"># this software without specific prior written permission.</span>
  74. <span class="c1">#</span>
  75. <span class="c1"># THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS</span>
  76. <span class="c1"># &quot;AS IS&quot; AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT</span>
  77. <span class="c1"># LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR</span>
  78. <span class="c1"># A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT</span>
  79. <span class="c1"># OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,</span>
  80. <span class="c1"># SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT</span>
  81. <span class="c1"># LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,</span>
  82. <span class="c1"># DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY</span>
  83. <span class="c1"># THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT</span>
  84. <span class="c1"># (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE</span>
  85. <span class="c1"># OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span>
  86. <span class="sd">&quot;&quot;&quot;In-memory implementations of base layer interfaces.&quot;&quot;&quot;</span>
  87. <span class="kn">import</span> <span class="nn">threading</span>
  88. <span class="kn">from</span> <span class="nn">grpc.framework.base</span> <span class="k">import</span> <span class="n">_constants</span>
  89. <span class="kn">from</span> <span class="nn">grpc.framework.base</span> <span class="k">import</span> <span class="n">interfaces</span>
  90. <span class="kn">from</span> <span class="nn">grpc.framework.foundation</span> <span class="k">import</span> <span class="n">callable_util</span>
  91. <span class="k">class</span> <span class="nc">_Serializer</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
  92. <span class="sd">&quot;&quot;&quot;A utility for serializing values that may arrive concurrently.&quot;&quot;&quot;</span>
  93. <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">pool</span><span class="p">):</span>
  94. <span class="bp">self</span><span class="o">.</span><span class="n">_lock</span> <span class="o">=</span> <span class="n">threading</span><span class="o">.</span><span class="n">Lock</span><span class="p">()</span>
  95. <span class="bp">self</span><span class="o">.</span><span class="n">_pool</span> <span class="o">=</span> <span class="n">pool</span>
  96. <span class="bp">self</span><span class="o">.</span><span class="n">_sink</span> <span class="o">=</span> <span class="kc">None</span>
  97. <span class="bp">self</span><span class="o">.</span><span class="n">_spinning</span> <span class="o">=</span> <span class="kc">False</span>
  98. <span class="bp">self</span><span class="o">.</span><span class="n">_values</span> <span class="o">=</span> <span class="p">[]</span>
  99. <span class="k">def</span> <span class="nf">_spin</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sink</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
  100. <span class="k">while</span> <span class="kc">True</span><span class="p">:</span>
  101. <span class="n">sink</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
  102. <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">_lock</span><span class="p">:</span>
  103. <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_sink</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_values</span><span class="p">:</span>
  104. <span class="bp">self</span><span class="o">.</span><span class="n">_spinning</span> <span class="o">=</span> <span class="kc">False</span>
  105. <span class="k">return</span>
  106. <span class="k">else</span><span class="p">:</span>
  107. <span class="n">sink</span><span class="p">,</span> <span class="n">value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_sink</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_values</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
  108. <span class="k">def</span> <span class="nf">set_sink</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">sink</span><span class="p">):</span>
  109. <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">_lock</span><span class="p">:</span>
  110. <span class="bp">self</span><span class="o">.</span><span class="n">_sink</span> <span class="o">=</span> <span class="n">sink</span>
  111. <span class="k">if</span> <span class="n">sink</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">_values</span> <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_spinning</span><span class="p">:</span>
  112. <span class="bp">self</span><span class="o">.</span><span class="n">_spinning</span> <span class="o">=</span> <span class="kc">True</span>
  113. <span class="bp">self</span><span class="o">.</span><span class="n">_pool</span><span class="o">.</span><span class="n">submit</span><span class="p">(</span>
  114. <span class="n">callable_util</span><span class="o">.</span><span class="n">with_exceptions_logged</span><span class="p">(</span>
  115. <span class="bp">self</span><span class="o">.</span><span class="n">_spin</span><span class="p">,</span> <span class="n">_constants</span><span class="o">.</span><span class="n">INTERNAL_ERROR_LOG_MESSAGE</span><span class="p">),</span>
  116. <span class="n">sink</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_values</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="mi">0</span><span class="p">))</span>
  117. <span class="k">def</span> <span class="nf">add_value</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
  118. <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">_lock</span><span class="p">:</span>
  119. <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_sink</span> <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_spinning</span><span class="p">:</span>
  120. <span class="bp">self</span><span class="o">.</span><span class="n">_spinning</span> <span class="o">=</span> <span class="kc">True</span>
  121. <span class="bp">self</span><span class="o">.</span><span class="n">_pool</span><span class="o">.</span><span class="n">submit</span><span class="p">(</span>
  122. <span class="n">callable_util</span><span class="o">.</span><span class="n">with_exceptions_logged</span><span class="p">(</span>
  123. <span class="bp">self</span><span class="o">.</span><span class="n">_spin</span><span class="p">,</span> <span class="n">_constants</span><span class="o">.</span><span class="n">INTERNAL_ERROR_LOG_MESSAGE</span><span class="p">),</span>
  124. <span class="bp">self</span><span class="o">.</span><span class="n">_sink</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
  125. <span class="k">else</span><span class="p">:</span>
  126. <span class="bp">self</span><span class="o">.</span><span class="n">_values</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
  127. <div class="viewcode-block" id="Link"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.in_memory.Link">[docs]</a><span class="k">class</span> <span class="nc">Link</span><span class="p">(</span><span class="n">interfaces</span><span class="o">.</span><span class="n">ForeLink</span><span class="p">,</span> <span class="n">interfaces</span><span class="o">.</span><span class="n">RearLink</span><span class="p">):</span>
  128. <span class="sd">&quot;&quot;&quot;A trivial implementation of interfaces.ForeLink and interfaces.RearLink.&quot;&quot;&quot;</span>
  129. <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">pool</span><span class="p">):</span>
  130. <span class="sd">&quot;&quot;&quot;Constructor.</span>
  131. <span class="sd"> Args:</span>
  132. <span class="sd"> pool: A thread pool to be used for serializing ticket exchange in each</span>
  133. <span class="sd"> direction.</span>
  134. <span class="sd"> &quot;&quot;&quot;</span>
  135. <span class="bp">self</span><span class="o">.</span><span class="n">_front_to_back</span> <span class="o">=</span> <span class="n">_Serializer</span><span class="p">(</span><span class="n">pool</span><span class="p">)</span>
  136. <span class="bp">self</span><span class="o">.</span><span class="n">_back_to_front</span> <span class="o">=</span> <span class="n">_Serializer</span><span class="p">(</span><span class="n">pool</span><span class="p">)</span>
  137. <div class="viewcode-block" id="Link.join_fore_link"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.in_memory.Link.join_fore_link">[docs]</a> <span class="k">def</span> <span class="nf">join_fore_link</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fore_link</span><span class="p">):</span>
  138. <span class="sd">&quot;&quot;&quot;See interfaces.RearLink.join_fore_link for specification.&quot;&quot;&quot;</span>
  139. <span class="bp">self</span><span class="o">.</span><span class="n">_back_to_front</span><span class="o">.</span><span class="n">set_sink</span><span class="p">(</span><span class="n">fore_link</span><span class="o">.</span><span class="n">accept_back_to_front_ticket</span><span class="p">)</span></div>
  140. <div class="viewcode-block" id="Link.join_rear_link"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.in_memory.Link.join_rear_link">[docs]</a> <span class="k">def</span> <span class="nf">join_rear_link</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">rear_link</span><span class="p">):</span>
  141. <span class="sd">&quot;&quot;&quot;See interfaces.ForeLink.join_rear_link for specification.&quot;&quot;&quot;</span>
  142. <span class="bp">self</span><span class="o">.</span><span class="n">_front_to_back</span><span class="o">.</span><span class="n">set_sink</span><span class="p">(</span><span class="n">rear_link</span><span class="o">.</span><span class="n">accept_front_to_back_ticket</span><span class="p">)</span></div>
  143. <div class="viewcode-block" id="Link.accept_front_to_back_ticket"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.in_memory.Link.accept_front_to_back_ticket">[docs]</a> <span class="k">def</span> <span class="nf">accept_front_to_back_ticket</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ticket</span><span class="p">):</span>
  144. <span class="sd">&quot;&quot;&quot;See interfaces.ForeLink.accept_front_to_back_ticket for specification.&quot;&quot;&quot;</span>
  145. <span class="bp">self</span><span class="o">.</span><span class="n">_front_to_back</span><span class="o">.</span><span class="n">add_value</span><span class="p">(</span><span class="n">ticket</span><span class="p">)</span></div>
  146. <div class="viewcode-block" id="Link.accept_back_to_front_ticket"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.in_memory.Link.accept_back_to_front_ticket">[docs]</a> <span class="k">def</span> <span class="nf">accept_back_to_front_ticket</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ticket</span><span class="p">):</span>
  147. <span class="sd">&quot;&quot;&quot;See interfaces.RearLink.accept_back_to_front_ticket for specification.&quot;&quot;&quot;</span>
  148. <span class="bp">self</span><span class="o">.</span><span class="n">_back_to_front</span><span class="o">.</span><span class="n">add_value</span><span class="p">(</span><span class="n">ticket</span><span class="p">)</span></div></div>
  149. </pre></div>
  150. </div>
  151. </div>
  152. <footer>
  153. <hr/>
  154. <div role="contentinfo">
  155. <p>
  156. &copy; Copyright 2016, Author.
  157. </p>
  158. </div>
  159. 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>.
  160. </footer>
  161. </div>
  162. </div>
  163. </section>
  164. </div>
  165. <script type="text/javascript">
  166. var DOCUMENTATION_OPTIONS = {
  167. URL_ROOT:'../../../../',
  168. VERSION:'0.13.1rc1',
  169. COLLAPSE_INDEX:false,
  170. FILE_SUFFIX:'.html',
  171. HAS_SOURCE: true
  172. };
  173. </script>
  174. <script type="text/javascript" src="../../../../_static/jquery.js"></script>
  175. <script type="text/javascript" src="../../../../_static/underscore.js"></script>
  176. <script type="text/javascript" src="../../../../_static/doctools.js"></script>
  177. <script type="text/javascript" src="../../../../_static/js/theme.js"></script>
  178. <script type="text/javascript">
  179. jQuery(function () {
  180. SphinxRtdTheme.StickyNav.enable();
  181. });
  182. </script>
  183. </body>
  184. </html>