|
@@ -0,0 +1,1188 @@
|
|
|
+
|
|
|
+
|
|
|
+<!DOCTYPE html>
|
|
|
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|
|
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|
|
+<head>
|
|
|
+ <meta charset="utf-8">
|
|
|
+
|
|
|
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
+
|
|
|
+ <title>grpc.framework.interfaces.face.face — grpcio 0.11.0b0 documentation</title>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <link rel="stylesheet" href="../../../../../_static/css/theme.css" type="text/css" />
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <link rel="top" title="grpcio 0.11.0b0 documentation" href="../../../../../index.html"/>
|
|
|
+ <link rel="up" title="Module code" href="../../../../index.html"/>
|
|
|
+
|
|
|
+
|
|
|
+ <script src="_static/js/modernizr.min.js"></script>
|
|
|
+
|
|
|
+</head>
|
|
|
+
|
|
|
+<body class="wy-body-for-nav" role="document">
|
|
|
+
|
|
|
+ <div class="wy-grid-for-nav">
|
|
|
+
|
|
|
+
|
|
|
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
|
+ <div class="wy-side-nav-search">
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <a href="../../../../../index.html" class="icon icon-home"> grpcio
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ </a>
|
|
|
+
|
|
|
+
|
|
|
+<div role="search">
|
|
|
+ <form id="rtd-search-form" class="wy-form" action="../../../../../search.html" method="get">
|
|
|
+ <input type="text" name="q" placeholder="Search docs" />
|
|
|
+ <input type="hidden" name="check_keywords" value="yes" />
|
|
|
+ <input type="hidden" name="area" value="default" />
|
|
|
+ </form>
|
|
|
+</div>
|
|
|
+
|
|
|
+
|
|
|
+ </div>
|
|
|
+
|
|
|
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <ul>
|
|
|
+<li class="toctree-l1"><a class="reference internal" href="../../../../../grpc.html">grpc package</a><ul>
|
|
|
+<li class="toctree-l2"><a class="reference internal" href="../../../../../grpc.html#subpackages">Subpackages</a><ul>
|
|
|
+<li class="toctree-l3"><a class="reference internal" href="../../../../../grpc.beta.html">grpc.beta package</a><ul>
|
|
|
+<li class="toctree-l4"><a class="reference internal" href="../../../../../grpc.beta.html#submodules">Submodules</a></li>
|
|
|
+<li class="toctree-l4"><a class="reference internal" href="../../../../../grpc.beta.html#module-grpc.beta.implementations">grpc.beta.implementations module</a></li>
|
|
|
+<li class="toctree-l4"><a class="reference internal" href="../../../../../grpc.beta.html#module-grpc.beta.interfaces">grpc.beta.interfaces module</a></li>
|
|
|
+<li class="toctree-l4"><a class="reference internal" href="../../../../../grpc.beta.html#module-grpc.beta.utilities">grpc.beta.utilities module</a></li>
|
|
|
+<li class="toctree-l4"><a class="reference internal" href="../../../../../grpc.beta.html#module-grpc.beta">Module contents</a></li>
|
|
|
+</ul>
|
|
|
+</li>
|
|
|
+<li class="toctree-l3"><a class="reference internal" href="../../../../../grpc.early_adopter.html">grpc.early_adopter package</a><ul>
|
|
|
+<li class="toctree-l4"><a class="reference internal" href="../../../../../grpc.early_adopter.html#submodules">Submodules</a></li>
|
|
|
+<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>
|
|
|
+<li class="toctree-l4"><a class="reference internal" href="../../../../../grpc.early_adopter.html#module-grpc.early_adopter">Module contents</a></li>
|
|
|
+</ul>
|
|
|
+</li>
|
|
|
+<li class="toctree-l3"><a class="reference internal" href="../../../../../grpc.framework.html">grpc.framework package</a><ul>
|
|
|
+<li class="toctree-l4"><a class="reference internal" href="../../../../../grpc.framework.html#subpackages">Subpackages</a></li>
|
|
|
+<li class="toctree-l4"><a class="reference internal" href="../../../../../grpc.framework.html#module-grpc.framework">Module contents</a></li>
|
|
|
+</ul>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+</li>
|
|
|
+<li class="toctree-l2"><a class="reference internal" href="../../../../../grpc.html#module-grpc">Module contents</a></li>
|
|
|
+</ul>
|
|
|
+</li>
|
|
|
+</ul>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ </div>
|
|
|
+
|
|
|
+ </nav>
|
|
|
+
|
|
|
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
+
|
|
|
+
|
|
|
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
|
|
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
|
+ <a href="../../../../../index.html">grpcio</a>
|
|
|
+ </nav>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <div class="wy-nav-content">
|
|
|
+ <div class="rst-content">
|
|
|
+ <div role="navigation" aria-label="breadcrumbs navigation">
|
|
|
+ <ul class="wy-breadcrumbs">
|
|
|
+ <li><a href="../../../../../index.html">Docs</a> »</li>
|
|
|
+
|
|
|
+ <li><a href="../../../../index.html">Module code</a> »</li>
|
|
|
+
|
|
|
+ <li>grpc.framework.interfaces.face.face</li>
|
|
|
+ <li class="wy-breadcrumbs-aside">
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ </li>
|
|
|
+ </ul>
|
|
|
+ <hr/>
|
|
|
+</div>
|
|
|
+ <div role="main" class="document">
|
|
|
+
|
|
|
+ <h1>Source code for grpc.framework.interfaces.face.face</h1><div class="highlight"><pre>
|
|
|
+<span class="c"># Copyright 2015, Google Inc.</span>
|
|
|
+<span class="c"># All rights reserved.</span>
|
|
|
+<span class="c">#</span>
|
|
|
+<span class="c"># Redistribution and use in source and binary forms, with or without</span>
|
|
|
+<span class="c"># modification, are permitted provided that the following conditions are</span>
|
|
|
+<span class="c"># met:</span>
|
|
|
+<span class="c">#</span>
|
|
|
+<span class="c"># * Redistributions of source code must retain the above copyright</span>
|
|
|
+<span class="c"># notice, this list of conditions and the following disclaimer.</span>
|
|
|
+<span class="c"># * Redistributions in binary form must reproduce the above</span>
|
|
|
+<span class="c"># copyright notice, this list of conditions and the following disclaimer</span>
|
|
|
+<span class="c"># in the documentation and/or other materials provided with the</span>
|
|
|
+<span class="c"># distribution.</span>
|
|
|
+<span class="c"># * Neither the name of Google Inc. nor the names of its</span>
|
|
|
+<span class="c"># contributors may be used to endorse or promote products derived from</span>
|
|
|
+<span class="c"># this software without specific prior written permission.</span>
|
|
|
+<span class="c">#</span>
|
|
|
+<span class="c"># THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS</span>
|
|
|
+<span class="c"># "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT</span>
|
|
|
+<span class="c"># LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR</span>
|
|
|
+<span class="c"># A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT</span>
|
|
|
+<span class="c"># OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,</span>
|
|
|
+<span class="c"># SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT</span>
|
|
|
+<span class="c"># LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,</span>
|
|
|
+<span class="c"># DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY</span>
|
|
|
+<span class="c"># THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT</span>
|
|
|
+<span class="c"># (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE</span>
|
|
|
+<span class="c"># OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span>
|
|
|
+
|
|
|
+<span class="sd">"""Interfaces defining the Face layer of RPC Framework."""</span>
|
|
|
+
|
|
|
+<span class="kn">import</span> <span class="nn">abc</span>
|
|
|
+<span class="kn">import</span> <span class="nn">collections</span>
|
|
|
+<span class="kn">import</span> <span class="nn">enum</span>
|
|
|
+
|
|
|
+<span class="c"># cardinality, style, abandonment, future, and stream are</span>
|
|
|
+<span class="c"># referenced from specification in this module.</span>
|
|
|
+<span class="kn">from</span> <span class="nn">grpc.framework.common</span> <span class="kn">import</span> <span class="n">cardinality</span> <span class="c"># pylint: disable=unused-import</span>
|
|
|
+<span class="kn">from</span> <span class="nn">grpc.framework.common</span> <span class="kn">import</span> <span class="n">style</span> <span class="c"># pylint: disable=unused-import</span>
|
|
|
+<span class="kn">from</span> <span class="nn">grpc.framework.foundation</span> <span class="kn">import</span> <span class="n">abandonment</span> <span class="c"># pylint: disable=unused-import</span>
|
|
|
+<span class="kn">from</span> <span class="nn">grpc.framework.foundation</span> <span class="kn">import</span> <span class="n">future</span> <span class="c"># pylint: disable=unused-import</span>
|
|
|
+<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>
|
|
|
+
|
|
|
+
|
|
|
+<div class="viewcode-block" id="NoSuchMethodError"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.NoSuchMethodError">[docs]</a><span class="k">class</span> <span class="nc">NoSuchMethodError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Raised by customer code to indicate an unrecognized method.</span>
|
|
|
+
|
|
|
+<span class="sd"> Attributes:</span>
|
|
|
+<span class="sd"> group: The group of the unrecognized method.</span>
|
|
|
+<span class="sd"> name: The name of the unrecognized method.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+
|
|
|
+ <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">group</span><span class="p">,</span> <span class="n">method</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Constructor.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> group: The group identifier of the unrecognized RPC name.</span>
|
|
|
+<span class="sd"> method: The method identifier of the unrecognized RPC name.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="nb">super</span><span class="p">(</span><span class="n">NoSuchMethodError</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">__init__</span><span class="p">()</span>
|
|
|
+ <span class="bp">self</span><span class="o">.</span><span class="n">group</span> <span class="o">=</span> <span class="n">group</span>
|
|
|
+ <span class="bp">self</span><span class="o">.</span><span class="n">method</span> <span class="o">=</span> <span class="n">method</span>
|
|
|
+
|
|
|
+ <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
|
+ <span class="k">return</span> <span class="s">'face.NoSuchMethodError(</span><span class="si">%s</span><span class="s">, </span><span class="si">%s</span><span class="s">)'</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">group</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">method</span><span class="p">,)</span>
|
|
|
+
|
|
|
+</div>
|
|
|
+<div class="viewcode-block" id="Abortion"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.Abortion">[docs]</a><span class="k">class</span> <span class="nc">Abortion</span><span class="p">(</span>
|
|
|
+ <span class="n">collections</span><span class="o">.</span><span class="n">namedtuple</span><span class="p">(</span>
|
|
|
+ <span class="s">'Abortion'</span><span class="p">,</span>
|
|
|
+ <span class="p">(</span><span class="s">'kind'</span><span class="p">,</span> <span class="s">'initial_metadata'</span><span class="p">,</span> <span class="s">'terminal_metadata'</span><span class="p">,</span> <span class="s">'code'</span><span class="p">,</span> <span class="s">'details'</span><span class="p">,))):</span>
|
|
|
+ <span class="sd">"""A value describing RPC abortion.</span>
|
|
|
+
|
|
|
+<span class="sd"> Attributes:</span>
|
|
|
+<span class="sd"> kind: A Kind value identifying how the RPC failed.</span>
|
|
|
+<span class="sd"> initial_metadata: The initial metadata from the other side of the RPC or</span>
|
|
|
+<span class="sd"> None if no initial metadata value was received.</span>
|
|
|
+<span class="sd"> terminal_metadata: The terminal metadata from the other side of the RPC or</span>
|
|
|
+<span class="sd"> None if no terminal metadata value was received.</span>
|
|
|
+<span class="sd"> code: The code value from the other side of the RPC or None if no code value</span>
|
|
|
+<span class="sd"> was received.</span>
|
|
|
+<span class="sd"> details: The details value from the other side of the RPC or None if no</span>
|
|
|
+<span class="sd"> details value was received.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+
|
|
|
+ <span class="nd">@enum.unique</span>
|
|
|
+<div class="viewcode-block" id="Abortion.Kind"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.Abortion.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>
|
|
|
+ <span class="sd">"""Types of RPC abortion."""</span>
|
|
|
+
|
|
|
+ <span class="n">CANCELLED</span> <span class="o">=</span> <span class="s">'cancelled'</span>
|
|
|
+ <span class="n">EXPIRED</span> <span class="o">=</span> <span class="s">'expired'</span>
|
|
|
+ <span class="n">LOCAL_SHUTDOWN</span> <span class="o">=</span> <span class="s">'local shutdown'</span>
|
|
|
+ <span class="n">REMOTE_SHUTDOWN</span> <span class="o">=</span> <span class="s">'remote shutdown'</span>
|
|
|
+ <span class="n">NETWORK_FAILURE</span> <span class="o">=</span> <span class="s">'network failure'</span>
|
|
|
+ <span class="n">LOCAL_FAILURE</span> <span class="o">=</span> <span class="s">'local failure'</span>
|
|
|
+ <span class="n">REMOTE_FAILURE</span> <span class="o">=</span> <span class="s">'remote failure'</span>
|
|
|
+
|
|
|
+</div></div>
|
|
|
+<div class="viewcode-block" id="AbortionError"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.AbortionError">[docs]</a><span class="k">class</span> <span class="nc">AbortionError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Common super type for exceptions indicating RPC abortion.</span>
|
|
|
+
|
|
|
+<span class="sd"> initial_metadata: The initial metadata from the other side of the RPC or</span>
|
|
|
+<span class="sd"> None if no initial metadata value was received.</span>
|
|
|
+<span class="sd"> terminal_metadata: The terminal metadata from the other side of the RPC or</span>
|
|
|
+<span class="sd"> None if no terminal metadata value was received.</span>
|
|
|
+<span class="sd"> code: The code value from the other side of the RPC or None if no code value</span>
|
|
|
+<span class="sd"> was received.</span>
|
|
|
+<span class="sd"> details: The details value from the other side of the RPC or None if no</span>
|
|
|
+<span class="sd"> details value was received.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="n">__metaclass__</span> <span class="o">=</span> <span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span>
|
|
|
+
|
|
|
+ <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">initial_metadata</span><span class="p">,</span> <span class="n">terminal_metadata</span><span class="p">,</span> <span class="n">code</span><span class="p">,</span> <span class="n">details</span><span class="p">):</span>
|
|
|
+ <span class="nb">super</span><span class="p">(</span><span class="n">AbortionError</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">__init__</span><span class="p">()</span>
|
|
|
+ <span class="bp">self</span><span class="o">.</span><span class="n">initial_metadata</span> <span class="o">=</span> <span class="n">initial_metadata</span>
|
|
|
+ <span class="bp">self</span><span class="o">.</span><span class="n">terminal_metadata</span> <span class="o">=</span> <span class="n">terminal_metadata</span>
|
|
|
+ <span class="bp">self</span><span class="o">.</span><span class="n">code</span> <span class="o">=</span> <span class="n">code</span>
|
|
|
+ <span class="bp">self</span><span class="o">.</span><span class="n">details</span> <span class="o">=</span> <span class="n">details</span>
|
|
|
+
|
|
|
+</div>
|
|
|
+<div class="viewcode-block" id="CancellationError"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.CancellationError">[docs]</a><span class="k">class</span> <span class="nc">CancellationError</span><span class="p">(</span><span class="n">AbortionError</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Indicates that an RPC has been cancelled."""</span>
|
|
|
+
|
|
|
+</div>
|
|
|
+<div class="viewcode-block" id="ExpirationError"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.ExpirationError">[docs]</a><span class="k">class</span> <span class="nc">ExpirationError</span><span class="p">(</span><span class="n">AbortionError</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Indicates that an RPC has expired ("timed out")."""</span>
|
|
|
+
|
|
|
+</div>
|
|
|
+<div class="viewcode-block" id="LocalShutdownError"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.LocalShutdownError">[docs]</a><span class="k">class</span> <span class="nc">LocalShutdownError</span><span class="p">(</span><span class="n">AbortionError</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Indicates that an RPC has terminated due to local shutdown of RPCs."""</span>
|
|
|
+
|
|
|
+</div>
|
|
|
+<div class="viewcode-block" id="RemoteShutdownError"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.RemoteShutdownError">[docs]</a><span class="k">class</span> <span class="nc">RemoteShutdownError</span><span class="p">(</span><span class="n">AbortionError</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Indicates that an RPC has terminated due to remote shutdown of RPCs."""</span>
|
|
|
+
|
|
|
+</div>
|
|
|
+<div class="viewcode-block" id="NetworkError"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.NetworkError">[docs]</a><span class="k">class</span> <span class="nc">NetworkError</span><span class="p">(</span><span class="n">AbortionError</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Indicates that some error occurred on the network."""</span>
|
|
|
+
|
|
|
+</div>
|
|
|
+<div class="viewcode-block" id="LocalError"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.LocalError">[docs]</a><span class="k">class</span> <span class="nc">LocalError</span><span class="p">(</span><span class="n">AbortionError</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Indicates that an RPC has terminated due to a local defect."""</span>
|
|
|
+
|
|
|
+</div>
|
|
|
+<div class="viewcode-block" id="RemoteError"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.RemoteError">[docs]</a><span class="k">class</span> <span class="nc">RemoteError</span><span class="p">(</span><span class="n">AbortionError</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Indicates that an RPC has terminated due to a remote defect."""</span>
|
|
|
+
|
|
|
+</div>
|
|
|
+<div class="viewcode-block" id="RpcContext"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.RpcContext">[docs]</a><span class="k">class</span> <span class="nc">RpcContext</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Provides RPC-related information and action."""</span>
|
|
|
+ <span class="n">__metaclass__</span> <span class="o">=</span> <span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span>
|
|
|
+
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="RpcContext.is_active"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.RpcContext.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>
|
|
|
+ <span class="sd">"""Describes whether the RPC is active or has terminated."""</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+</div>
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="RpcContext.time_remaining"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.RpcContext.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>
|
|
|
+ <span class="sd">"""Describes the length of allowed time remaining for the RPC.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> A nonnegative float indicating the length of allowed time in seconds</span>
|
|
|
+<span class="sd"> remaining for the RPC to complete before it is considered to have timed</span>
|
|
|
+<span class="sd"> out.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+</div>
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="RpcContext.add_abortion_callback"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.RpcContext.add_abortion_callback">[docs]</a> <span class="k">def</span> <span class="nf">add_abortion_callback</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">abortion_callback</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Registers a callback to be called if the RPC is aborted.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> abortion_callback: A callable to be called and passed an Abortion value</span>
|
|
|
+<span class="sd"> in the event of RPC abortion.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+</div>
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="RpcContext.cancel"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.RpcContext.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>
|
|
|
+ <span class="sd">"""Cancels the RPC.</span>
|
|
|
+
|
|
|
+<span class="sd"> Idempotent and has no effect if the RPC has already terminated.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+</div>
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="RpcContext.protocol_context"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.RpcContext.protocol_context">[docs]</a> <span class="k">def</span> <span class="nf">protocol_context</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Accesses a custom object specified by an implementation provider.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> A value specified by the provider of a Face interface implementation</span>
|
|
|
+<span class="sd"> affording custom state and behavior.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+
|
|
|
+</div></div>
|
|
|
+<div class="viewcode-block" id="Call"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.Call">[docs]</a><span class="k">class</span> <span class="nc">Call</span><span class="p">(</span><span class="n">RpcContext</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Invocation-side utility object for an RPC."""</span>
|
|
|
+ <span class="n">__metaclass__</span> <span class="o">=</span> <span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span>
|
|
|
+
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="Call.initial_metadata"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.Call.initial_metadata">[docs]</a> <span class="k">def</span> <span class="nf">initial_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Accesses the initial metadata from the service-side of the RPC.</span>
|
|
|
+
|
|
|
+<span class="sd"> This method blocks until the value is available or is known not to have been</span>
|
|
|
+<span class="sd"> emitted from the service-side of the RPC.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> The initial metadata object emitted by the service-side of the RPC, or</span>
|
|
|
+<span class="sd"> None if there was no such value.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+</div>
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="Call.terminal_metadata"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.Call.terminal_metadata">[docs]</a> <span class="k">def</span> <span class="nf">terminal_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Accesses the terminal metadata from the service-side of the RPC.</span>
|
|
|
+
|
|
|
+<span class="sd"> This method blocks until the value is available or is known not to have been</span>
|
|
|
+<span class="sd"> emitted from the service-side of the RPC.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> The terminal metadata object emitted by the service-side of the RPC, or</span>
|
|
|
+<span class="sd"> None if there was no such value.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+</div>
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="Call.code"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.Call.code">[docs]</a> <span class="k">def</span> <span class="nf">code</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Accesses the code emitted by the service-side of the RPC.</span>
|
|
|
+
|
|
|
+<span class="sd"> This method blocks until the value is available or is known not to have been</span>
|
|
|
+<span class="sd"> emitted from the service-side of the RPC.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> The code object emitted by the service-side of the RPC, or None if there</span>
|
|
|
+<span class="sd"> was no such value.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+</div>
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="Call.details"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.Call.details">[docs]</a> <span class="k">def</span> <span class="nf">details</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Accesses the details value emitted by the service-side of the RPC.</span>
|
|
|
+
|
|
|
+<span class="sd"> This method blocks until the value is available or is known not to have been</span>
|
|
|
+<span class="sd"> emitted from the service-side of the RPC.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> The details value emitted by the service-side of the RPC, or None if there</span>
|
|
|
+<span class="sd"> was no such value.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+
|
|
|
+</div></div>
|
|
|
+<div class="viewcode-block" id="ServicerContext"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.ServicerContext">[docs]</a><span class="k">class</span> <span class="nc">ServicerContext</span><span class="p">(</span><span class="n">RpcContext</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""A context object passed to method implementations."""</span>
|
|
|
+ <span class="n">__metaclass__</span> <span class="o">=</span> <span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span>
|
|
|
+
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="ServicerContext.invocation_metadata"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.ServicerContext.invocation_metadata">[docs]</a> <span class="k">def</span> <span class="nf">invocation_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Accesses the metadata from the invocation-side of the RPC.</span>
|
|
|
+
|
|
|
+<span class="sd"> This method blocks until the value is available or is known not to have been</span>
|
|
|
+<span class="sd"> emitted from the invocation-side of the RPC.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> The metadata object emitted by the invocation-side of the RPC, or None if</span>
|
|
|
+<span class="sd"> there was no such value.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+</div>
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="ServicerContext.initial_metadata"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.ServicerContext.initial_metadata">[docs]</a> <span class="k">def</span> <span class="nf">initial_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">initial_metadata</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Accepts the service-side initial metadata value of the RPC.</span>
|
|
|
+
|
|
|
+<span class="sd"> This method need not be called by method implementations if they have no</span>
|
|
|
+<span class="sd"> service-side initial metadata to transmit.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> initial_metadata: The service-side initial metadata value of the RPC to</span>
|
|
|
+<span class="sd"> be transmitted to the invocation side of the RPC.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+</div>
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="ServicerContext.terminal_metadata"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.ServicerContext.terminal_metadata">[docs]</a> <span class="k">def</span> <span class="nf">terminal_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">terminal_metadata</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Accepts the service-side terminal metadata value of the RPC.</span>
|
|
|
+
|
|
|
+<span class="sd"> This method need not be called by method implementations if they have no</span>
|
|
|
+<span class="sd"> service-side terminal metadata to transmit.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> terminal_metadata: The service-side terminal metadata value of the RPC to</span>
|
|
|
+<span class="sd"> be transmitted to the invocation side of the RPC.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+</div>
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="ServicerContext.code"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.ServicerContext.code">[docs]</a> <span class="k">def</span> <span class="nf">code</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">code</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Accepts the service-side code of the RPC.</span>
|
|
|
+
|
|
|
+<span class="sd"> This method need not be called by method implementations if they have no</span>
|
|
|
+<span class="sd"> code to transmit.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> code: The code of the RPC to be transmitted to the invocation side of the</span>
|
|
|
+<span class="sd"> RPC.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+</div>
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="ServicerContext.details"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.ServicerContext.details">[docs]</a> <span class="k">def</span> <span class="nf">details</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">details</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Accepts the service-side details of the RPC.</span>
|
|
|
+
|
|
|
+<span class="sd"> This method need not be called by method implementations if they have no</span>
|
|
|
+<span class="sd"> service-side details to transmit.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> details: The service-side details value of the RPC to be transmitted to</span>
|
|
|
+<span class="sd"> the invocation side of the RPC.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+
|
|
|
+</div></div>
|
|
|
+<div class="viewcode-block" id="ResponseReceiver"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.ResponseReceiver">[docs]</a><span class="k">class</span> <span class="nc">ResponseReceiver</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Invocation-side object used to accept the output of an RPC."""</span>
|
|
|
+ <span class="n">__metaclass__</span> <span class="o">=</span> <span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span>
|
|
|
+
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="ResponseReceiver.initial_metadata"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.ResponseReceiver.initial_metadata">[docs]</a> <span class="k">def</span> <span class="nf">initial_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">initial_metadata</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Receives the initial metadata from the service-side of the RPC.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> initial_metadata: The initial metadata object emitted from the</span>
|
|
|
+<span class="sd"> service-side of the RPC.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+</div>
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="ResponseReceiver.response"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.ResponseReceiver.response">[docs]</a> <span class="k">def</span> <span class="nf">response</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">response</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Receives a response from the service-side of the RPC.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> response: A response object emitted from the service-side of the RPC.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+</div>
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="ResponseReceiver.complete"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.ResponseReceiver.complete">[docs]</a> <span class="k">def</span> <span class="nf">complete</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">terminal_metadata</span><span class="p">,</span> <span class="n">code</span><span class="p">,</span> <span class="n">details</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Receives the completion values emitted from the service-side of the RPC.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> terminal_metadata: The terminal metadata object emitted from the</span>
|
|
|
+<span class="sd"> service-side of the RPC.</span>
|
|
|
+<span class="sd"> code: The code object emitted from the service-side of the RPC.</span>
|
|
|
+<span class="sd"> details: The details object emitted from the service-side of the RPC.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+
|
|
|
+</div></div>
|
|
|
+<div class="viewcode-block" id="UnaryUnaryMultiCallable"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.UnaryUnaryMultiCallable">[docs]</a><span class="k">class</span> <span class="nc">UnaryUnaryMultiCallable</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Affords invoking a unary-unary RPC in any call style."""</span>
|
|
|
+ <span class="n">__metaclass__</span> <span class="o">=</span> <span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span>
|
|
|
+
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="UnaryUnaryMultiCallable.__call__"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.UnaryUnaryMultiCallable.__call__">[docs]</a> <span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span>
|
|
|
+ <span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">with_call</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span>
|
|
|
+ <span class="n">protocol_options</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Synchronously invokes the underlying RPC.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> request: The request value for the RPC.</span>
|
|
|
+<span class="sd"> timeout: A duration of time in seconds to allow for the RPC.</span>
|
|
|
+<span class="sd"> metadata: A metadata value to be passed to the service-side of</span>
|
|
|
+<span class="sd"> the RPC.</span>
|
|
|
+<span class="sd"> with_call: Whether or not to include return a Call for the RPC in addition</span>
|
|
|
+<span class="sd"> to the reponse.</span>
|
|
|
+<span class="sd"> protocol_options: A value specified by the provider of a Face interface</span>
|
|
|
+<span class="sd"> implementation affording custom state and behavior.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> The response value for the RPC, and a Call for the RPC if with_call was</span>
|
|
|
+<span class="sd"> set to True at invocation.</span>
|
|
|
+
|
|
|
+<span class="sd"> Raises:</span>
|
|
|
+<span class="sd"> AbortionError: Indicating that the RPC was aborted.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+</div>
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="UnaryUnaryMultiCallable.future"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.UnaryUnaryMultiCallable.future">[docs]</a> <span class="k">def</span> <span class="nf">future</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">protocol_options</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Asynchronously invokes the underlying RPC.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> request: The request value for the RPC.</span>
|
|
|
+<span class="sd"> timeout: A duration of time in seconds to allow for the RPC.</span>
|
|
|
+<span class="sd"> metadata: A metadata value to be passed to the service-side of</span>
|
|
|
+<span class="sd"> the RPC.</span>
|
|
|
+<span class="sd"> protocol_options: A value specified by the provider of a Face interface</span>
|
|
|
+<span class="sd"> implementation affording custom state and behavior.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> An object that is both a Call for the RPC and a future.Future. In the</span>
|
|
|
+<span class="sd"> event of RPC completion, the return Future's result value will be the</span>
|
|
|
+<span class="sd"> response value of the RPC. In the event of RPC abortion, the returned</span>
|
|
|
+<span class="sd"> Future's exception value will be an AbortionError.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+</div>
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="UnaryUnaryMultiCallable.event"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.UnaryUnaryMultiCallable.event">[docs]</a> <span class="k">def</span> <span class="nf">event</span><span class="p">(</span>
|
|
|
+ <span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">receiver</span><span class="p">,</span> <span class="n">abortion_callback</span><span class="p">,</span> <span class="n">timeout</span><span class="p">,</span>
|
|
|
+ <span class="n">metadata</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">protocol_options</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Asynchronously invokes the underlying RPC.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> request: The request value for the RPC.</span>
|
|
|
+<span class="sd"> receiver: A ResponseReceiver to be passed the response data of the RPC.</span>
|
|
|
+<span class="sd"> abortion_callback: A callback to be called and passed an Abortion value</span>
|
|
|
+<span class="sd"> in the event of RPC abortion.</span>
|
|
|
+<span class="sd"> timeout: A duration of time in seconds to allow for the RPC.</span>
|
|
|
+<span class="sd"> metadata: A metadata value to be passed to the service-side of</span>
|
|
|
+<span class="sd"> the RPC.</span>
|
|
|
+<span class="sd"> protocol_options: A value specified by the provider of a Face interface</span>
|
|
|
+<span class="sd"> implementation affording custom state and behavior.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> A Call for the RPC.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+
|
|
|
+</div></div>
|
|
|
+<div class="viewcode-block" id="UnaryStreamMultiCallable"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.UnaryStreamMultiCallable">[docs]</a><span class="k">class</span> <span class="nc">UnaryStreamMultiCallable</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Affords invoking a unary-stream RPC in any call style."""</span>
|
|
|
+ <span class="n">__metaclass__</span> <span class="o">=</span> <span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span>
|
|
|
+
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="UnaryStreamMultiCallable.__call__"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.UnaryStreamMultiCallable.__call__">[docs]</a> <span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">protocol_options</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Invokes the underlying RPC.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> request: The request value for the RPC.</span>
|
|
|
+<span class="sd"> timeout: A duration of time in seconds to allow for the RPC.</span>
|
|
|
+<span class="sd"> metadata: A metadata value to be passed to the service-side of</span>
|
|
|
+<span class="sd"> the RPC.</span>
|
|
|
+<span class="sd"> protocol_options: A value specified by the provider of a Face interface</span>
|
|
|
+<span class="sd"> implementation affording custom state and behavior.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> An object that is both a Call for the RPC and an iterator of response</span>
|
|
|
+<span class="sd"> values. Drawing response values from the returned iterator may raise</span>
|
|
|
+<span class="sd"> AbortionError indicating abortion of the RPC.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+</div>
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="UnaryStreamMultiCallable.event"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.UnaryStreamMultiCallable.event">[docs]</a> <span class="k">def</span> <span class="nf">event</span><span class="p">(</span>
|
|
|
+ <span class="bp">self</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">receiver</span><span class="p">,</span> <span class="n">abortion_callback</span><span class="p">,</span> <span class="n">timeout</span><span class="p">,</span>
|
|
|
+ <span class="n">metadata</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">protocol_options</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Asynchronously invokes the underlying RPC.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> request: The request value for the RPC.</span>
|
|
|
+<span class="sd"> receiver: A ResponseReceiver to be passed the response data of the RPC.</span>
|
|
|
+<span class="sd"> abortion_callback: A callback to be called and passed an Abortion value</span>
|
|
|
+<span class="sd"> in the event of RPC abortion.</span>
|
|
|
+<span class="sd"> timeout: A duration of time in seconds to allow for the RPC.</span>
|
|
|
+<span class="sd"> metadata: A metadata value to be passed to the service-side of</span>
|
|
|
+<span class="sd"> the RPC.</span>
|
|
|
+<span class="sd"> protocol_options: A value specified by the provider of a Face interface</span>
|
|
|
+<span class="sd"> implementation affording custom state and behavior.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> A Call object for the RPC.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+
|
|
|
+</div></div>
|
|
|
+<div class="viewcode-block" id="StreamUnaryMultiCallable"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.StreamUnaryMultiCallable">[docs]</a><span class="k">class</span> <span class="nc">StreamUnaryMultiCallable</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Affords invoking a stream-unary RPC in any call style."""</span>
|
|
|
+ <span class="n">__metaclass__</span> <span class="o">=</span> <span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span>
|
|
|
+
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="StreamUnaryMultiCallable.__call__"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.StreamUnaryMultiCallable.__call__">[docs]</a> <span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span>
|
|
|
+ <span class="bp">self</span><span class="p">,</span> <span class="n">request_iterator</span><span class="p">,</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
|
|
|
+ <span class="n">with_call</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> <span class="n">protocol_options</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Synchronously invokes the underlying RPC.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> request_iterator: An iterator that yields request values for the RPC.</span>
|
|
|
+<span class="sd"> timeout: A duration of time in seconds to allow for the RPC.</span>
|
|
|
+<span class="sd"> metadata: A metadata value to be passed to the service-side of</span>
|
|
|
+<span class="sd"> the RPC.</span>
|
|
|
+<span class="sd"> with_call: Whether or not to include return a Call for the RPC in addition</span>
|
|
|
+<span class="sd"> to the reponse.</span>
|
|
|
+<span class="sd"> protocol_options: A value specified by the provider of a Face interface</span>
|
|
|
+<span class="sd"> implementation affording custom state and behavior.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> The response value for the RPC, and a Call for the RPC if with_call was</span>
|
|
|
+<span class="sd"> set to True at invocation.</span>
|
|
|
+
|
|
|
+<span class="sd"> Raises:</span>
|
|
|
+<span class="sd"> AbortionError: Indicating that the RPC was aborted.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+</div>
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="StreamUnaryMultiCallable.future"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.StreamUnaryMultiCallable.future">[docs]</a> <span class="k">def</span> <span class="nf">future</span><span class="p">(</span>
|
|
|
+ <span class="bp">self</span><span class="p">,</span> <span class="n">request_iterator</span><span class="p">,</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">protocol_options</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Asynchronously invokes the underlying RPC.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> request_iterator: An iterator that yields request values for the RPC.</span>
|
|
|
+<span class="sd"> timeout: A duration of time in seconds to allow for the RPC.</span>
|
|
|
+<span class="sd"> metadata: A metadata value to be passed to the service-side of</span>
|
|
|
+<span class="sd"> the RPC.</span>
|
|
|
+<span class="sd"> protocol_options: A value specified by the provider of a Face interface</span>
|
|
|
+<span class="sd"> implementation affording custom state and behavior.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> An object that is both a Call for the RPC and a future.Future. In the</span>
|
|
|
+<span class="sd"> event of RPC completion, the return Future's result value will be the</span>
|
|
|
+<span class="sd"> response value of the RPC. In the event of RPC abortion, the returned</span>
|
|
|
+<span class="sd"> Future's exception value will be an AbortionError.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+</div>
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="StreamUnaryMultiCallable.event"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.StreamUnaryMultiCallable.event">[docs]</a> <span class="k">def</span> <span class="nf">event</span><span class="p">(</span>
|
|
|
+ <span class="bp">self</span><span class="p">,</span> <span class="n">receiver</span><span class="p">,</span> <span class="n">abortion_callback</span><span class="p">,</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
|
|
|
+ <span class="n">protocol_options</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Asynchronously invokes the underlying RPC.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> receiver: A ResponseReceiver to be passed the response data of the RPC.</span>
|
|
|
+<span class="sd"> abortion_callback: A callback to be called and passed an Abortion value</span>
|
|
|
+<span class="sd"> in the event of RPC abortion.</span>
|
|
|
+<span class="sd"> timeout: A duration of time in seconds to allow for the RPC.</span>
|
|
|
+<span class="sd"> metadata: A metadata value to be passed to the service-side of</span>
|
|
|
+<span class="sd"> the RPC.</span>
|
|
|
+<span class="sd"> protocol_options: A value specified by the provider of a Face interface</span>
|
|
|
+<span class="sd"> implementation affording custom state and behavior.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> A single object that is both a Call object for the RPC and a</span>
|
|
|
+<span class="sd"> stream.Consumer to which the request values of the RPC should be passed.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+
|
|
|
+</div></div>
|
|
|
+<div class="viewcode-block" id="StreamStreamMultiCallable"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.StreamStreamMultiCallable">[docs]</a><span class="k">class</span> <span class="nc">StreamStreamMultiCallable</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Affords invoking a stream-stream RPC in any call style."""</span>
|
|
|
+ <span class="n">__metaclass__</span> <span class="o">=</span> <span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span>
|
|
|
+
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="StreamStreamMultiCallable.__call__"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.StreamStreamMultiCallable.__call__">[docs]</a> <span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span>
|
|
|
+ <span class="bp">self</span><span class="p">,</span> <span class="n">request_iterator</span><span class="p">,</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">protocol_options</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Invokes the underlying RPC.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> request_iterator: An iterator that yields request values for the RPC.</span>
|
|
|
+<span class="sd"> timeout: A duration of time in seconds to allow for the RPC.</span>
|
|
|
+<span class="sd"> metadata: A metadata value to be passed to the service-side of</span>
|
|
|
+<span class="sd"> the RPC.</span>
|
|
|
+<span class="sd"> protocol_options: A value specified by the provider of a Face interface</span>
|
|
|
+<span class="sd"> implementation affording custom state and behavior.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> An object that is both a Call for the RPC and an iterator of response</span>
|
|
|
+<span class="sd"> values. Drawing response values from the returned iterator may raise</span>
|
|
|
+<span class="sd"> AbortionError indicating abortion of the RPC.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+</div>
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="StreamStreamMultiCallable.event"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.StreamStreamMultiCallable.event">[docs]</a> <span class="k">def</span> <span class="nf">event</span><span class="p">(</span>
|
|
|
+ <span class="bp">self</span><span class="p">,</span> <span class="n">receiver</span><span class="p">,</span> <span class="n">abortion_callback</span><span class="p">,</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
|
|
|
+ <span class="n">protocol_options</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Asynchronously invokes the underlying RPC.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> receiver: A ResponseReceiver to be passed the response data of the RPC.</span>
|
|
|
+<span class="sd"> abortion_callback: A callback to be called and passed an Abortion value</span>
|
|
|
+<span class="sd"> in the event of RPC abortion.</span>
|
|
|
+<span class="sd"> timeout: A duration of time in seconds to allow for the RPC.</span>
|
|
|
+<span class="sd"> metadata: A metadata value to be passed to the service-side of</span>
|
|
|
+<span class="sd"> the RPC.</span>
|
|
|
+<span class="sd"> protocol_options: A value specified by the provider of a Face interface</span>
|
|
|
+<span class="sd"> implementation affording custom state and behavior.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> A single object that is both a Call object for the RPC and a</span>
|
|
|
+<span class="sd"> stream.Consumer to which the request values of the RPC should be passed.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+
|
|
|
+</div></div>
|
|
|
+<div class="viewcode-block" id="MethodImplementation"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.MethodImplementation">[docs]</a><span class="k">class</span> <span class="nc">MethodImplementation</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""A sum type that describes a method implementation.</span>
|
|
|
+
|
|
|
+<span class="sd"> Attributes:</span>
|
|
|
+<span class="sd"> cardinality: A cardinality.Cardinality value.</span>
|
|
|
+<span class="sd"> style: A style.Service value.</span>
|
|
|
+<span class="sd"> unary_unary_inline: The implementation of the method as a callable value</span>
|
|
|
+<span class="sd"> that takes a request value and a ServicerContext object and returns a</span>
|
|
|
+<span class="sd"> response value. Only non-None if cardinality is</span>
|
|
|
+<span class="sd"> cardinality.Cardinality.UNARY_UNARY and style is style.Service.INLINE.</span>
|
|
|
+<span class="sd"> unary_stream_inline: The implementation of the method as a callable value</span>
|
|
|
+<span class="sd"> that takes a request value and a ServicerContext object and returns an</span>
|
|
|
+<span class="sd"> iterator of response values. Only non-None if cardinality is</span>
|
|
|
+<span class="sd"> cardinality.Cardinality.UNARY_STREAM and style is style.Service.INLINE.</span>
|
|
|
+<span class="sd"> stream_unary_inline: The implementation of the method as a callable value</span>
|
|
|
+<span class="sd"> that takes an iterator of request values and a ServicerContext object and</span>
|
|
|
+<span class="sd"> returns a response value. Only non-None if cardinality is</span>
|
|
|
+<span class="sd"> cardinality.Cardinality.STREAM_UNARY and style is style.Service.INLINE.</span>
|
|
|
+<span class="sd"> stream_stream_inline: The implementation of the method as a callable value</span>
|
|
|
+<span class="sd"> that takes an iterator of request values and a ServicerContext object and</span>
|
|
|
+<span class="sd"> returns an iterator of response values. Only non-None if cardinality is</span>
|
|
|
+<span class="sd"> cardinality.Cardinality.STREAM_STREAM and style is style.Service.INLINE.</span>
|
|
|
+<span class="sd"> unary_unary_event: The implementation of the method as a callable value that</span>
|
|
|
+<span class="sd"> takes a request value, a response callback to which to pass the response</span>
|
|
|
+<span class="sd"> value of the RPC, and a ServicerContext. Only non-None if cardinality is</span>
|
|
|
+<span class="sd"> cardinality.Cardinality.UNARY_UNARY and style is style.Service.EVENT.</span>
|
|
|
+<span class="sd"> unary_stream_event: The implementation of the method as a callable value</span>
|
|
|
+<span class="sd"> that takes a request value, a stream.Consumer to which to pass the</span>
|
|
|
+<span class="sd"> response values of the RPC, and a ServicerContext. Only non-None if</span>
|
|
|
+<span class="sd"> cardinality is cardinality.Cardinality.UNARY_STREAM and style is</span>
|
|
|
+<span class="sd"> style.Service.EVENT.</span>
|
|
|
+<span class="sd"> stream_unary_event: The implementation of the method as a callable value</span>
|
|
|
+<span class="sd"> that takes a response callback to which to pass the response value of the</span>
|
|
|
+<span class="sd"> RPC and a ServicerContext and returns a stream.Consumer to which the</span>
|
|
|
+<span class="sd"> request values of the RPC should be passed. Only non-None if cardinality</span>
|
|
|
+<span class="sd"> is cardinality.Cardinality.STREAM_UNARY and style is style.Service.EVENT.</span>
|
|
|
+<span class="sd"> stream_stream_event: The implementation of the method as a callable value</span>
|
|
|
+<span class="sd"> that takes a stream.Consumer to which to pass the response values of the</span>
|
|
|
+<span class="sd"> RPC and a ServicerContext and returns a stream.Consumer to which the</span>
|
|
|
+<span class="sd"> request values of the RPC should be passed. Only non-None if cardinality</span>
|
|
|
+<span class="sd"> is cardinality.Cardinality.STREAM_STREAM and style is</span>
|
|
|
+<span class="sd"> style.Service.EVENT.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="n">__metaclass__</span> <span class="o">=</span> <span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span>
|
|
|
+
|
|
|
+</div>
|
|
|
+<div class="viewcode-block" id="MultiMethodImplementation"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.MultiMethodImplementation">[docs]</a><span class="k">class</span> <span class="nc">MultiMethodImplementation</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""A general type able to service many methods."""</span>
|
|
|
+ <span class="n">__metaclass__</span> <span class="o">=</span> <span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span>
|
|
|
+
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="MultiMethodImplementation.service"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.MultiMethodImplementation.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">group</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span> <span class="n">response_consumer</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Services an RPC.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> group: The group identifier of the RPC.</span>
|
|
|
+<span class="sd"> method: The method identifier of the RPC.</span>
|
|
|
+<span class="sd"> response_consumer: A stream.Consumer to be called to accept the response</span>
|
|
|
+<span class="sd"> values of the RPC.</span>
|
|
|
+<span class="sd"> context: a ServicerContext object.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> A stream.Consumer with which to accept the request values of the RPC. The</span>
|
|
|
+<span class="sd"> consumer returned from this method may or may not be invoked to</span>
|
|
|
+<span class="sd"> completion: in the case of RPC abortion, RPC Framework will simply stop</span>
|
|
|
+<span class="sd"> passing values to this object. Implementations must not assume that this</span>
|
|
|
+<span class="sd"> object will be called to completion of the request stream or even called</span>
|
|
|
+<span class="sd"> at all.</span>
|
|
|
+
|
|
|
+<span class="sd"> Raises:</span>
|
|
|
+<span class="sd"> abandonment.Abandoned: May or may not be raised when the RPC has been</span>
|
|
|
+<span class="sd"> aborted.</span>
|
|
|
+<span class="sd"> NoSuchMethodError: If this MultiMethod does not recognize the given group</span>
|
|
|
+<span class="sd"> and name for the RPC and is not able to service the RPC.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+
|
|
|
+</div></div>
|
|
|
+<div class="viewcode-block" id="GenericStub"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.GenericStub">[docs]</a><span class="k">class</span> <span class="nc">GenericStub</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Affords RPC invocation via generic methods."""</span>
|
|
|
+ <span class="n">__metaclass__</span> <span class="o">=</span> <span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span>
|
|
|
+
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="GenericStub.blocking_unary_unary"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.GenericStub.blocking_unary_unary">[docs]</a> <span class="k">def</span> <span class="nf">blocking_unary_unary</span><span class="p">(</span>
|
|
|
+ <span class="bp">self</span><span class="p">,</span> <span class="n">group</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
|
|
|
+ <span class="n">with_call</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> <span class="n">protocol_options</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Invokes a unary-request-unary-response method.</span>
|
|
|
+
|
|
|
+<span class="sd"> This method blocks until either returning the response value of the RPC</span>
|
|
|
+<span class="sd"> (in the event of RPC completion) or raising an exception (in the event of</span>
|
|
|
+<span class="sd"> RPC abortion).</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> group: The group identifier of the RPC.</span>
|
|
|
+<span class="sd"> method: The method identifier of the RPC.</span>
|
|
|
+<span class="sd"> request: The request value for the RPC.</span>
|
|
|
+<span class="sd"> timeout: A duration of time in seconds to allow for the RPC.</span>
|
|
|
+<span class="sd"> metadata: A metadata value to be passed to the service-side of the RPC.</span>
|
|
|
+<span class="sd"> with_call: Whether or not to include return a Call for the RPC in addition</span>
|
|
|
+<span class="sd"> to the reponse.</span>
|
|
|
+<span class="sd"> protocol_options: A value specified by the provider of a Face interface</span>
|
|
|
+<span class="sd"> implementation affording custom state and behavior.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> The response value for the RPC, and a Call for the RPC if with_call was</span>
|
|
|
+<span class="sd"> set to True at invocation.</span>
|
|
|
+
|
|
|
+<span class="sd"> Raises:</span>
|
|
|
+<span class="sd"> AbortionError: Indicating that the RPC was aborted.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+</div>
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="GenericStub.future_unary_unary"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.GenericStub.future_unary_unary">[docs]</a> <span class="k">def</span> <span class="nf">future_unary_unary</span><span class="p">(</span>
|
|
|
+ <span class="bp">self</span><span class="p">,</span> <span class="n">group</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
|
|
|
+ <span class="n">protocol_options</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Invokes a unary-request-unary-response method.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> group: The group identifier of the RPC.</span>
|
|
|
+<span class="sd"> method: The method identifier of the RPC.</span>
|
|
|
+<span class="sd"> request: The request value for the RPC.</span>
|
|
|
+<span class="sd"> timeout: A duration of time in seconds to allow for the RPC.</span>
|
|
|
+<span class="sd"> metadata: A metadata value to be passed to the service-side of the RPC.</span>
|
|
|
+<span class="sd"> protocol_options: A value specified by the provider of a Face interface</span>
|
|
|
+<span class="sd"> implementation affording custom state and behavior.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> An object that is both a Call for the RPC and a future.Future. In the</span>
|
|
|
+<span class="sd"> event of RPC completion, the return Future's result value will be the</span>
|
|
|
+<span class="sd"> response value of the RPC. In the event of RPC abortion, the returned</span>
|
|
|
+<span class="sd"> Future's exception value will be an AbortionError.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+</div>
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="GenericStub.inline_unary_stream"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.GenericStub.inline_unary_stream">[docs]</a> <span class="k">def</span> <span class="nf">inline_unary_stream</span><span class="p">(</span>
|
|
|
+ <span class="bp">self</span><span class="p">,</span> <span class="n">group</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
|
|
|
+ <span class="n">protocol_options</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Invokes a unary-request-stream-response method.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> group: The group identifier of the RPC.</span>
|
|
|
+<span class="sd"> method: The method identifier of the RPC.</span>
|
|
|
+<span class="sd"> request: The request value for the RPC.</span>
|
|
|
+<span class="sd"> timeout: A duration of time in seconds to allow for the RPC.</span>
|
|
|
+<span class="sd"> metadata: A metadata value to be passed to the service-side of the RPC.</span>
|
|
|
+<span class="sd"> protocol_options: A value specified by the provider of a Face interface</span>
|
|
|
+<span class="sd"> implementation affording custom state and behavior.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> An object that is both a Call for the RPC and an iterator of response</span>
|
|
|
+<span class="sd"> values. Drawing response values from the returned iterator may raise</span>
|
|
|
+<span class="sd"> AbortionError indicating abortion of the RPC.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+</div>
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="GenericStub.blocking_stream_unary"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.GenericStub.blocking_stream_unary">[docs]</a> <span class="k">def</span> <span class="nf">blocking_stream_unary</span><span class="p">(</span>
|
|
|
+ <span class="bp">self</span><span class="p">,</span> <span class="n">group</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span> <span class="n">request_iterator</span><span class="p">,</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
|
|
|
+ <span class="n">with_call</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> <span class="n">protocol_options</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Invokes a stream-request-unary-response method.</span>
|
|
|
+
|
|
|
+<span class="sd"> This method blocks until either returning the response value of the RPC</span>
|
|
|
+<span class="sd"> (in the event of RPC completion) or raising an exception (in the event of</span>
|
|
|
+<span class="sd"> RPC abortion).</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> group: The group identifier of the RPC.</span>
|
|
|
+<span class="sd"> method: The method identifier of the RPC.</span>
|
|
|
+<span class="sd"> request_iterator: An iterator that yields request values for the RPC.</span>
|
|
|
+<span class="sd"> timeout: A duration of time in seconds to allow for the RPC.</span>
|
|
|
+<span class="sd"> metadata: A metadata value to be passed to the service-side of the RPC.</span>
|
|
|
+<span class="sd"> with_call: Whether or not to include return a Call for the RPC in addition</span>
|
|
|
+<span class="sd"> to the reponse.</span>
|
|
|
+<span class="sd"> protocol_options: A value specified by the provider of a Face interface</span>
|
|
|
+<span class="sd"> implementation affording custom state and behavior.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> The response value for the RPC, and a Call for the RPC if with_call was</span>
|
|
|
+<span class="sd"> set to True at invocation.</span>
|
|
|
+
|
|
|
+<span class="sd"> Raises:</span>
|
|
|
+<span class="sd"> AbortionError: Indicating that the RPC was aborted.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+</div>
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="GenericStub.future_stream_unary"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.GenericStub.future_stream_unary">[docs]</a> <span class="k">def</span> <span class="nf">future_stream_unary</span><span class="p">(</span>
|
|
|
+ <span class="bp">self</span><span class="p">,</span> <span class="n">group</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span> <span class="n">request_iterator</span><span class="p">,</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
|
|
|
+ <span class="n">protocol_options</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Invokes a stream-request-unary-response method.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> group: The group identifier of the RPC.</span>
|
|
|
+<span class="sd"> method: The method identifier of the RPC.</span>
|
|
|
+<span class="sd"> request_iterator: An iterator that yields request values for the RPC.</span>
|
|
|
+<span class="sd"> timeout: A duration of time in seconds to allow for the RPC.</span>
|
|
|
+<span class="sd"> metadata: A metadata value to be passed to the service-side of the RPC.</span>
|
|
|
+<span class="sd"> protocol_options: A value specified by the provider of a Face interface</span>
|
|
|
+<span class="sd"> implementation affording custom state and behavior.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> An object that is both a Call for the RPC and a future.Future. In the</span>
|
|
|
+<span class="sd"> event of RPC completion, the return Future's result value will be the</span>
|
|
|
+<span class="sd"> response value of the RPC. In the event of RPC abortion, the returned</span>
|
|
|
+<span class="sd"> Future's exception value will be an AbortionError.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+</div>
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="GenericStub.inline_stream_stream"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.GenericStub.inline_stream_stream">[docs]</a> <span class="k">def</span> <span class="nf">inline_stream_stream</span><span class="p">(</span>
|
|
|
+ <span class="bp">self</span><span class="p">,</span> <span class="n">group</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span> <span class="n">request_iterator</span><span class="p">,</span> <span class="n">timeout</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
|
|
|
+ <span class="n">protocol_options</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Invokes a stream-request-stream-response method.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> group: The group identifier of the RPC.</span>
|
|
|
+<span class="sd"> method: The method identifier of the RPC.</span>
|
|
|
+<span class="sd"> request_iterator: An iterator that yields request values for the RPC.</span>
|
|
|
+<span class="sd"> timeout: A duration of time in seconds to allow for the RPC.</span>
|
|
|
+<span class="sd"> metadata: A metadata value to be passed to the service-side of the RPC.</span>
|
|
|
+<span class="sd"> protocol_options: A value specified by the provider of a Face interface</span>
|
|
|
+<span class="sd"> implementation affording custom state and behavior.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> An object that is both a Call for the RPC and an iterator of response</span>
|
|
|
+<span class="sd"> values. Drawing response values from the returned iterator may raise</span>
|
|
|
+<span class="sd"> AbortionError indicating abortion of the RPC.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+</div>
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="GenericStub.event_unary_unary"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.GenericStub.event_unary_unary">[docs]</a> <span class="k">def</span> <span class="nf">event_unary_unary</span><span class="p">(</span>
|
|
|
+ <span class="bp">self</span><span class="p">,</span> <span class="n">group</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">receiver</span><span class="p">,</span> <span class="n">abortion_callback</span><span class="p">,</span> <span class="n">timeout</span><span class="p">,</span>
|
|
|
+ <span class="n">metadata</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">protocol_options</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Event-driven invocation of a unary-request-unary-response method.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> group: The group identifier of the RPC.</span>
|
|
|
+<span class="sd"> method: The method identifier of the RPC.</span>
|
|
|
+<span class="sd"> request: The request value for the RPC.</span>
|
|
|
+<span class="sd"> receiver: A ResponseReceiver to be passed the response data of the RPC.</span>
|
|
|
+<span class="sd"> abortion_callback: A callback to be called and passed an Abortion value</span>
|
|
|
+<span class="sd"> in the event of RPC abortion.</span>
|
|
|
+<span class="sd"> timeout: A duration of time in seconds to allow for the RPC.</span>
|
|
|
+<span class="sd"> metadata: A metadata value to be passed to the service-side of the RPC.</span>
|
|
|
+<span class="sd"> protocol_options: A value specified by the provider of a Face interface</span>
|
|
|
+<span class="sd"> implementation affording custom state and behavior.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> A Call for the RPC.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+</div>
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="GenericStub.event_unary_stream"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.GenericStub.event_unary_stream">[docs]</a> <span class="k">def</span> <span class="nf">event_unary_stream</span><span class="p">(</span>
|
|
|
+ <span class="bp">self</span><span class="p">,</span> <span class="n">group</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span> <span class="n">request</span><span class="p">,</span> <span class="n">receiver</span><span class="p">,</span> <span class="n">abortion_callback</span><span class="p">,</span> <span class="n">timeout</span><span class="p">,</span>
|
|
|
+ <span class="n">metadata</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">protocol_options</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Event-driven invocation of a unary-request-stream-response method.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> group: The group identifier of the RPC.</span>
|
|
|
+<span class="sd"> method: The method identifier of the RPC.</span>
|
|
|
+<span class="sd"> request: The request value for the RPC.</span>
|
|
|
+<span class="sd"> receiver: A ResponseReceiver to be passed the response data of the RPC.</span>
|
|
|
+<span class="sd"> abortion_callback: A callback to be called and passed an Abortion value</span>
|
|
|
+<span class="sd"> in the event of RPC abortion.</span>
|
|
|
+<span class="sd"> timeout: A duration of time in seconds to allow for the RPC.</span>
|
|
|
+<span class="sd"> metadata: A metadata value to be passed to the service-side of the RPC.</span>
|
|
|
+<span class="sd"> protocol_options: A value specified by the provider of a Face interface</span>
|
|
|
+<span class="sd"> implementation affording custom state and behavior.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> A Call for the RPC.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+</div>
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="GenericStub.event_stream_unary"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.GenericStub.event_stream_unary">[docs]</a> <span class="k">def</span> <span class="nf">event_stream_unary</span><span class="p">(</span>
|
|
|
+ <span class="bp">self</span><span class="p">,</span> <span class="n">group</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span> <span class="n">receiver</span><span class="p">,</span> <span class="n">abortion_callback</span><span class="p">,</span> <span class="n">timeout</span><span class="p">,</span>
|
|
|
+ <span class="n">metadata</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">protocol_options</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Event-driven invocation of a unary-request-unary-response method.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> group: The group identifier of the RPC.</span>
|
|
|
+<span class="sd"> method: The method identifier of the RPC.</span>
|
|
|
+<span class="sd"> receiver: A ResponseReceiver to be passed the response data of the RPC.</span>
|
|
|
+<span class="sd"> abortion_callback: A callback to be called and passed an Abortion value</span>
|
|
|
+<span class="sd"> in the event of RPC abortion.</span>
|
|
|
+<span class="sd"> timeout: A duration of time in seconds to allow for the RPC.</span>
|
|
|
+<span class="sd"> metadata: A metadata value to be passed to the service-side of the RPC.</span>
|
|
|
+<span class="sd"> protocol_options: A value specified by the provider of a Face interface</span>
|
|
|
+<span class="sd"> implementation affording custom state and behavior.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> A pair of a Call object for the RPC and a stream.Consumer to which the</span>
|
|
|
+<span class="sd"> request values of the RPC should be passed.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+</div>
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="GenericStub.event_stream_stream"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.GenericStub.event_stream_stream">[docs]</a> <span class="k">def</span> <span class="nf">event_stream_stream</span><span class="p">(</span>
|
|
|
+ <span class="bp">self</span><span class="p">,</span> <span class="n">group</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span> <span class="n">receiver</span><span class="p">,</span> <span class="n">abortion_callback</span><span class="p">,</span> <span class="n">timeout</span><span class="p">,</span>
|
|
|
+ <span class="n">metadata</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">protocol_options</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Event-driven invocation of a unary-request-stream-response method.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> group: The group identifier of the RPC.</span>
|
|
|
+<span class="sd"> method: The method identifier of the RPC.</span>
|
|
|
+<span class="sd"> receiver: A ResponseReceiver to be passed the response data of the RPC.</span>
|
|
|
+<span class="sd"> abortion_callback: A callback to be called and passed an Abortion value</span>
|
|
|
+<span class="sd"> in the event of RPC abortion.</span>
|
|
|
+<span class="sd"> timeout: A duration of time in seconds to allow for the RPC.</span>
|
|
|
+<span class="sd"> metadata: A metadata value to be passed to the service-side of the RPC.</span>
|
|
|
+<span class="sd"> protocol_options: A value specified by the provider of a Face interface</span>
|
|
|
+<span class="sd"> implementation affording custom state and behavior.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> A pair of a Call object for the RPC and a stream.Consumer to which the</span>
|
|
|
+<span class="sd"> request values of the RPC should be passed.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+</div>
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="GenericStub.unary_unary"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.GenericStub.unary_unary">[docs]</a> <span class="k">def</span> <span class="nf">unary_unary</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">group</span><span class="p">,</span> <span class="n">method</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Creates a UnaryUnaryMultiCallable for a unary-unary method.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> group: The group identifier of the RPC.</span>
|
|
|
+<span class="sd"> method: The method identifier of the RPC.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> A UnaryUnaryMultiCallable value for the named unary-unary method.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+</div>
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="GenericStub.unary_stream"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.GenericStub.unary_stream">[docs]</a> <span class="k">def</span> <span class="nf">unary_stream</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">group</span><span class="p">,</span> <span class="n">method</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Creates a UnaryStreamMultiCallable for a unary-stream method.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> group: The group identifier of the RPC.</span>
|
|
|
+<span class="sd"> method: The method identifier of the RPC.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> A UnaryStreamMultiCallable value for the name unary-stream method.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+</div>
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="GenericStub.stream_unary"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.GenericStub.stream_unary">[docs]</a> <span class="k">def</span> <span class="nf">stream_unary</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">group</span><span class="p">,</span> <span class="n">method</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Creates a StreamUnaryMultiCallable for a stream-unary method.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> group: The group identifier of the RPC.</span>
|
|
|
+<span class="sd"> method: The method identifier of the RPC.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> A StreamUnaryMultiCallable value for the named stream-unary method.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+</div>
|
|
|
+ <span class="nd">@abc.abstractmethod</span>
|
|
|
+<div class="viewcode-block" id="GenericStub.stream_stream"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.GenericStub.stream_stream">[docs]</a> <span class="k">def</span> <span class="nf">stream_stream</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">group</span><span class="p">,</span> <span class="n">method</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Creates a StreamStreamMultiCallable for a stream-stream method.</span>
|
|
|
+
|
|
|
+<span class="sd"> Args:</span>
|
|
|
+<span class="sd"> group: The group identifier of the RPC.</span>
|
|
|
+<span class="sd"> method: The method identifier of the RPC.</span>
|
|
|
+
|
|
|
+<span class="sd"> Returns:</span>
|
|
|
+<span class="sd"> A StreamStreamMultiCallable value for the named stream-stream method.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span>
|
|
|
+
|
|
|
+</div></div>
|
|
|
+<div class="viewcode-block" id="DynamicStub"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.face.html#grpc.framework.interfaces.face.face.DynamicStub">[docs]</a><span class="k">class</span> <span class="nc">DynamicStub</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
|
+ <span class="sd">"""Affords RPC invocation via attributes corresponding to afforded methods.</span>
|
|
|
+
|
|
|
+<span class="sd"> Instances of this type may be scoped to a single group so that attribute</span>
|
|
|
+<span class="sd"> access is unambiguous.</span>
|
|
|
+
|
|
|
+<span class="sd"> Instances of this type respond to attribute access as follows: if the</span>
|
|
|
+<span class="sd"> requested attribute is the name of a unary-unary method, the value of the</span>
|
|
|
+<span class="sd"> attribute will be a UnaryUnaryMultiCallable with which to invoke an RPC; if</span>
|
|
|
+<span class="sd"> the requested attribute is the name of a unary-stream method, the value of the</span>
|
|
|
+<span class="sd"> attribute will be a UnaryStreamMultiCallable with which to invoke an RPC; if</span>
|
|
|
+<span class="sd"> the requested attribute is the name of a stream-unary method, the value of the</span>
|
|
|
+<span class="sd"> attribute will be a StreamUnaryMultiCallable with which to invoke an RPC; and</span>
|
|
|
+<span class="sd"> if the requested attribute is the name of a stream-stream method, the value of</span>
|
|
|
+<span class="sd"> the attribute will be a StreamStreamMultiCallable with which to invoke an RPC.</span>
|
|
|
+<span class="sd"> """</span>
|
|
|
+ <span class="n">__metaclass__</span> <span class="o">=</span> <span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span></div>
|
|
|
+</pre></div>
|
|
|
+
|
|
|
+ </div>
|
|
|
+ <footer>
|
|
|
+
|
|
|
+
|
|
|
+ <hr/>
|
|
|
+
|
|
|
+ <div role="contentinfo">
|
|
|
+ <p>
|
|
|
+ © Copyright 2015, Author.
|
|
|
+ </p>
|
|
|
+ </div>
|
|
|
+ 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>.
|
|
|
+
|
|
|
+</footer>
|
|
|
+
|
|
|
+ </div>
|
|
|
+ </div>
|
|
|
+
|
|
|
+ </section>
|
|
|
+
|
|
|
+ </div>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <script type="text/javascript">
|
|
|
+ var DOCUMENTATION_OPTIONS = {
|
|
|
+ URL_ROOT:'../../../../../',
|
|
|
+ VERSION:'0.11.0b0',
|
|
|
+ COLLAPSE_INDEX:false,
|
|
|
+ FILE_SUFFIX:'.html',
|
|
|
+ HAS_SOURCE: true
|
|
|
+ };
|
|
|
+ </script>
|
|
|
+ <script type="text/javascript" src="../../../../../_static/jquery.js"></script>
|
|
|
+ <script type="text/javascript" src="../../../../../_static/underscore.js"></script>
|
|
|
+ <script type="text/javascript" src="../../../../../_static/doctools.js"></script>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <script type="text/javascript" src="../../../../../_static/js/theme.js"></script>
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+ <script type="text/javascript">
|
|
|
+ jQuery(function () {
|
|
|
+ SphinxRtdTheme.StickyNav.enable();
|
|
|
+ });
|
|
|
+ </script>
|
|
|
+
|
|
|
+
|
|
|
+</body>
|
|
|
+</html>
|