Etusivu Tutki Apua
Kirjaudu sisään
carto
/
grpc
2
0
Fork 0
Tiedostot Ongelmat 0 Pull-pyynnöt 0 Wiki
Puu: c4d296aada
Haarat Tagit
grpc
/
python
/
_modules
/
grpc
/
framework
/
base
/
interfaces.html

interfaces.html 38 KB
Historia Raaka

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552 
  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.interfaces &mdash; grpcio 0.10.0a0 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.10.0a0 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.early_adopter.html">grpc.early_adopter package</a><ul>
    77. 

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

  78. <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>
    79. 

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

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

  81. </ul>
    82. 

  82. </li>
    83. 

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

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

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

  86. </ul>
    87. 

  87. </li>
    88. 

  88. </ul>
    89. 

  89. </li>
    90. 

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

  91. </ul>
    92. 

  92. </li>
    93. 

  93. </ul>
    94. 

  94. 

  95.           
    96. 

  96.         
    97. 

  97.       </div>
    98. 

  98.       &nbsp;
    99. 

  99.     </nav>
    100. 

  100. 

  101.     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
    102. 

  102. 

  103.       
    104. 

  104.       <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
    105. 

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

  106.         <a href="../../../../index.html">grpcio</a>
    107. 

  107.       </nav>
    108. 

  108. 

  109. 

  110.       
    111. 

  111.       <div class="wy-nav-content">
    112. 

  112.         <div class="rst-content">
    113. 

  113.           <div role="navigation" aria-label="breadcrumbs navigation">
    114. 

  114.   <ul class="wy-breadcrumbs">
    115. 

  115.     <li><a href="../../../../index.html">Docs</a> &raquo;</li>
    116. 

  116.       
    117. 

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

  118.       
    119. 

  119.     <li>grpc.framework.base.interfaces</li>
    120. 

  120.       <li class="wy-breadcrumbs-aside">
    121. 

  121.         
    122. 

  122.           
    123. 

  123.         
    124. 

  124.       </li>
    125. 

  125.   </ul>
    126. 

  126.   <hr/>
    127. 

  127. </div>
    128. 

  128.           <div role="main" class="document">
    129. 

  129.             
    130. 

  130.   <h1>Source code for grpc.framework.base.interfaces</h1><div class="highlight"><pre>
    131. 

  131. <span class="c"># Copyright 2015, Google Inc.</span>
    132. 

  132. <span class="c"># All rights reserved.</span>
    133. 

  133. <span class="c">#</span>
    134. 

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

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

  136. <span class="c"># met:</span>
    137. 

  137. <span class="c">#</span>
    138. 

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

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

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

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

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

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

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

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

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

  147. <span class="c">#</span>
    148. 

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

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

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

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

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

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

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

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

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

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

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

  159. 

  160. <span class="sd">&quot;&quot;&quot;Interfaces defined and used by the base layer of RPC Framework.&quot;&quot;&quot;</span>
    161. 

  161. 

  162. <span class="kn">import</span> <span class="nn">abc</span>
    163. 

  163. <span class="kn">import</span> <span class="nn">collections</span>
    164. 

  164. <span class="kn">import</span> <span class="nn">enum</span>
    165. 

  165. 

  166. <span class="c"># stream is referenced from specification in this module.</span>
    167. 

  167. <span class="kn">from</span> <span class="nn">grpc.framework.foundation</span> <span class="kn">import</span> <span class="n">stream</span>  <span class="c"># pylint: disable=unused-import</span>
    168. 

  168. 

  169. 

  170. <span class="nd">@enum.unique</span>
    171. 

  171. <div class="viewcode-block" id="Outcome"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.interfaces.Outcome">[docs]</a><span class="k">class</span> <span class="nc">Outcome</span><span class="p">(</span><span class="n">enum</span><span class="o">.</span><span class="n">Enum</span><span class="p">):</span>
    172. 

  172.   <span class="sd">&quot;&quot;&quot;Operation outcomes.&quot;&quot;&quot;</span>
    173. 

  173. 

  174.   <span class="n">COMPLETED</span> <span class="o">=</span> <span class="s">&#39;completed&#39;</span>
    175. 

  175.   <span class="n">CANCELLED</span> <span class="o">=</span> <span class="s">&#39;cancelled&#39;</span>
    176. 

  176.   <span class="n">EXPIRED</span> <span class="o">=</span> <span class="s">&#39;expired&#39;</span>
    177. 

  177.   <span class="n">RECEPTION_FAILURE</span> <span class="o">=</span> <span class="s">&#39;reception failure&#39;</span>
    178. 

  178.   <span class="n">TRANSMISSION_FAILURE</span> <span class="o">=</span> <span class="s">&#39;transmission failure&#39;</span>
    179. 

  179.   <span class="n">SERVICER_FAILURE</span> <span class="o">=</span> <span class="s">&#39;servicer failure&#39;</span>
    180. 

  180.   <span class="n">SERVICED_FAILURE</span> <span class="o">=</span> <span class="s">&#39;serviced failure&#39;</span>
    181. 

  181. 

  182. </div>
    183. 

  183. <div class="viewcode-block" id="OperationContext"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.interfaces.OperationContext">[docs]</a><span class="k">class</span> <span class="nc">OperationContext</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
    184. 

  184.   <span class="sd">&quot;&quot;&quot;Provides operation-related information and action.</span>
    185. 

  185. 

  186. <span class="sd">  Attributes:</span>
    187. 

  187. <span class="sd">    trace_id: A uuid.UUID identifying a particular set of related operations.</span>
    188. 

  188. <span class="sd">  &quot;&quot;&quot;</span>
    189. 

  189.   <span class="n">__metaclass__</span> <span class="o">=</span> <span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span>
    190. 

  190. 

  191.   <span class="nd">@abc.abstractmethod</span>
    192. 

  192. <div class="viewcode-block" id="OperationContext.is_active"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.interfaces.OperationContext.is_active">[docs]</a>  <span class="k">def</span> <span class="nf">is_active</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    193. 

  193.     <span class="sd">&quot;&quot;&quot;Describes whether the operation is active or has terminated.&quot;&quot;&quot;</span>
    194. 

  194.     <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
    195. 

  195. </div>
    196. 

  196.   <span class="nd">@abc.abstractmethod</span>
    197. 

  197. <div class="viewcode-block" id="OperationContext.add_termination_callback"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.interfaces.OperationContext.add_termination_callback">[docs]</a>  <span class="k">def</span> <span class="nf">add_termination_callback</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">callback</span><span class="p">):</span>
    198. 

  198.     <span class="sd">&quot;&quot;&quot;Adds a function to be called upon operation termination.</span>
    199. 

  199. 

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

  201. <span class="sd">      callback: A callable that will be passed an Outcome value.</span>
    202. 

  202. <span class="sd">    &quot;&quot;&quot;</span>
    203. 

  203.     <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
    204. 

  204. </div>
    205. 

  205.   <span class="nd">@abc.abstractmethod</span>
    206. 

  206. <div class="viewcode-block" id="OperationContext.time_remaining"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.interfaces.OperationContext.time_remaining">[docs]</a>  <span class="k">def</span> <span class="nf">time_remaining</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    207. 

  207.     <span class="sd">&quot;&quot;&quot;Describes the length of allowed time remaining for the operation.</span>
    208. 

  208. 

  209. <span class="sd">    Returns:</span>
    210. 

  210. <span class="sd">      A nonnegative float indicating the length of allowed time in seconds</span>
    211. 

  211. <span class="sd">      remaining for the operation to complete before it is considered to have</span>
    212. 

  212. <span class="sd">      timed out.</span>
    213. 

  213. <span class="sd">    &quot;&quot;&quot;</span>
    214. 

  214.     <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
    215. 

  215. </div>
    216. 

  216.   <span class="nd">@abc.abstractmethod</span>
    217. 

  217. <div class="viewcode-block" id="OperationContext.fail"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.interfaces.OperationContext.fail">[docs]</a>  <span class="k">def</span> <span class="nf">fail</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">exception</span><span class="p">):</span>
    218. 

  218.     <span class="sd">&quot;&quot;&quot;Indicates that the operation has failed.</span>
    219. 

  219. 

  220. <span class="sd">    Args:</span>
    221. 

  221. <span class="sd">      exception: An exception germane to the operation failure. May be None.</span>
    222. 

  222. <span class="sd">    &quot;&quot;&quot;</span>
    223. 

  223.     <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
    224. 

  224. 

  225. </div></div>
    226. 

  226. <div class="viewcode-block" id="Servicer"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.interfaces.Servicer">[docs]</a><span class="k">class</span> <span class="nc">Servicer</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
    227. 

  227.   <span class="sd">&quot;&quot;&quot;Interface for service implementations.&quot;&quot;&quot;</span>
    228. 

  228.   <span class="n">__metaclass__</span> <span class="o">=</span> <span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span>
    229. 

  229. 

  230.   <span class="nd">@abc.abstractmethod</span>
    231. 

  231. <div class="viewcode-block" id="Servicer.service"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.interfaces.Servicer.service">[docs]</a>  <span class="k">def</span> <span class="nf">service</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">context</span><span class="p">,</span> <span class="n">output_consumer</span><span class="p">):</span>
    232. 

  232.     <span class="sd">&quot;&quot;&quot;Services an operation.</span>
    233. 

  233. 

  234. <span class="sd">    Args:</span>
    235. 

  235. <span class="sd">      name: The name of the operation.</span>
    236. 

  236. <span class="sd">      context: A ServicerContext object affording contextual information and</span>
    237. 

  237. <span class="sd">        actions.</span>
    238. 

  238. <span class="sd">      output_consumer: A stream.Consumer that will accept output values of</span>
    239. 

  239. <span class="sd">        the operation.</span>
    240. 

  240. 

  241. <span class="sd">    Returns:</span>
    242. 

  242. <span class="sd">      A stream.Consumer that will accept input values for the operation.</span>
    243. 

  243. 

  244. <span class="sd">    Raises:</span>
    245. 

  245. <span class="sd">      exceptions.NoSuchMethodError: If this Servicer affords no method with the</span>
    246. 

  246. <span class="sd">        given name.</span>
    247. 

  247. <span class="sd">      abandonment.Abandoned: If the operation has been aborted and there no</span>
    248. 

  248. <span class="sd">        longer is any reason to service the operation.</span>
    249. 

  249. <span class="sd">    &quot;&quot;&quot;</span>
    250. 

  250.     <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
    251. 

  251. 

  252. </div></div>
    253. 

  253. <div class="viewcode-block" id="Operation"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.interfaces.Operation">[docs]</a><span class="k">class</span> <span class="nc">Operation</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
    254. 

  254.   <span class="sd">&quot;&quot;&quot;Representation of an in-progress operation.</span>
    255. 

  255. 

  256. <span class="sd">  Attributes:</span>
    257. 

  257. <span class="sd">    consumer: A stream.Consumer into which payloads constituting the operation&#39;s</span>
    258. 

  258. <span class="sd">      input may be passed.</span>
    259. 

  259. <span class="sd">    context: An OperationContext affording information and action about the</span>
    260. 

  260. <span class="sd">      operation.</span>
    261. 

  261. <span class="sd">  &quot;&quot;&quot;</span>
    262. 

  262.   <span class="n">__metaclass__</span> <span class="o">=</span> <span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span>
    263. 

  263. 

  264.   <span class="nd">@abc.abstractmethod</span>
    265. 

  265. <div class="viewcode-block" id="Operation.cancel"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.interfaces.Operation.cancel">[docs]</a>  <span class="k">def</span> <span class="nf">cancel</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    266. 

  266.     <span class="sd">&quot;&quot;&quot;Cancels this operation.&quot;&quot;&quot;</span>
    267. 

  267.     <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
    268. 

  268. 

  269. </div></div>
    270. 

  270. <div class="viewcode-block" id="ServicedIngestor"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.interfaces.ServicedIngestor">[docs]</a><span class="k">class</span> <span class="nc">ServicedIngestor</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
    271. 

  271.   <span class="sd">&quot;&quot;&quot;Responsible for accepting the result of an operation.&quot;&quot;&quot;</span>
    272. 

  272.   <span class="n">__metaclass__</span> <span class="o">=</span> <span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span>
    273. 

  273. 

  274.   <span class="nd">@abc.abstractmethod</span>
    275. 

  275. <div class="viewcode-block" id="ServicedIngestor.consumer"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.interfaces.ServicedIngestor.consumer">[docs]</a>  <span class="k">def</span> <span class="nf">consumer</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">operation_context</span><span class="p">):</span>
    276. 

  276.     <span class="sd">&quot;&quot;&quot;Affords a consumer to which operation results will be passed.</span>
    277. 

  277. 

  278. <span class="sd">    Args:</span>
    279. 

  279. <span class="sd">      operation_context: An OperationContext object for the current operation.</span>
    280. 

  280. 

  281. <span class="sd">    Returns:</span>
    282. 

  282. <span class="sd">      A stream.Consumer to which the results of the current operation will be</span>
    283. 

  283. <span class="sd">        passed.</span>
    284. 

  284. 

  285. <span class="sd">    Raises:</span>
    286. 

  286. <span class="sd">      abandonment.Abandoned: If the operation has been aborted and there no</span>
    287. 

  287. <span class="sd">        longer is any reason to service the operation.</span>
    288. 

  288. <span class="sd">    &quot;&quot;&quot;</span>
    289. 

  289.     <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
    290. 

  290. 

  291. </div></div>
    292. 

  292. <div class="viewcode-block" id="ServicedSubscription"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.interfaces.ServicedSubscription">[docs]</a><span class="k">class</span> <span class="nc">ServicedSubscription</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
    293. 

  293.   <span class="sd">&quot;&quot;&quot;A sum type representing a serviced&#39;s interest in an operation.</span>
    294. 

  294. 

  295. <span class="sd">  Attributes:</span>
    296. 

  296. <span class="sd">    kind: A Kind value.</span>
    297. 

  297. <span class="sd">    ingestor: A ServicedIngestor. Must be present if kind is Kind.FULL. Must</span>
    298. 

  298. <span class="sd">      be None if kind is Kind.TERMINATION_ONLY or Kind.NONE.</span>
    299. 

  299. <span class="sd">  &quot;&quot;&quot;</span>
    300. 

  300.   <span class="n">__metaclass__</span> <span class="o">=</span> <span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span>
    301. 

  301. 

  302.   <span class="nd">@enum.unique</span>
    303. 

  303. <div class="viewcode-block" id="ServicedSubscription.Kind"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.interfaces.ServicedSubscription.Kind">[docs]</a>  <span class="k">class</span> <span class="nc">Kind</span><span class="p">(</span><span class="n">enum</span><span class="o">.</span><span class="n">Enum</span><span class="p">):</span>
    304. 

  304.     <span class="sd">&quot;&quot;&quot;Kinds of subscription.&quot;&quot;&quot;</span>
    305. 

  305. 

  306.     <span class="n">FULL</span> <span class="o">=</span> <span class="s">&#39;full&#39;</span>
    307. 

  307.     <span class="n">TERMINATION_ONLY</span> <span class="o">=</span> <span class="s">&#39;termination only&#39;</span>
    308. 

  308.     <span class="n">NONE</span> <span class="o">=</span> <span class="s">&#39;none&#39;</span>
    309. 

  309. 

  310. </div></div>
    311. 

  311. <div class="viewcode-block" id="End"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.interfaces.End">[docs]</a><span class="k">class</span> <span class="nc">End</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
    312. 

  312.   <span class="sd">&quot;&quot;&quot;Common type for entry-point objects on both sides of an operation.&quot;&quot;&quot;</span>
    313. 

  313.   <span class="n">__metaclass__</span> <span class="o">=</span> <span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span>
    314. 

  314. 

  315.   <span class="nd">@abc.abstractmethod</span>
    316. 

  316. <div class="viewcode-block" id="End.operation_stats"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.interfaces.End.operation_stats">[docs]</a>  <span class="k">def</span> <span class="nf">operation_stats</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    317. 

  317.     <span class="sd">&quot;&quot;&quot;Reports the number of terminated operations broken down by outcome.</span>
    318. 

  318. 

  319. <span class="sd">    Returns:</span>
    320. 

  320. <span class="sd">      A dictionary from Outcome value to an integer identifying the number</span>
    321. 

  321. <span class="sd">        of operations that terminated with that outcome.</span>
    322. 

  322. <span class="sd">    &quot;&quot;&quot;</span>
    323. 

  323.     <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
    324. 

  324. </div>
    325. 

  325.   <span class="nd">@abc.abstractmethod</span>
    326. 

  326. <div class="viewcode-block" id="End.add_idle_action"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.interfaces.End.add_idle_action">[docs]</a>  <span class="k">def</span> <span class="nf">add_idle_action</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">action</span><span class="p">):</span>
    327. 

  327.     <span class="sd">&quot;&quot;&quot;Adds an action to be called when this End has no ongoing operations.</span>
    328. 

  328. 

  329. <span class="sd">    Args:</span>
    330. 

  330. <span class="sd">      action: A callable that accepts no arguments.</span>
    331. 

  331. <span class="sd">    &quot;&quot;&quot;</span>
    332. 

  332.     <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
    333. 

  333. 

  334. </div></div>
    335. 

  335. <div class="viewcode-block" id="Front"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.interfaces.Front">[docs]</a><span class="k">class</span> <span class="nc">Front</span><span class="p">(</span><span class="n">End</span><span class="p">):</span>
    336. 

  336.   <span class="sd">&quot;&quot;&quot;Clientish objects that afford the invocation of operations.&quot;&quot;&quot;</span>
    337. 

  337.   <span class="n">__metaclass__</span> <span class="o">=</span> <span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span>
    338. 

  338. 

  339.   <span class="nd">@abc.abstractmethod</span>
    340. 

  340. <div class="viewcode-block" id="Front.operate"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.interfaces.Front.operate">[docs]</a>  <span class="k">def</span> <span class="nf">operate</span><span class="p">(</span>
    341. 

  341.       <span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">payload</span><span class="p">,</span> <span class="n">complete</span><span class="p">,</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">subscription</span><span class="p">,</span> <span class="n">trace_id</span><span class="p">):</span>
    342. 

  342.     <span class="sd">&quot;&quot;&quot;Commences an operation.</span>
    343. 

  343. 

  344. <span class="sd">    Args:</span>
    345. 

  345. <span class="sd">      name: The name of the method invoked for the operation.</span>
    346. 

  346. <span class="sd">      payload: An initial payload for the operation. May be None.</span>
    347. 

  347. <span class="sd">      complete: A boolean indicating whether or not additional payloads to be</span>
    348. 

  348. <span class="sd">        sent to the servicer may be supplied after this call.</span>
    349. 

  349. <span class="sd">      timeout: A length of time in seconds to allow for the operation.</span>
    350. 

  350. <span class="sd">      subscription: A ServicedSubscription for the operation.</span>
    351. 

  351. <span class="sd">      trace_id: A uuid.UUID identifying a set of related operations to which</span>
    352. 

  352. <span class="sd">        this operation belongs.</span>
    353. 

  353. 

  354. <span class="sd">    Returns:</span>
    355. 

  355. <span class="sd">      An Operation object affording information and action about the operation</span>
    356. 

  356. <span class="sd">        in progress.</span>
    357. 

  357. <span class="sd">    &quot;&quot;&quot;</span>
    358. 

  358.     <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
    359. 

  359. 

  360. </div></div>
    361. 

  361. <div class="viewcode-block" id="Back"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.interfaces.Back">[docs]</a><span class="k">class</span> <span class="nc">Back</span><span class="p">(</span><span class="n">End</span><span class="p">):</span>
    362. 

  362.   <span class="sd">&quot;&quot;&quot;Serverish objects that perform the work of operations.&quot;&quot;&quot;</span>
    363. 

  363.   <span class="n">__metaclass__</span> <span class="o">=</span> <span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span>
    364. 

  364. 

  365. </div>
    366. 

  366. <div class="viewcode-block" id="FrontToBackTicket"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.interfaces.FrontToBackTicket">[docs]</a><span class="k">class</span> <span class="nc">FrontToBackTicket</span><span class="p">(</span>
    367. 

  367.     <span class="n">collections</span><span class="o">.</span><span class="n">namedtuple</span><span class="p">(</span>
    368. 

  368.         <span class="s">&#39;FrontToBackTicket&#39;</span><span class="p">,</span>
    369. 

  369.         <span class="p">[</span><span class="s">&#39;operation_id&#39;</span><span class="p">,</span> <span class="s">&#39;sequence_number&#39;</span><span class="p">,</span> <span class="s">&#39;kind&#39;</span><span class="p">,</span> <span class="s">&#39;name&#39;</span><span class="p">,</span> <span class="s">&#39;subscription&#39;</span><span class="p">,</span>
    370. 

  370.          <span class="s">&#39;trace_id&#39;</span><span class="p">,</span> <span class="s">&#39;payload&#39;</span><span class="p">,</span> <span class="s">&#39;timeout&#39;</span><span class="p">])):</span>
    371. 

  371.   <span class="sd">&quot;&quot;&quot;A sum type for all values sent from a front to a back.</span>
    372. 

  372. 

  373. <span class="sd">  Attributes:</span>
    374. 

  374. <span class="sd">    operation_id: A unique-with-respect-to-equality hashable object identifying</span>
    375. 

  375. <span class="sd">      a particular operation.</span>
    376. 

  376. <span class="sd">    sequence_number: A zero-indexed integer sequence number identifying the</span>
    377. 

  377. <span class="sd">      ticket&#39;s place among all the tickets sent from front to back for this</span>
    378. 

  378. <span class="sd">      particular operation. Must be zero if kind is Kind.COMMENCEMENT or</span>
    379. 

  379. <span class="sd">      Kind.ENTIRE. Must be positive for any other kind.</span>
    380. 

  380. <span class="sd">    kind: A Kind value describing the overall kind of ticket.</span>
    381. 

  381. <span class="sd">    name: The name of an operation. Must be present if kind is Kind.COMMENCEMENT</span>
    382. 

  382. <span class="sd">      or Kind.ENTIRE. Must be None for any other kind.</span>
    383. 

  383. <span class="sd">    subscription: An ServicedSubscription.Kind value describing the interest</span>
    384. 

  384. <span class="sd">      the front has in tickets sent from the back. Must be present if</span>
    385. 

  385. <span class="sd">      kind is Kind.COMMENCEMENT or Kind.ENTIRE. Must be None for any other kind.</span>
    386. 

  386. <span class="sd">    trace_id: A uuid.UUID identifying a set of related operations to which this</span>
    387. 

  387. <span class="sd">      operation belongs. May be None.</span>
    388. 

  388. <span class="sd">    payload: A customer payload object. Must be present if kind is</span>
    389. 

  389. <span class="sd">      Kind.CONTINUATION. Must be None if kind is Kind.CANCELLATION. May be None</span>
    390. 

  390. <span class="sd">      for any other kind.</span>
    391. 

  391. <span class="sd">    timeout: An optional length of time (measured from the beginning of the</span>
    392. 

  392. <span class="sd">      operation) to allow for the entire operation. If None, a default value on</span>
    393. 

  393. <span class="sd">      the back will be used. If present and excessively large, the back may</span>
    394. 

  394. <span class="sd">      limit the operation to a smaller duration of its choice. May be present</span>
    395. 

  395. <span class="sd">      for any ticket kind; setting a value on a later ticket allows fronts</span>
    396. 

  396. <span class="sd">      to request time extensions (or even time reductions!) on in-progress</span>
    397. 

  397. <span class="sd">      operations.</span>
    398. 

  398. <span class="sd">  &quot;&quot;&quot;</span>
    399. 

  399. 

  400.   <span class="nd">@enum.unique</span>
    401. 

  401. <div class="viewcode-block" id="FrontToBackTicket.Kind"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.interfaces.FrontToBackTicket.Kind">[docs]</a>  <span class="k">class</span> <span class="nc">Kind</span><span class="p">(</span><span class="n">enum</span><span class="o">.</span><span class="n">Enum</span><span class="p">):</span>
    402. 

  402.     <span class="sd">&quot;&quot;&quot;Identifies the overall kind of a FrontToBackTicket.&quot;&quot;&quot;</span>
    403. 

  403. 

  404.     <span class="n">COMMENCEMENT</span> <span class="o">=</span> <span class="s">&#39;commencement&#39;</span>
    405. 

  405.     <span class="n">CONTINUATION</span> <span class="o">=</span> <span class="s">&#39;continuation&#39;</span>
    406. 

  406.     <span class="n">COMPLETION</span> <span class="o">=</span> <span class="s">&#39;completion&#39;</span>
    407. 

  407.     <span class="n">ENTIRE</span> <span class="o">=</span> <span class="s">&#39;entire&#39;</span>
    408. 

  408.     <span class="n">CANCELLATION</span> <span class="o">=</span> <span class="s">&#39;cancellation&#39;</span>
    409. 

  409.     <span class="n">EXPIRATION</span> <span class="o">=</span> <span class="s">&#39;expiration&#39;</span>
    410. 

  410.     <span class="n">SERVICER_FAILURE</span> <span class="o">=</span> <span class="s">&#39;servicer failure&#39;</span>
    411. 

  411.     <span class="n">SERVICED_FAILURE</span> <span class="o">=</span> <span class="s">&#39;serviced failure&#39;</span>
    412. 

  412.     <span class="n">RECEPTION_FAILURE</span> <span class="o">=</span> <span class="s">&#39;reception failure&#39;</span>
    413. 

  413.     <span class="n">TRANSMISSION_FAILURE</span> <span class="o">=</span> <span class="s">&#39;transmission failure&#39;</span>
    414. 

  414. 

  415. </div></div>
    416. 

  416. <div class="viewcode-block" id="BackToFrontTicket"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.interfaces.BackToFrontTicket">[docs]</a><span class="k">class</span> <span class="nc">BackToFrontTicket</span><span class="p">(</span>
    417. 

  417.     <span class="n">collections</span><span class="o">.</span><span class="n">namedtuple</span><span class="p">(</span>
    418. 

  418.         <span class="s">&#39;BackToFrontTicket&#39;</span><span class="p">,</span>
    419. 

  419.         <span class="p">[</span><span class="s">&#39;operation_id&#39;</span><span class="p">,</span> <span class="s">&#39;sequence_number&#39;</span><span class="p">,</span> <span class="s">&#39;kind&#39;</span><span class="p">,</span> <span class="s">&#39;payload&#39;</span><span class="p">])):</span>
    420. 

  420.   <span class="sd">&quot;&quot;&quot;A sum type for all values sent from a back to a front.</span>
    421. 

  421. 

  422. <span class="sd">  Attributes:</span>
    423. 

  423. <span class="sd">    operation_id: A unique-with-respect-to-equality hashable object identifying</span>
    424. 

  424. <span class="sd">      a particular operation.</span>
    425. 

  425. <span class="sd">    sequence_number: A zero-indexed integer sequence number identifying the</span>
    426. 

  426. <span class="sd">      ticket&#39;s place among all the tickets sent from back to front for this</span>
    427. 

  427. <span class="sd">      particular operation.</span>
    428. 

  428. <span class="sd">    kind: A Kind value describing the overall kind of ticket.</span>
    429. 

  429. <span class="sd">    payload: A customer payload object. Must be present if kind is</span>
    430. 

  430. <span class="sd">      Kind.CONTINUATION. May be None if kind is Kind.COMPLETION. Must be None</span>
    431. 

  431. <span class="sd">      otherwise.</span>
    432. 

  432. <span class="sd">  &quot;&quot;&quot;</span>
    433. 

  433. 

  434.   <span class="nd">@enum.unique</span>
    435. 

  435. <div class="viewcode-block" id="BackToFrontTicket.Kind"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.interfaces.BackToFrontTicket.Kind">[docs]</a>  <span class="k">class</span> <span class="nc">Kind</span><span class="p">(</span><span class="n">enum</span><span class="o">.</span><span class="n">Enum</span><span class="p">):</span>
    436. 

  436.     <span class="sd">&quot;&quot;&quot;Identifies the overall kind of a BackToFrontTicket.&quot;&quot;&quot;</span>
    437. 

  437. 

  438.     <span class="n">CONTINUATION</span> <span class="o">=</span> <span class="s">&#39;continuation&#39;</span>
    439. 

  439.     <span class="n">COMPLETION</span> <span class="o">=</span> <span class="s">&#39;completion&#39;</span>
    440. 

  440.     <span class="n">CANCELLATION</span> <span class="o">=</span> <span class="s">&#39;cancellation&#39;</span>
    441. 

  441.     <span class="n">EXPIRATION</span> <span class="o">=</span> <span class="s">&#39;expiration&#39;</span>
    442. 

  442.     <span class="n">SERVICER_FAILURE</span> <span class="o">=</span> <span class="s">&#39;servicer failure&#39;</span>
    443. 

  443.     <span class="n">SERVICED_FAILURE</span> <span class="o">=</span> <span class="s">&#39;serviced failure&#39;</span>
    444. 

  444.     <span class="n">RECEPTION_FAILURE</span> <span class="o">=</span> <span class="s">&#39;reception failure&#39;</span>
    445. 

  445.     <span class="n">TRANSMISSION_FAILURE</span> <span class="o">=</span> <span class="s">&#39;transmission failure&#39;</span>
    446. 

  446. 

  447. </div></div>
    448. 

  448. <div class="viewcode-block" id="ForeLink"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.interfaces.ForeLink">[docs]</a><span class="k">class</span> <span class="nc">ForeLink</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
    449. 

  449.   <span class="sd">&quot;&quot;&quot;Accepts back-to-front tickets and emits front-to-back tickets.&quot;&quot;&quot;</span>
    450. 

  450.   <span class="n">__metaclass__</span> <span class="o">=</span> <span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span>
    451. 

  451. 

  452.   <span class="nd">@abc.abstractmethod</span>
    453. 

  453. <div class="viewcode-block" id="ForeLink.accept_back_to_front_ticket"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.interfaces.ForeLink.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>
    454. 

  454.     <span class="sd">&quot;&quot;&quot;Accept a BackToFrontTicket.</span>
    455. 

  455. 

  456. <span class="sd">    Args:</span>
    457. 

  457. <span class="sd">      ticket: Any BackToFrontTicket.</span>
    458. 

  458. <span class="sd">    &quot;&quot;&quot;</span>
    459. 

  459.     <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
    460. 

  460. </div>
    461. 

  461.   <span class="nd">@abc.abstractmethod</span>
    462. 

  462. <div class="viewcode-block" id="ForeLink.join_rear_link"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.interfaces.ForeLink.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>
    463. 

  463.     <span class="sd">&quot;&quot;&quot;Mates this object with a peer with which it will exchange tickets.&quot;&quot;&quot;</span>
    464. 

  464.     <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
    465. 

  465. 

  466. </div></div>
    467. 

  467. <div class="viewcode-block" id="RearLink"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.interfaces.RearLink">[docs]</a><span class="k">class</span> <span class="nc">RearLink</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
    468. 

  468.   <span class="sd">&quot;&quot;&quot;Accepts front-to-back tickets and emits back-to-front tickets.&quot;&quot;&quot;</span>
    469. 

  469.   <span class="n">__metaclass__</span> <span class="o">=</span> <span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span>
    470. 

  470. 

  471.   <span class="nd">@abc.abstractmethod</span>
    472. 

  472. <div class="viewcode-block" id="RearLink.accept_front_to_back_ticket"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.interfaces.RearLink.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>
    473. 

  473.     <span class="sd">&quot;&quot;&quot;Accepts a FrontToBackTicket.</span>
    474. 

  474. 

  475. <span class="sd">    Args:</span>
    476. 

  476. <span class="sd">      ticket: Any FrontToBackTicket.</span>
    477. 

  477. <span class="sd">    &quot;&quot;&quot;</span>
    478. 

  478.     <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
    479. 

  479. </div>
    480. 

  480.   <span class="nd">@abc.abstractmethod</span>
    481. 

  481. <div class="viewcode-block" id="RearLink.join_fore_link"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.interfaces.RearLink.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>
    482. 

  482.     <span class="sd">&quot;&quot;&quot;Mates this object with a peer with which it will exchange tickets.&quot;&quot;&quot;</span>
    483. 

  483.     <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
    484. 

  484. 

  485. </div></div>
    486. 

  486. <div class="viewcode-block" id="FrontLink"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.interfaces.FrontLink">[docs]</a><span class="k">class</span> <span class="nc">FrontLink</span><span class="p">(</span><span class="n">Front</span><span class="p">,</span> <span class="n">ForeLink</span><span class="p">):</span>
    487. 

  487.   <span class="sd">&quot;&quot;&quot;Clientish objects that operate by sending and receiving tickets.&quot;&quot;&quot;</span>
    488. 

  488.   <span class="n">__metaclass__</span> <span class="o">=</span> <span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span>
    489. 

  489. 

  490. </div>
    491. 

  491. <div class="viewcode-block" id="BackLink"><a class="viewcode-back" href="../../../../grpc.framework.base.html#grpc.framework.base.interfaces.BackLink">[docs]</a><span class="k">class</span> <span class="nc">BackLink</span><span class="p">(</span><span class="n">Back</span><span class="p">,</span> <span class="n">RearLink</span><span class="p">):</span>
    492. 

  492.   <span class="sd">&quot;&quot;&quot;Serverish objects that operate by sending and receiving tickets.&quot;&quot;&quot;</span>
    493. 

  493.   <span class="n">__metaclass__</span> <span class="o">=</span> <span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span></div>
    494. 

  494. </pre></div>
    495. 

  495. 

  496.           </div>
    497. 

  497.           <footer>
    498. 

  498.   
    499. 

  499. 

  500.   <hr/>
    501. 

  501. 

  502.   <div role="contentinfo">
    503. 

  503.     <p>
    504. 

  504.         &copy; Copyright 2015, Author.
    505. 

  505.     </p>
    506. 

  506.   </div>
    507. 

  507.   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>.
    508. 

  508. 

  509. </footer>
    510. 

  510. 

  511.         </div>
    512. 

  512.       </div>
    513. 

  513. 

  514.     </section>
    515. 

  515. 

  516.   </div>
    517. 

  517.   
    518. 

  518. 

  519. 

  520.   
    521. 

  521. 

  522.     <script type="text/javascript">
    523. 

  523.         var DOCUMENTATION_OPTIONS = {
    524. 

  524.             URL_ROOT:'../../../../',
    525. 

  525.             VERSION:'0.10.0a0',
    526. 

  526.             COLLAPSE_INDEX:false,
    527. 

  527.             FILE_SUFFIX:'.html',
    528. 

  528.             HAS_SOURCE:  true
    529. 

  529.         };
    530. 

  530.     </script>
    531. 

  531.       <script type="text/javascript" src="../../../../_static/jquery.js"></script>
    532. 

  532.       <script type="text/javascript" src="../../../../_static/underscore.js"></script>
    533. 

  533.       <script type="text/javascript" src="../../../../_static/doctools.js"></script>
    534. 

  534. 

  535.   
    536. 

  536. 

  537.   
    538. 

  538.   
    539. 

  539.     <script type="text/javascript" src="../../../../_static/js/theme.js"></script>
    540. 

  540.   
    541. 

  541. 

  542.   
    543. 

  543.   
    544. 

  544.   <script type="text/javascript">
    545. 

  545.       jQuery(function () {
    546. 

  546.           SphinxRtdTheme.StickyNav.enable();
    547. 

  547.       });
    548. 

  548.   </script>
    549. 

  549.    
    550. 

  550. 

  551. </body>
    552. 

  552. </html>
    553.