interfaces.html 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410
  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.beta.interfaces &mdash; grpcio 0.11.0b0 documentation</title>
  8. <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
  9. <link rel="top" title="grpcio 0.11.0b0 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-nav-search">
  17. <a href="../../../index.html" class="icon icon-home"> grpcio
  18. </a>
  19. <div role="search">
  20. <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
  21. <input type="text" name="q" placeholder="Search docs" />
  22. <input type="hidden" name="check_keywords" value="yes" />
  23. <input type="hidden" name="area" value="default" />
  24. </form>
  25. </div>
  26. </div>
  27. <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  28. <ul>
  29. <li class="toctree-l1"><a class="reference internal" href="../../../grpc.html">grpc package</a><ul>
  30. <li class="toctree-l2"><a class="reference internal" href="../../../grpc.html#subpackages">Subpackages</a><ul>
  31. <li class="toctree-l3"><a class="reference internal" href="../../../grpc.beta.html">grpc.beta package</a><ul>
  32. <li class="toctree-l4"><a class="reference internal" href="../../../grpc.beta.html#submodules">Submodules</a></li>
  33. <li class="toctree-l4"><a class="reference internal" href="../../../grpc.beta.html#module-grpc.beta.implementations">grpc.beta.implementations module</a></li>
  34. <li class="toctree-l4"><a class="reference internal" href="../../../grpc.beta.html#module-grpc.beta.interfaces">grpc.beta.interfaces module</a></li>
  35. <li class="toctree-l4"><a class="reference internal" href="../../../grpc.beta.html#module-grpc.beta.utilities">grpc.beta.utilities module</a></li>
  36. <li class="toctree-l4"><a class="reference internal" href="../../../grpc.beta.html#module-grpc.beta">Module contents</a></li>
  37. </ul>
  38. </li>
  39. <li class="toctree-l3"><a class="reference internal" href="../../../grpc.early_adopter.html">grpc.early_adopter package</a><ul>
  40. <li class="toctree-l4"><a class="reference internal" href="../../../grpc.early_adopter.html#submodules">Submodules</a></li>
  41. <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>
  42. <li class="toctree-l4"><a class="reference internal" href="../../../grpc.early_adopter.html#module-grpc.early_adopter">Module contents</a></li>
  43. </ul>
  44. </li>
  45. <li class="toctree-l3"><a class="reference internal" href="../../../grpc.framework.html">grpc.framework package</a><ul>
  46. <li class="toctree-l4"><a class="reference internal" href="../../../grpc.framework.html#subpackages">Subpackages</a></li>
  47. <li class="toctree-l4"><a class="reference internal" href="../../../grpc.framework.html#module-grpc.framework">Module contents</a></li>
  48. </ul>
  49. </li>
  50. </ul>
  51. </li>
  52. <li class="toctree-l2"><a class="reference internal" href="../../../grpc.html#module-grpc">Module contents</a></li>
  53. </ul>
  54. </li>
  55. </ul>
  56. </div>
  57. &nbsp;
  58. </nav>
  59. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  60. <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
  61. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  62. <a href="../../../index.html">grpcio</a>
  63. </nav>
  64. <div class="wy-nav-content">
  65. <div class="rst-content">
  66. <div role="navigation" aria-label="breadcrumbs navigation">
  67. <ul class="wy-breadcrumbs">
  68. <li><a href="../../../index.html">Docs</a> &raquo;</li>
  69. <li><a href="../../index.html">Module code</a> &raquo;</li>
  70. <li>grpc.beta.interfaces</li>
  71. <li class="wy-breadcrumbs-aside">
  72. </li>
  73. </ul>
  74. <hr/>
  75. </div>
  76. <div role="main" class="document">
  77. <h1>Source code for grpc.beta.interfaces</h1><div class="highlight"><pre>
  78. <span class="c"># Copyright 2015, Google Inc.</span>
  79. <span class="c"># All rights reserved.</span>
  80. <span class="c">#</span>
  81. <span class="c"># Redistribution and use in source and binary forms, with or without</span>
  82. <span class="c"># modification, are permitted provided that the following conditions are</span>
  83. <span class="c"># met:</span>
  84. <span class="c">#</span>
  85. <span class="c"># * Redistributions of source code must retain the above copyright</span>
  86. <span class="c"># notice, this list of conditions and the following disclaimer.</span>
  87. <span class="c"># * Redistributions in binary form must reproduce the above</span>
  88. <span class="c"># copyright notice, this list of conditions and the following disclaimer</span>
  89. <span class="c"># in the documentation and/or other materials provided with the</span>
  90. <span class="c"># distribution.</span>
  91. <span class="c"># * Neither the name of Google Inc. nor the names of its</span>
  92. <span class="c"># contributors may be used to endorse or promote products derived from</span>
  93. <span class="c"># this software without specific prior written permission.</span>
  94. <span class="c">#</span>
  95. <span class="c"># THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS</span>
  96. <span class="c"># &quot;AS IS&quot; AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT</span>
  97. <span class="c"># LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR</span>
  98. <span class="c"># A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT</span>
  99. <span class="c"># OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,</span>
  100. <span class="c"># SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT</span>
  101. <span class="c"># LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,</span>
  102. <span class="c"># DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY</span>
  103. <span class="c"># THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT</span>
  104. <span class="c"># (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE</span>
  105. <span class="c"># OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span>
  106. <span class="sd">&quot;&quot;&quot;Constants and interfaces of the Beta API of gRPC Python.&quot;&quot;&quot;</span>
  107. <span class="kn">import</span> <span class="nn">abc</span>
  108. <span class="kn">import</span> <span class="nn">enum</span>
  109. <span class="kn">from</span> <span class="nn">grpc._adapter</span> <span class="kn">import</span> <span class="n">_types</span>
  110. <span class="nd">@enum.unique</span>
  111. <div class="viewcode-block" id="ChannelConnectivity"><a class="viewcode-back" href="../../../grpc.beta.html#grpc.beta.interfaces.ChannelConnectivity">[docs]</a><span class="k">class</span> <span class="nc">ChannelConnectivity</span><span class="p">(</span><span class="n">enum</span><span class="o">.</span><span class="n">Enum</span><span class="p">):</span>
  112. <span class="sd">&quot;&quot;&quot;Mirrors grpc_connectivity_state in the gRPC Core.</span>
  113. <span class="sd"> Attributes:</span>
  114. <span class="sd"> IDLE: The channel is idle.</span>
  115. <span class="sd"> CONNECTING: The channel is connecting.</span>
  116. <span class="sd"> READY: The channel is ready to conduct RPCs.</span>
  117. <span class="sd"> TRANSIENT_FAILURE: The channel has seen a failure from which it expects to</span>
  118. <span class="sd"> recover.</span>
  119. <span class="sd"> FATAL_FAILURE: The channel has seen a failure from which it cannot recover.</span>
  120. <span class="sd"> &quot;&quot;&quot;</span>
  121. <span class="n">IDLE</span> <span class="o">=</span> <span class="p">(</span><span class="n">_types</span><span class="o">.</span><span class="n">ConnectivityState</span><span class="o">.</span><span class="n">IDLE</span><span class="p">,</span> <span class="s">&#39;idle&#39;</span><span class="p">,)</span>
  122. <span class="n">CONNECTING</span> <span class="o">=</span> <span class="p">(</span><span class="n">_types</span><span class="o">.</span><span class="n">ConnectivityState</span><span class="o">.</span><span class="n">CONNECTING</span><span class="p">,</span> <span class="s">&#39;connecting&#39;</span><span class="p">,)</span>
  123. <span class="n">READY</span> <span class="o">=</span> <span class="p">(</span><span class="n">_types</span><span class="o">.</span><span class="n">ConnectivityState</span><span class="o">.</span><span class="n">READY</span><span class="p">,</span> <span class="s">&#39;ready&#39;</span><span class="p">,)</span>
  124. <span class="n">TRANSIENT_FAILURE</span> <span class="o">=</span> <span class="p">(</span>
  125. <span class="n">_types</span><span class="o">.</span><span class="n">ConnectivityState</span><span class="o">.</span><span class="n">TRANSIENT_FAILURE</span><span class="p">,</span> <span class="s">&#39;transient failure&#39;</span><span class="p">,)</span>
  126. <span class="n">FATAL_FAILURE</span> <span class="o">=</span> <span class="p">(</span><span class="n">_types</span><span class="o">.</span><span class="n">ConnectivityState</span><span class="o">.</span><span class="n">FATAL_FAILURE</span><span class="p">,</span> <span class="s">&#39;fatal failure&#39;</span><span class="p">,)</span>
  127. </div>
  128. <span class="nd">@enum.unique</span>
  129. <div class="viewcode-block" id="StatusCode"><a class="viewcode-back" href="../../../grpc.beta.html#grpc.beta.interfaces.StatusCode">[docs]</a><span class="k">class</span> <span class="nc">StatusCode</span><span class="p">(</span><span class="n">enum</span><span class="o">.</span><span class="n">Enum</span><span class="p">):</span>
  130. <span class="sd">&quot;&quot;&quot;Mirrors grpc_status_code in the C core.&quot;&quot;&quot;</span>
  131. <span class="n">OK</span> <span class="o">=</span> <span class="mi">0</span>
  132. <span class="n">CANCELLED</span> <span class="o">=</span> <span class="mi">1</span>
  133. <span class="n">UNKNOWN</span> <span class="o">=</span> <span class="mi">2</span>
  134. <span class="n">INVALID_ARGUMENT</span> <span class="o">=</span> <span class="mi">3</span>
  135. <span class="n">DEADLINE_EXCEEDED</span> <span class="o">=</span> <span class="mi">4</span>
  136. <span class="n">NOT_FOUND</span> <span class="o">=</span> <span class="mi">5</span>
  137. <span class="n">ALREADY_EXISTS</span> <span class="o">=</span> <span class="mi">6</span>
  138. <span class="n">PERMISSION_DENIED</span> <span class="o">=</span> <span class="mi">7</span>
  139. <span class="n">RESOURCE_EXHAUSTED</span> <span class="o">=</span> <span class="mi">8</span>
  140. <span class="n">FAILED_PRECONDITION</span> <span class="o">=</span> <span class="mi">9</span>
  141. <span class="n">ABORTED</span> <span class="o">=</span> <span class="mi">10</span>
  142. <span class="n">OUT_OF_RANGE</span> <span class="o">=</span> <span class="mi">11</span>
  143. <span class="n">UNIMPLEMENTED</span> <span class="o">=</span> <span class="mi">12</span>
  144. <span class="n">INTERNAL</span> <span class="o">=</span> <span class="mi">13</span>
  145. <span class="n">UNAVAILABLE</span> <span class="o">=</span> <span class="mi">14</span>
  146. <span class="n">DATA_LOSS</span> <span class="o">=</span> <span class="mi">15</span>
  147. <span class="n">UNAUTHENTICATED</span> <span class="o">=</span> <span class="mi">16</span>
  148. </div>
  149. <div class="viewcode-block" id="GRPCCallOptions"><a class="viewcode-back" href="../../../grpc.beta.html#grpc.beta.interfaces.GRPCCallOptions">[docs]</a><span class="k">class</span> <span class="nc">GRPCCallOptions</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
  150. <span class="sd">&quot;&quot;&quot;A value encapsulating gRPC-specific options passed on RPC invocation.</span>
  151. <span class="sd"> This class and its instances have no supported interface - it exists to</span>
  152. <span class="sd"> define the type of its instances and its instances exist to be passed to</span>
  153. <span class="sd"> other functions.</span>
  154. <span class="sd"> &quot;&quot;&quot;</span>
  155. <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">disable_compression</span><span class="p">,</span> <span class="n">subcall_of</span><span class="p">,</span> <span class="n">credentials</span><span class="p">):</span>
  156. <span class="bp">self</span><span class="o">.</span><span class="n">disable_compression</span> <span class="o">=</span> <span class="n">disable_compression</span>
  157. <span class="bp">self</span><span class="o">.</span><span class="n">subcall_of</span> <span class="o">=</span> <span class="n">subcall_of</span>
  158. <span class="bp">self</span><span class="o">.</span><span class="n">credentials</span> <span class="o">=</span> <span class="n">credentials</span>
  159. </div>
  160. <div class="viewcode-block" id="grpc_call_options"><a class="viewcode-back" href="../../../grpc.beta.html#grpc.beta.interfaces.grpc_call_options">[docs]</a><span class="k">def</span> <span class="nf">grpc_call_options</span><span class="p">(</span><span class="n">disable_compression</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> <span class="n">credentials</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
  161. <span class="sd">&quot;&quot;&quot;Creates a GRPCCallOptions value to be passed at RPC invocation.</span>
  162. <span class="sd"> All parameters are optional and should always be passed by keyword.</span>
  163. <span class="sd"> Args:</span>
  164. <span class="sd"> disable_compression: A boolean indicating whether or not compression should</span>
  165. <span class="sd"> be disabled for the request object of the RPC. Only valid for</span>
  166. <span class="sd"> request-unary RPCs.</span>
  167. <span class="sd"> credentials: A ClientCredentials object to use for the invoked RPC.</span>
  168. <span class="sd"> &quot;&quot;&quot;</span>
  169. <span class="k">return</span> <span class="n">GRPCCallOptions</span><span class="p">(</span><span class="n">disable_compression</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="n">credentials</span><span class="p">)</span>
  170. </div>
  171. <div class="viewcode-block" id="GRPCServicerContext"><a class="viewcode-back" href="../../../grpc.beta.html#grpc.beta.interfaces.GRPCServicerContext">[docs]</a><span class="k">class</span> <span class="nc">GRPCServicerContext</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
  172. <span class="sd">&quot;&quot;&quot;Exposes gRPC-specific options and behaviors to code servicing RPCs.&quot;&quot;&quot;</span>
  173. <span class="n">__metaclass__</span> <span class="o">=</span> <span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span>
  174. <span class="nd">@abc.abstractmethod</span>
  175. <div class="viewcode-block" id="GRPCServicerContext.peer"><a class="viewcode-back" href="../../../grpc.beta.html#grpc.beta.interfaces.GRPCServicerContext.peer">[docs]</a> <span class="k">def</span> <span class="nf">peer</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  176. <span class="sd">&quot;&quot;&quot;Identifies the peer that invoked the RPC being serviced.</span>
  177. <span class="sd"> Returns:</span>
  178. <span class="sd"> A string identifying the peer that invoked the RPC being serviced.</span>
  179. <span class="sd"> &quot;&quot;&quot;</span>
  180. <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
  181. </div>
  182. <span class="nd">@abc.abstractmethod</span>
  183. <div class="viewcode-block" id="GRPCServicerContext.disable_next_response_compression"><a class="viewcode-back" href="../../../grpc.beta.html#grpc.beta.interfaces.GRPCServicerContext.disable_next_response_compression">[docs]</a> <span class="k">def</span> <span class="nf">disable_next_response_compression</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  184. <span class="sd">&quot;&quot;&quot;Disables compression of the next response passed by the application.&quot;&quot;&quot;</span>
  185. <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
  186. </div></div>
  187. <div class="viewcode-block" id="GRPCInvocationContext"><a class="viewcode-back" href="../../../grpc.beta.html#grpc.beta.interfaces.GRPCInvocationContext">[docs]</a><span class="k">class</span> <span class="nc">GRPCInvocationContext</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
  188. <span class="sd">&quot;&quot;&quot;Exposes gRPC-specific options and behaviors to code invoking RPCs.&quot;&quot;&quot;</span>
  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. <span class="nd">@abc.abstractmethod</span>
  191. <div class="viewcode-block" id="GRPCInvocationContext.disable_next_request_compression"><a class="viewcode-back" href="../../../grpc.beta.html#grpc.beta.interfaces.GRPCInvocationContext.disable_next_request_compression">[docs]</a> <span class="k">def</span> <span class="nf">disable_next_request_compression</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  192. <span class="sd">&quot;&quot;&quot;Disables compression of the next request passed by the application.&quot;&quot;&quot;</span>
  193. <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
  194. </div></div>
  195. <div class="viewcode-block" id="Server"><a class="viewcode-back" href="../../../grpc.beta.html#grpc.beta.interfaces.Server">[docs]</a><span class="k">class</span> <span class="nc">Server</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
  196. <span class="sd">&quot;&quot;&quot;Services RPCs.&quot;&quot;&quot;</span>
  197. <span class="n">__metaclass__</span> <span class="o">=</span> <span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span>
  198. <span class="nd">@abc.abstractmethod</span>
  199. <div class="viewcode-block" id="Server.add_insecure_port"><a class="viewcode-back" href="../../../grpc.beta.html#grpc.beta.interfaces.Server.add_insecure_port">[docs]</a> <span class="k">def</span> <span class="nf">add_insecure_port</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">address</span><span class="p">):</span>
  200. <span class="sd">&quot;&quot;&quot;Reserves a port for insecure RPC service once this Server becomes active.</span>
  201. <span class="sd"> This method may only be called before calling this Server&#39;s start method is</span>
  202. <span class="sd"> called.</span>
  203. <span class="sd"> Args:</span>
  204. <span class="sd"> address: The address for which to open a port.</span>
  205. <span class="sd"> Returns:</span>
  206. <span class="sd"> An integer port on which RPCs will be serviced after this link has been</span>
  207. <span class="sd"> started. This is typically the same number as the port number contained</span>
  208. <span class="sd"> in the passed address, but will likely be different if the port number</span>
  209. <span class="sd"> contained in the passed address was zero.</span>
  210. <span class="sd"> &quot;&quot;&quot;</span>
  211. <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
  212. </div>
  213. <span class="nd">@abc.abstractmethod</span>
  214. <div class="viewcode-block" id="Server.add_secure_port"><a class="viewcode-back" href="../../../grpc.beta.html#grpc.beta.interfaces.Server.add_secure_port">[docs]</a> <span class="k">def</span> <span class="nf">add_secure_port</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">address</span><span class="p">,</span> <span class="n">server_credentials</span><span class="p">):</span>
  215. <span class="sd">&quot;&quot;&quot;Reserves a port for secure RPC service after this Server becomes active.</span>
  216. <span class="sd"> This method may only be called before calling this Server&#39;s start method is</span>
  217. <span class="sd"> called.</span>
  218. <span class="sd"> Args:</span>
  219. <span class="sd"> address: The address for which to open a port.</span>
  220. <span class="sd"> server_credentials: A ServerCredentials.</span>
  221. <span class="sd"> Returns:</span>
  222. <span class="sd"> An integer port on which RPCs will be serviced after this link has been</span>
  223. <span class="sd"> started. This is typically the same number as the port number contained</span>
  224. <span class="sd"> in the passed address, but will likely be different if the port number</span>
  225. <span class="sd"> contained in the passed address was zero.</span>
  226. <span class="sd"> &quot;&quot;&quot;</span>
  227. <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
  228. </div>
  229. <span class="nd">@abc.abstractmethod</span>
  230. <div class="viewcode-block" id="Server.start"><a class="viewcode-back" href="../../../grpc.beta.html#grpc.beta.interfaces.Server.start">[docs]</a> <span class="k">def</span> <span class="nf">start</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
  231. <span class="sd">&quot;&quot;&quot;Starts this Server&#39;s service of RPCs.</span>
  232. <span class="sd"> This method may only be called while the server is not serving RPCs (i.e. it</span>
  233. <span class="sd"> is not idempotent).</span>
  234. <span class="sd"> &quot;&quot;&quot;</span>
  235. <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
  236. </div>
  237. <span class="nd">@abc.abstractmethod</span>
  238. <div class="viewcode-block" id="Server.stop"><a class="viewcode-back" href="../../../grpc.beta.html#grpc.beta.interfaces.Server.stop">[docs]</a> <span class="k">def</span> <span class="nf">stop</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">grace</span><span class="p">):</span>
  239. <span class="sd">&quot;&quot;&quot;Stops this Server&#39;s service of RPCs.</span>
  240. <span class="sd"> All calls to this method immediately stop service of new RPCs. When existing</span>
  241. <span class="sd"> RPCs are aborted is controlled by the grace period parameter passed to this</span>
  242. <span class="sd"> method.</span>
  243. <span class="sd"> This method may be called at any time and is idempotent. Passing a smaller</span>
  244. <span class="sd"> grace value than has been passed in a previous call will have the effect of</span>
  245. <span class="sd"> stopping the Server sooner. Passing a larger grace value than has been</span>
  246. <span class="sd"> passed in a previous call will not have the effect of stopping the sooner</span>
  247. <span class="sd"> later.</span>
  248. <span class="sd"> Args:</span>
  249. <span class="sd"> grace: A duration of time in seconds to allow existing RPCs to complete</span>
  250. <span class="sd"> before being aborted by this Server&#39;s stopping. May be zero for</span>
  251. <span class="sd"> immediate abortion of all in-progress RPCs.</span>
  252. <span class="sd"> Returns:</span>
  253. <span class="sd"> A threading.Event that will be set when this Server has completely</span>
  254. <span class="sd"> stopped. The returned event may not be set until after the full grace</span>
  255. <span class="sd"> period (if some ongoing RPC continues for the full length of the period)</span>
  256. <span class="sd"> of it may be set much sooner (such as if this Server had no RPCs underway</span>
  257. <span class="sd"> at the time it was stopped or if all RPCs that it had underway completed</span>
  258. <span class="sd"> very early in the grace period).</span>
  259. <span class="sd"> &quot;&quot;&quot;</span>
  260. <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>
  261. </pre></div>
  262. </div>
  263. <footer>
  264. <hr/>
  265. <div role="contentinfo">
  266. <p>
  267. &copy; Copyright 2015, Author.
  268. </p>
  269. </div>
  270. 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>.
  271. </footer>
  272. </div>
  273. </div>
  274. </section>
  275. </div>
  276. <script type="text/javascript">
  277. var DOCUMENTATION_OPTIONS = {
  278. URL_ROOT:'../../../',
  279. VERSION:'0.11.0b0',
  280. COLLAPSE_INDEX:false,
  281. FILE_SUFFIX:'.html',
  282. HAS_SOURCE: true
  283. };
  284. </script>
  285. <script type="text/javascript" src="../../../_static/jquery.js"></script>
  286. <script type="text/javascript" src="../../../_static/underscore.js"></script>
  287. <script type="text/javascript" src="../../../_static/doctools.js"></script>
  288. <script type="text/javascript" src="../../../_static/js/theme.js"></script>
  289. <script type="text/javascript">
  290. jQuery(function () {
  291. SphinxRtdTheme.StickyNav.enable();
  292. });
  293. </script>
  294. </body>
  295. </html>