Home Explore Help
Sign In
carto
/
grpc
2
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: 27859c0c10
Branches Tags
grpc
/
python
/
_modules
/
grpc
/
framework
/
base
/
util.html

util.html 14 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290 
  1. 

  2. 

  3. <!DOCTYPE html>
    4. 

  4. <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
    5. 

  5. <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
    6. 

  6. <head>
    7. 

  7.   <meta charset="utf-8">
    8. 

  8.   
    9. 

  9.   <meta name="viewport" content="width=device-width, initial-scale=1.0">
    10. 

  10.   
    11. 

  11.   <title>grpc.framework.base.util &mdash; grpcio 0.11.0b0 documentation</title>
    12. 

  12.   
    13. 

  13. 

  14.   
    15. 

  15.   
    16. 

  16. 

  17.   
    18. 

  18. 

  19.   
    20. 

  20.   
    21. 

  21.     
    22. 

  22. 

  23.   
    24. 

  24. 

  25.   
    26. 

  26.   
    27. 

  27.     <link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
    28. 

  28.   
    29. 

  29. 

  30.   
    31. 

  31. 

  32.   
    33. 

  33.     <link rel="top" title="grpcio 0.11.0b0 documentation" href="../../../../index.html"/>
    34. 

  34.         <link rel="up" title="Module code" href="../../../index.html"/> 
    35. 

  35. 

  36.   
    37. 

  37.   <script src="_static/js/modernizr.min.js"></script>
    38. 

  38. 

  39. </head>
    40. 

  40. 

  41. <body class="wy-body-for-nav" role="document">
    42. 

  42. 

  43.   <div class="wy-grid-for-nav">
    44. 

  44. 

  45.     
    46. 

  46.     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
    47. 

  47.       <div class="wy-side-nav-search">
    48. 

  48.         
    49. 

  49. 

  50.         
    51. 

  51.           <a href="../../../../index.html" class="icon icon-home"> grpcio
    52. 

  52.         
    53. 

  53. 

  54.         
    55. 

  55.         </a>
    56. 

  56. 

  57.         
    58. 

  58. <div role="search">
    59. 

  59.   <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
    60. 

  60.     <input type="text" name="q" placeholder="Search docs" />
    61. 

  61.     <input type="hidden" name="check_keywords" value="yes" />
    62. 

  62.     <input type="hidden" name="area" value="default" />
    63. 

  63.   </form>
    64. 

  64. </div>
    65. 

  65. 

  66.         
    67. 

  67.       </div>
    68. 

  68. 

  69.       <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
    70. 

  70.         
    71. 

  71.           
    72. 

  72.           
    73. 

  73.               <ul>
    74. 

  74. <li class="toctree-l1"><a class="reference internal" href="../../../../grpc.html">grpc package</a><ul>
    75. 

  75. <li class="toctree-l2"><a class="reference internal" href="../../../../grpc.html#subpackages">Subpackages</a><ul>
    76. 

  76. <li class="toctree-l3"><a class="reference internal" href="../../../../grpc.beta.html">grpc.beta package</a><ul>
    77. 

  77. <li class="toctree-l4"><a class="reference internal" href="../../../../grpc.beta.html#submodules">Submodules</a></li>
    78. 

  78. <li class="toctree-l4"><a class="reference internal" href="../../../../grpc.beta.html#module-grpc.beta.implementations">grpc.beta.implementations module</a></li>
    79. 

  79. <li class="toctree-l4"><a class="reference internal" href="../../../../grpc.beta.html#module-grpc.beta.interfaces">grpc.beta.interfaces module</a></li>
    80. 

  80. <li class="toctree-l4"><a class="reference internal" href="../../../../grpc.beta.html#module-grpc.beta.utilities">grpc.beta.utilities module</a></li>
    81. 

  81. <li class="toctree-l4"><a class="reference internal" href="../../../../grpc.beta.html#module-grpc.beta">Module contents</a></li>
    82. 

  82. </ul>
    83. 

  83. </li>
    84. 

  84. <li class="toctree-l3"><a class="reference internal" href="../../../../grpc.early_adopter.html">grpc.early_adopter package</a><ul>
    85. 

  85. <li class="toctree-l4"><a class="reference internal" href="../../../../grpc.early_adopter.html#submodules">Submodules</a></li>
    86. 

  86. <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>
    87. 

  87. <li class="toctree-l4"><a class="reference internal" href="../../../../grpc.early_adopter.html#module-grpc.early_adopter">Module contents</a></li>
    88. 

  88. </ul>
    89. 

  89. </li>
    90. 

  90. <li class="toctree-l3"><a class="reference internal" href="../../../../grpc.framework.html">grpc.framework package</a><ul>
    91. 

  91. <li class="toctree-l4"><a class="reference internal" href="../../../../grpc.framework.html#subpackages">Subpackages</a></li>
    92. 

  92. <li class="toctree-l4"><a class="reference internal" href="../../../../grpc.framework.html#module-grpc.framework">Module contents</a></li>
    93. 

  93. </ul>
    94. 

  94. </li>
    95. 

  95. </ul>
    96. 

  96. </li>
    97. 

  97. <li class="toctree-l2"><a class="reference internal" href="../../../../grpc.html#module-grpc">Module contents</a></li>
    98. 

  98. </ul>
    99. 

  99. </li>
    100. 

  100. </ul>
    101. 

  101. 

  102.           
    103. 

  103.         
    104. 

  104.       </div>
    105. 

  105.       &nbsp;
    106. 

  106.     </nav>
    107. 

  107. 

  108.     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
    109. 

  109. 

  110.       
    111. 

  111.       <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
    112. 

  112.         <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
    113. 

  113.         <a href="../../../../index.html">grpcio</a>
    114. 

  114.       </nav>
    115. 

  115. 

  116. 

  117.       
    118. 

  118.       <div class="wy-nav-content">
    119. 

  119.         <div class="rst-content">
    120. 

  120.           <div role="navigation" aria-label="breadcrumbs navigation">
    121. 

  121.   <ul class="wy-breadcrumbs">
    122. 

  122.     <li><a href="../../../../index.html">Docs</a> &raquo;</li>
    123. 

  123.       
    124. 

  124.           <li><a href="../../../index.html">Module code</a> &raquo;</li>
    125. 

  125.       
    126. 

  126.     <li>grpc.framework.base.util</li>
    127. 

  127.       <li class="wy-breadcrumbs-aside">
    128. 

  128.         
    129. 

  129.           
    130. 

  130.         
    131. 

  131.       </li>
    132. 

  132.   </ul>
    133. 

  133.   <hr/>
    134. 

  134. </div>
    135. 

  135.           <div role="main" class="document">
    136. 

  136.             
    137. 

  137.   <h1>Source code for grpc.framework.base.util</h1><div class="highlight"><pre>
    138. 

  138. <span class="c"># Copyright 2015, Google Inc.</span>
    139. 

  139. <span class="c"># All rights reserved.</span>
    140. 

  140. <span class="c">#</span>
    141. 

  141. <span class="c"># Redistribution and use in source and binary forms, with or without</span>
    142. 

  142. <span class="c"># modification, are permitted provided that the following conditions are</span>
    143. 

  143. <span class="c"># met:</span>
    144. 

  144. <span class="c">#</span>
    145. 

  145. <span class="c">#     * Redistributions of source code must retain the above copyright</span>
    146. 

  146. <span class="c"># notice, this list of conditions and the following disclaimer.</span>
    147. 

  147. <span class="c">#     * Redistributions in binary form must reproduce the above</span>
    148. 

  148. <span class="c"># copyright notice, this list of conditions and the following disclaimer</span>
    149. 

  149. <span class="c"># in the documentation and/or other materials provided with the</span>
    150. 

  150. <span class="c"># distribution.</span>
    151. 

  151. <span class="c">#     * Neither the name of Google Inc. nor the names of its</span>
    152. 

  152. <span class="c"># contributors may be used to endorse or promote products derived from</span>
    153. 

  153. <span class="c"># this software without specific prior written permission.</span>
    154. 

  154. <span class="c">#</span>
    155. 

  155. <span class="c"># THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS</span>
    156. 

  156. <span class="c"># &quot;AS IS&quot; AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT</span>
    157. 

  157. <span class="c"># LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR</span>
    158. 

  158. <span class="c"># A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT</span>
    159. 

  159. <span class="c"># OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,</span>
    160. 

  160. <span class="c"># SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT</span>
    161. 

  161. <span class="c"># LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,</span>
    162. 

  162. <span class="c"># DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY</span>
    163. 

  163. <span class="c"># THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT</span>
    164. 

  164. <span class="c"># (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE</span>
    165. 

  165. <span class="c"># OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span>
    166. 

  166. 

  167. <span class="sd">&quot;&quot;&quot;Utilities helpful for working with the base layer of RPC Framework.&quot;&quot;&quot;</span>
    168. 

  168. 

  169. <span class="kn">import</span> <span class="nn">collections</span>
    170. 

  170. <span class="kn">import</span> <span class="nn">threading</span>
    171. 

  171. 

  172. <span class="kn">from</span> <span class="nn">grpc.framework.base</span> <span class="kn">import</span> <span class="n">interfaces</span>
    173. 

  173. 

  174. 

  175. <span class="k">class</span> <span class="nc">_ServicedSubscription</span><span class="p">(</span>
    176. 

  176.     <span class="n">collections</span><span class="o">.</span><span class="n">namedtuple</span><span class="p">(</span><span class="s">&#39;_ServicedSubscription&#39;</span><span class="p">,</span> <span class="p">[</span><span class="s">&#39;kind&#39;</span><span class="p">,</span> <span class="s">&#39;ingestor&#39;</span><span class="p">]),</span>
    177. 

  177.     <span class="n">interfaces</span><span class="o">.</span><span class="n">ServicedSubscription</span><span class="p">):</span>
    178. 

  178.   <span class="sd">&quot;&quot;&quot;See interfaces.ServicedSubscription for specification.&quot;&quot;&quot;</span>
    179. 

  179. 

  180. <span class="n">_NONE_SUBSCRIPTION</span> <span class="o">=</span> <span class="n">_ServicedSubscription</span><span class="p">(</span>
    181. 

  181.     <span class="n">interfaces</span><span class="o">.</span><span class="n">ServicedSubscription</span><span class="o">.</span><span class="n">Kind</span><span class="o">.</span><span class="n">NONE</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
    182. 

  182. <span class="n">_TERMINATION_ONLY_SUBSCRIPTION</span> <span class="o">=</span> <span class="n">_ServicedSubscription</span><span class="p">(</span>
    183. 

  183.     <span class="n">interfaces</span><span class="o">.</span><span class="n">ServicedSubscription</span><span class="o">.</span><span class="n">Kind</span><span class="o">.</span><span class="n">TERMINATION_ONLY</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
    184. 

  184. 

  185. 

  186. <div class="viewcode-block" id="none_serviced_subscription"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.util.none_serviced_subscription">[docs]</a><span class="k">def</span> <span class="nf">none_serviced_subscription</span><span class="p">():</span>
    187. 

  187.   <span class="sd">&quot;&quot;&quot;Creates a &quot;none&quot; interfaces.ServicedSubscription object.</span>
    188. 

  188. 

  189. <span class="sd">  Returns:</span>
    190. 

  190. <span class="sd">    An interfaces.ServicedSubscription indicating no subscription to an</span>
    191. 

  191. <span class="sd">      operation&#39;s results (such as would be the case for a fire-and-forget</span>
    192. 

  192. <span class="sd">      operation invocation).</span>
    193. 

  193. <span class="sd">  &quot;&quot;&quot;</span>
    194. 

  194.   <span class="k">return</span> <span class="n">_NONE_SUBSCRIPTION</span>
    195. 

  195. 

  196. </div>
    197. 

  197. <div class="viewcode-block" id="termination_only_serviced_subscription"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.util.termination_only_serviced_subscription">[docs]</a><span class="k">def</span> <span class="nf">termination_only_serviced_subscription</span><span class="p">():</span>
    198. 

  198.   <span class="sd">&quot;&quot;&quot;Creates a &quot;termination only&quot; interfaces.ServicedSubscription object.</span>
    199. 

  199. 

  200. <span class="sd">  Returns:</span>
    201. 

  201. <span class="sd">    An interfaces.ServicedSubscription indicating that the front-side customer</span>
    202. 

  202. <span class="sd">      is interested only in the overall termination outcome of the operation</span>
    203. 

  203. <span class="sd">      (such as completion or expiration) and would ignore the actual results of</span>
    204. 

  204. <span class="sd">      the operation.</span>
    205. 

  205. <span class="sd">  &quot;&quot;&quot;</span>
    206. 

  206.   <span class="k">return</span> <span class="n">_TERMINATION_ONLY_SUBSCRIPTION</span>
    207. 

  207. 

  208. </div>
    209. 

  209. <div class="viewcode-block" id="full_serviced_subscription"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.util.full_serviced_subscription">[docs]</a><span class="k">def</span> <span class="nf">full_serviced_subscription</span><span class="p">(</span><span class="n">ingestor</span><span class="p">):</span>
    210. 

  210.   <span class="sd">&quot;&quot;&quot;Creates a &quot;full&quot; interfaces.ServicedSubscription object.</span>
    211. 

  211. 

  212. <span class="sd">  Args:</span>
    213. 

  213. <span class="sd">    ingestor: An interfaces.ServicedIngestor.</span>
    214. 

  214. 

  215. <span class="sd">  Returns:</span>
    216. 

  216. <span class="sd">    An interfaces.ServicedSubscription object indicating a full</span>
    217. 

  217. <span class="sd">      subscription.</span>
    218. 

  218. <span class="sd">  &quot;&quot;&quot;</span>
    219. 

  219.   <span class="k">return</span> <span class="n">_ServicedSubscription</span><span class="p">(</span>
    220. 

  220.       <span class="n">interfaces</span><span class="o">.</span><span class="n">ServicedSubscription</span><span class="o">.</span><span class="n">Kind</span><span class="o">.</span><span class="n">FULL</span><span class="p">,</span> <span class="n">ingestor</span><span class="p">)</span>
    221. 

  221. 

  222. </div>
    223. 

  223. <div class="viewcode-block" id="wait_for_idle"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.util.wait_for_idle">[docs]</a><span class="k">def</span> <span class="nf">wait_for_idle</span><span class="p">(</span><span class="n">end</span><span class="p">):</span>
    224. 

  224.   <span class="sd">&quot;&quot;&quot;Waits for an interfaces.End to complete all operations.</span>
    225. 

  225. 

  226. <span class="sd">  Args:</span>
    227. 

  227. <span class="sd">    end: Any interfaces.End.</span>
    228. 

  228. <span class="sd">  &quot;&quot;&quot;</span>
    229. 

  229.   <span class="n">event</span> <span class="o">=</span> <span class="n">threading</span><span class="o">.</span><span class="n">Event</span><span class="p">()</span>
    230. 

  230.   <span class="n">end</span><span class="o">.</span><span class="n">add_idle_action</span><span class="p">(</span><span class="n">event</span><span class="o">.</span><span class="n">set</span><span class="p">)</span>
    231. 

  231.   <span class="n">event</span><span class="o">.</span><span class="n">wait</span><span class="p">()</span></div>
    232. 

  232. </pre></div>
    233. 

  233. 

  234.           </div>
    235. 

  235.           <footer>
    236. 

  236.   
    237. 

  237. 

  238.   <hr/>
    239. 

  239. 

  240.   <div role="contentinfo">
    241. 

  241.     <p>
    242. 

  242.         &copy; Copyright 2015, Author.
    243. 

  243.     </p>
    244. 

  244.   </div>
    245. 

  245.   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>.
    246. 

  246. 

  247. </footer>
    248. 

  248. 

  249.         </div>
    250. 

  250.       </div>
    251. 

  251. 

  252.     </section>
    253. 

  253. 

  254.   </div>
    255. 

  255.   
    256. 

  256. 

  257. 

  258.   
    259. 

  259. 

  260.     <script type="text/javascript">
    261. 

  261.         var DOCUMENTATION_OPTIONS = {
    262. 

  262.             URL_ROOT:'../../../../',
    263. 

  263.             VERSION:'0.11.0b0',
    264. 

  264.             COLLAPSE_INDEX:false,
    265. 

  265.             FILE_SUFFIX:'.html',
    266. 

  266.             HAS_SOURCE:  true
    267. 

  267.         };
    268. 

  268.     </script>
    269. 

  269.       <script type="text/javascript" src="../../../../_static/jquery.js"></script>
    270. 

  270.       <script type="text/javascript" src="../../../../_static/underscore.js"></script>
    271. 

  271.       <script type="text/javascript" src="../../../../_static/doctools.js"></script>
    272. 

  272. 

  273.   
    274. 

  274. 

  275.   
    276. 

  276.   
    277. 

  277.     <script type="text/javascript" src="../../../../_static/js/theme.js"></script>
    278. 

  278.   
    279. 

  279. 

  280.   
    281. 

  281.   
    282. 

  282.   <script type="text/javascript">
    283. 

  283.       jQuery(function () {
    284. 

  284.           SphinxRtdTheme.StickyNav.enable();
    285. 

  285.       });
    286. 

  286.   </script>
    287. 

  287.    
    288. 

  288. 

  289. </body>
    290. 

  290. </html>
    291.