- <span class="n">logging</span><span class="o">.</span><span class="n">exception</span><span class="p">(</span><span class="s">'Unexpected exception from task run in logging pool!'</span><span class="p">)</span>
<span id="grpc-beta-implementations-module"></span><h2>grpc.beta.implementations module<a class="headerlink" href="#module-grpc.beta.implementations" title="Permalink to this headline">¶</a></h2>
<span id="grpc-beta-implementations-module"></span><h2>grpc.beta.implementations module<a class="headerlink" href="#module-grpc.beta.implementations" title="Permalink to this headline">¶</a></h2>
<p>Entry points into the Beta API of gRPC Python.</p>
<p>Entry points into the Beta API of gRPC Python.</p>
+<li><strong>call_credentials</strong> – A CallCredentials object.</li>
+<li><strong>additional_call_credentials</strong> – Another CallCredentials object to compose on
+top of call_credentials.</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A CallCredentials object for use in a GRPCCallOptions object.</p>
+<li><strong>channel_credentials</strong> – A ChannelCredentials object.</li>
+<li><strong>additional_call_credentials</strong> – A CallCredentials object to compose on
+top of channel_credentials.</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A ChannelCredentials object for use in a GRPCCallOptions object.</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
<dl class="function">
<dl class="function">
<dt id="grpc.beta.implementations.dynamic_stub">
<dt id="grpc.beta.implementations.dynamic_stub">
<code class="descclassname">grpc.beta.implementations.</code><code class="descname">dynamic_stub</code><span class="sig-paren">(</span><em>channel</em>, <em>service</em>, <em>cardinalities</em>, <em>options=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/beta/implementations.html#dynamic_stub"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.beta.implementations.dynamic_stub" title="Permalink to this definition">¶</a></dt>
<code class="descclassname">grpc.beta.implementations.</code><code class="descname">dynamic_stub</code><span class="sig-paren">(</span><em>channel</em>, <em>service</em>, <em>cardinalities</em>, <em>options=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/beta/implementations.html#dynamic_stub"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.beta.implementations.dynamic_stub" title="Permalink to this definition">¶</a></dt>
@@ -310,9 +366,26 @@ of the returned face.DynamicStub.</li>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>metadata_plugin</strong> – An interfaces.GRPCAuthMetadataPlugin to use in constructing
+the CallCredentials object.</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A CallCredentials object for use in a GRPCCallOptions object.</td>
@@ -408,7 +481,7 @@ certificate chain should be used.</li>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A ClientCredentials for use with an SSL-enabled Channel.</p>
+<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A ChannelCredentials for use with an SSL-enabled Channel.</p>
</td>
</td>
</tr>
</tr>
</tbody>
</tbody>
@@ -514,6 +587,63 @@ recover.</p>
<dd><p>The channel has seen a failure from which it cannot recover.</p>
<dd><p>The channel has seen a failure from which it cannot recover.</p>
+<code class="descname">service_url</code><a class="headerlink" href="#grpc.beta.interfaces.GRPCAuthMetadataContext.service_url" title="Permalink to this definition">¶</a></dt>
+<dd><p>A string URL of the service being called into.</p>
+<code class="descname">method_name</code><a class="headerlink" href="#grpc.beta.interfaces.GRPCAuthMetadataContext.method_name" title="Permalink to this definition">¶</a></dt>
+<dd><p>A string of the fully qualified method name being called.</p>
+<p>Callback object received by a metadata plugin.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dl class="class">
@@ -583,10 +713,13 @@ called.</p>
<tbody valign="top">
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>address</strong> – The address for which to open a port.</td>
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>address</strong> – The address for which to open a port.</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">An integer port on which RPCs will be serviced after this link has been
-started. This is typically the same number as the port number contained
+<dt>An integer port on which RPCs will be serviced after this link has been</dt>
+<dd>started. This is typically the same number as the port number contained
in the passed address, but will likely be different if the port number
in the passed address, but will likely be different if the port number
-contained in the passed address was zero.</td>
+contained in the passed address was zero.</dd>
+</dl>
+</td>
</tr>
</tr>
</tbody>
</tbody>
</table>
</table>
@@ -608,10 +741,14 @@ called.</p>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">An integer port on which RPCs will be serviced after this link has been
-started. This is typically the same number as the port number contained
+<code class="descname">UNKNOWN</code><em class="property"> = <StatusCode.UNKNOWN: 2></em><a class="headerlink" href="#grpc.beta.interfaces.StatusCode.UNKNOWN" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
</dd></dl>
</dd></dl>
<dl class="function">
<dl class="function">
@@ -679,7 +901,7 @@ very early in the grace period).</td>
<li><strong>disable_compression</strong> – A boolean indicating whether or not compression should
<li><strong>disable_compression</strong> – A boolean indicating whether or not compression should
be disabled for the request object of the RPC. Only valid for
be disabled for the request object of the RPC. Only valid for
request-unary RPCs.</li>
request-unary RPCs.</li>
-<li><strong>credentials</strong> – A ClientCredentials object to use for the invoked RPC.</li>
+<li><strong>credentials</strong> – A CallCredentials object to use for the invoked RPC.</li>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
@@ -705,8 +927,11 @@ subscription to the given implementations.Channel’s connectivity.</p>
<tbody valign="top">
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>channel</strong> – An implementations.Channel.</td>
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>channel</strong> – An implementations.Channel.</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A future.Future that matures when the given Channel has connectivity
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>request</strong> – A request value appropriate for the RPC method described by this
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>request</strong> – A request value appropriate for the RPC method described by this
RpcMethodInvocationDescription.</td>
RpcMethodInvocationDescription.</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The serialization of the given request value as a
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>response</strong> – A response value appropriate for the RPC method described by
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>response</strong> – A response value appropriate for the RPC method described by
this RpcMethodServiceDescription.</td>
this RpcMethodServiceDescription.</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">The serialization of the given response value as a
+<dt>The serialization of the given response value as a</dt>
+<dd>bytestring.</dd>
+</dl>
+</td>
</tr>
</tr>
</tbody>
</tbody>
</table>
</table>
@@ -374,8 +422,11 @@ method described by this RpcMethodServiceDescription.</li>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Yields:</th><td class="field-body"><p class="first last">Zero or more response values appropriate for the RPC method described by
-this RpcMethodServiceDescription.</p>
+<tr class="field-even field"><th class="field-name">Yields:</th><td class="field-body"><dl class="first last docutils">
+<dt>Zero or more response values appropriate for the RPC method described by</dt>
@@ -399,8 +450,12 @@ method described by this RpcMethodServiceDescription.</li>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A response value appropriate for the RPC method described by this
-<tr class="field-even field"><th class="field-name">Yields:</th><td class="field-body"><p class="first last">Zero or more response values appropriate for the RPC method described by
-this RpcMethodServiceDescription.</p>
+<tr class="field-even field"><th class="field-name">Yields:</th><td class="field-body"><dl class="first last docutils">
+<dt>Zero or more response values appropriate for the RPC method described by</dt>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A response value appropriate for the RPC method described by this
<code class="descname">async</code><span class="sig-paren">(</span><em>request_iterator</em>, <em>timeout</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/alpha/interfaces.html#StreamUnarySyncAsync.async"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.alpha.interfaces.StreamUnarySyncAsync.async" title="Permalink to this definition">¶</a></dt>
<code class="descname">async</code><span class="sig-paren">(</span><em>request_iterator</em>, <em>timeout</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/alpha/interfaces.html#StreamUnarySyncAsync.async"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.alpha.interfaces.StreamUnarySyncAsync.async" title="Permalink to this definition">¶</a></dt>
@@ -531,10 +568,14 @@ Indicating that the RPC was aborted.</p>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A future.Future representing the RPC. In the event of RPC completion, the
-returned Future’s result value will be the response value of the RPC.
<code class="descname">async</code><span class="sig-paren">(</span><em>request</em>, <em>timeout</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/alpha/interfaces.html#UnaryUnarySyncAsync.async"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.alpha.interfaces.UnaryUnarySyncAsync.async" title="Permalink to this definition">¶</a></dt>
<code class="descname">async</code><span class="sig-paren">(</span><em>request</em>, <em>timeout</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/alpha/interfaces.html#UnaryUnarySyncAsync.async"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.alpha.interfaces.UnaryUnarySyncAsync.async" title="Permalink to this definition">¶</a></dt>
@@ -608,10 +630,13 @@ Indicating that the RPC was aborted.</td>
<col class="field-name" />
<col class="field-name" />
<col class="field-body" />
<col class="field-body" />
<tbody valign="top">
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">A future.Future representing the RPC. In the event of RPC completion, the
-returned Future’s result value will be the response value of the RPC.
+<dt>A future.Future representing the RPC. In the event of RPC completion, the</dt>
+<dd>returned Future’s result value will be the response value of the RPC.
In the event of RPC abortion, the returned Future’s exception value
In the event of RPC abortion, the returned Future’s exception value
-will be an exceptions.RpcError.</td>
+will be an exceptions.RpcError.</dd>
+</dl>
+</td>
</tr>
</tr>
</tbody>
</tbody>
</table>
</table>
@@ -640,9 +665,13 @@ that bytestring.</li>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">An interfaces.RpcMethodInvocationDescription constructed from the given
-arguments representing a streaming-request/streaming-response RPC
+<dt>An interfaces.RpcMethodInvocationDescription constructed from the given</dt>
+<dd><p class="first last">arguments representing a streaming-request/streaming-response RPC
method.</p>
method.</p>
+</dd>
+</dl>
+</p>
</td>
</td>
</tr>
</tr>
</tbody>
</tbody>
@@ -671,9 +700,13 @@ that value.</li>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">An interfaces.RpcMethodServiceDescription constructed from the given
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">An interfaces.RpcMethodInvocationDescription constructed from the given
-arguments representing a streaming-request/unary-response RPC method.</p>
+<dt>An interfaces.RpcMethodInvocationDescription constructed from the given</dt>
+<dd><p class="first last">arguments representing a streaming-request/unary-response RPC method.</p>
+</dd>
+</dl>
+</p>
</td>
</td>
</tr>
</tr>
</tbody>
</tbody>
@@ -726,9 +763,13 @@ that value.</li>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">An interfaces.RpcMethodServiceDescription constructed from the given
-arguments representing a streaming-request/unary-response
+<dt>An interfaces.RpcMethodServiceDescription constructed from the given</dt>
+<dd><p class="first last">arguments representing a streaming-request/unary-response
RPC method.</p>
RPC method.</p>
+</dd>
+</dl>
+</p>
</td>
</td>
</tr>
</tr>
</tbody>
</tbody>
@@ -752,8 +793,12 @@ that bytestring.</li>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">An interfaces.RpcMethodInvocationDescription constructed from the given
-arguments representing a unary-request/streaming-response RPC method.</p>
+<dt>An interfaces.RpcMethodInvocationDescription constructed from the given</dt>
+<dd><p class="first last">arguments representing a unary-request/streaming-response RPC method.</p>
+</dd>
+</dl>
+</p>
</td>
</td>
</tr>
</tr>
</tbody>
</tbody>
@@ -781,9 +826,13 @@ that value.</li>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">An interfaces.RpcMethodServiceDescription constructed from the given
-arguments representing a unary-request/streaming-response
+<dt>An interfaces.RpcMethodServiceDescription constructed from the given</dt>
+<dd><p class="first last">arguments representing a unary-request/streaming-response
RPC method.</p>
RPC method.</p>
+</dd>
+</dl>
+</p>
</td>
</td>
</tr>
</tr>
</tbody>
</tbody>
@@ -807,8 +856,12 @@ that bytestring.</li>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">An interfaces.RpcMethodInvocationDescription constructed from the given
-arguments representing a unary-request/unary-response RPC method.</p>
+<dt>An interfaces.RpcMethodInvocationDescription constructed from the given</dt>
+<dd><p class="first last">arguments representing a unary-request/unary-response RPC method.</p>
+</dd>
+</dl>
+</p>
</td>
</td>
</tr>
</tr>
</tbody>
</tbody>
@@ -836,9 +889,13 @@ that value.</li>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">An interfaces.RpcMethodServiceDescription constructed from the given
-arguments representing a unary-request/unary-response RPC
+<code class="descname">TRANSMISSION_FAILURE</code><em class="property"> = <Kind.TRANSMISSION_FAILURE: 'transmission failure'></em><a class="headerlink" href="#grpc.framework.base.interfaces.BackToFrontTicket.Kind.TRANSMISSION_FAILURE" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
</dd></dl>
</dd></dl>
</dd></dl>
</dd></dl>
@@ -342,8 +382,11 @@ otherwise.</p>
<col class="field-name" />
<col class="field-name" />
<col class="field-body" />
<col class="field-body" />
<tbody valign="top">
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">A dictionary from Outcome value to an integer identifying the number
-of operations that terminated with that outcome.</td>
+<dt>A dictionary from Outcome value to an integer identifying the number</dt>
+<dd>of operations that terminated with that outcome.</dd>
+</dl>
+</td>
</tr>
</tr>
</tbody>
</tbody>
</table>
</table>
@@ -403,8 +446,12 @@ this operation belongs.</li>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">An Operation object affording information and action about the operation
+<code class="descname">TRANSMISSION_FAILURE</code><em class="property"> = <Outcome.TRANSMISSION_FAILURE: 'transmission failure'></em><a class="headerlink" href="#grpc.framework.base.interfaces.Outcome.TRANSMISSION_FAILURE" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
</dd></dl>
</dd></dl>
<dl class="class">
<dl class="class">
@@ -637,11 +769,13 @@ timed out.</td>
<tbody valign="top">
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>operation_context</strong> – An OperationContext object for the current operation.</td>
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>operation_context</strong> – An OperationContext object for the current operation.</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A stream.Consumer to which the results of the current operation will be
+<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><code class="xref py py-exc docutils literal"><span class="pre">abandonment.Abandoned</span></code> – If the operation has been aborted and there no
longer is any reason to service the operation.</td>
longer is any reason to service the operation.</td>
</tr>
</tr>
</tbody>
</tbody>
@@ -673,6 +807,21 @@ be None if kind is Kind.TERMINATION_ONLY or Kind.NONE.</p>
<em class="property">class </em><code class="descname">Kind</code><a class="reference internal" href="_modules/grpc/framework/base/interfaces.html#ServicedSubscription.Kind"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.interfaces.ServicedSubscription.Kind" title="Permalink to this definition">¶</a></dt>
<em class="property">class </em><code class="descname">Kind</code><a class="reference internal" href="_modules/grpc/framework/base/interfaces.html#ServicedSubscription.Kind"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.interfaces.ServicedSubscription.Kind" title="Permalink to this definition">¶</a></dt>
+<li><code class="xref py py-exc docutils literal"><span class="pre">exceptions.NoSuchMethodError</span></code> – If this Servicer affords no method with the
+<li><code class="xref py py-exc docutils literal"><span class="pre">abandonment.Abandoned</span></code> – If the operation has been aborted and there no
longer is any reason to service the operation.</li>
longer is any reason to service the operation.</li>
</ul>
</ul>
</td>
</td>
@@ -736,8 +883,11 @@ longer is any reason to service the operation.</li>
<tbody valign="top">
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ingestor</strong> – An interfaces.ServicedIngestor.</td>
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ingestor</strong> – An interfaces.ServicedIngestor.</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">An interfaces.ServicedSubscription object indicating a full
+<dt>An interfaces.ServicedSubscription object indicating a full</dt>
+<dd>subscription.</dd>
+</dl>
+</td>
</tr>
</tr>
</tbody>
</tbody>
</table>
</table>
@@ -751,9 +901,12 @@ subscription.</td>
<col class="field-name" />
<col class="field-name" />
<col class="field-body" />
<col class="field-body" />
<tbody valign="top">
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">An interfaces.ServicedSubscription indicating no subscription to an
-operation’s results (such as would be the case for a fire-and-forget
-<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">An object that is both a base.End and a links.Link, that supports operation
-invocation, and that translates operation invocation into ticket exchange.</td>
+<dt>An object that is both a base.End and a links.Link, that supports operation</dt>
+<dd>invocation, and that translates operation invocation into ticket exchange.</dd>
+</dl>
+</td>
</tr>
</tr>
</tbody>
</tbody>
</table>
</table>
@@ -185,8 +188,12 @@ time alloted for a single operation.</li>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">An object that is both a base.End and a links.Link and that services
-operations that arrive at it through ticket exchange.</p>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">An interfaces.DynamicStub that performs RPCs via the given
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">An interfaces.GenericStub that performs RPCs via the given
+<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><code class="xref py py-exc docutils literal"><span class="pre">exceptions.RpcError</span></code> – Indicating that the RPC was aborted.</p>
</td>
</td>
</tr>
</tr>
</tbody>
</tbody>
@@ -483,8 +508,12 @@ in the event of RPC abortion.</li>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A pair of a Call object for the RPC and a stream.Consumer to which the
+<dt>A pair of a Call object for the RPC and a stream.Consumer to which the</dt>
+<dd><p class="first last">request values of the RPC should be passed.</p>
+</dd>
+</dl>
+</p>
</td>
</td>
</tr>
</tr>
</tbody>
</tbody>
@@ -509,8 +538,12 @@ in the event of RPC abortion.</li>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A pair of a Call object for the RPC and a stream.Consumer to which the
+<dt>A pair of a Call object for the RPC and a stream.Consumer to which the</dt>
+<dd><p class="first last">request values of the RPC should be passed.</p>
+</dd>
+</dl>
+</p>
</td>
</td>
</tr>
</tr>
</tbody>
</tbody>
@@ -584,11 +617,15 @@ in the event of RPC abortion.</li>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A future.Future representing the RPC. In the event of RPC completion, the
-returned Future will return an outcome indicating that the RPC returned
+<dt>A future.Future representing the RPC. In the event of RPC completion, the</dt>
+<dd><p class="first last">returned Future will return an outcome indicating that the RPC returned
the response value of the RPC. In the event of RPC abortion, the
the response value of the RPC. In the event of RPC abortion, the
returned Future will return an outcome indicating that the RPC raised
returned Future will return an outcome indicating that the RPC raised
an exceptions.RpcError.</p>
an exceptions.RpcError.</p>
+</dd>
+</dl>
+</p>
</td>
</td>
</tr>
</tr>
</tbody>
</tbody>
@@ -610,11 +647,15 @@ an exceptions.RpcError.</p>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A future.Future representing the RPC. In the event of RPC completion, the
-returned Future will return an outcome indicating that the RPC returned
+<dt>A future.Future representing the RPC. In the event of RPC completion, the</dt>
+<dd><p class="first last">returned Future will return an outcome indicating that the RPC returned
the response value of the RPC. In the event of RPC abortion, the
the response value of the RPC. In the event of RPC abortion, the
returned Future will return an outcome indicating that the RPC raised
returned Future will return an outcome indicating that the RPC raised
an exceptions.RpcError.</p>
an exceptions.RpcError.</p>
+</dd>
+</dl>
+</p>
</td>
</td>
</tr>
</tr>
</tbody>
</tbody>
@@ -636,10 +677,14 @@ an exceptions.RpcError.</p>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A CancellableIterator that yields the response values of the RPC and
-affords RPC cancellation. Drawing response values from the returned
+<dt>A CancellableIterator that yields the response values of the RPC and</dt>
+<dd><p class="first last">affords RPC cancellation. Drawing response values from the returned
CancellableIterator may raise exceptions.RpcError indicating abortion of
CancellableIterator may raise exceptions.RpcError indicating abortion of
the RPC.</p>
the RPC.</p>
+</dd>
+</dl>
+</p>
</td>
</td>
</tr>
</tr>
</tbody>
</tbody>
@@ -661,10 +706,14 @@ the RPC.</p>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A CancellableIterator that yields the response values of the RPC and
-affords RPC cancellation. Drawing response values from the returned
+<dt>A CancellableIterator that yields the response values of the RPC and</dt>
+<dd><p class="first last">affords RPC cancellation. Drawing response values from the returned
CancellableIterator may raise exceptions.RpcError indicating abortion of
CancellableIterator may raise exceptions.RpcError indicating abortion of
the RPC.</p>
the RPC.</p>
+</dd>
+</dl>
+</p>
</td>
</td>
</tr>
</tr>
</tbody>
</tbody>
@@ -855,20 +904,22 @@ values of the RPC.</li>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">A stream.Consumer with which to accept the request values of the RPC. The
-consumer returned from this method may or may not be invoked to
+<li><code class="xref py py-exc docutils literal"><span class="pre">abandonment.Abandoned</span></code> – May or may not be raised when the RPC has been
+<li><code class="xref py py-exc docutils literal"><span class="pre">exceptions.NoSuchMethodError</span></code> – If this MultiMethod does not recognize the
given RPC method name and is not able to service the RPC.</li>
given RPC method name and is not able to service the RPC.</li>
</ul>
</ul>
</td>
</td>
@@ -928,30 +979,6 @@ out.</td>
<em class="property">class </em><code class="descclassname">grpc.framework.face.interfaces.</code><code class="descname">StreamStreamMultiCallable</code><a class="reference internal" href="_modules/grpc/framework/face/interfaces.html#StreamStreamMultiCallable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.face.interfaces.StreamStreamMultiCallable" title="Permalink to this definition">¶</a></dt>
<em class="property">class </em><code class="descclassname">grpc.framework.face.interfaces.</code><code class="descname">StreamStreamMultiCallable</code><a class="reference internal" href="_modules/grpc/framework/face/interfaces.html#StreamStreamMultiCallable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.face.interfaces.StreamStreamMultiCallable" title="Permalink to this definition">¶</a></dt>
-<li><strong>request_iterator</strong> – An iterator that yields request values for the RPC.</li>
-<li><strong>timeout</strong> – A duration of time in seconds to allow for the RPC.</li>
-</ul>
-</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A CancellableIterator that yields the response values of the RPC and
-affords RPC cancellation. Drawing response values from the returned
-CancellableIterator may raise exceptions.RpcError indicating abortion
<code class="descname">event</code><span class="sig-paren">(</span><em>response_callback</em>, <em>abortion_callback</em>, <em>timeout</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/face/interfaces.html#StreamUnaryMultiCallable.event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.face.interfaces.StreamUnaryMultiCallable.event" title="Permalink to this definition">¶</a></dt>
<code class="descname">event</code><span class="sig-paren">(</span><em>response_callback</em>, <em>abortion_callback</em>, <em>timeout</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/face/interfaces.html#StreamUnaryMultiCallable.event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.face.interfaces.StreamUnaryMultiCallable.event" title="Permalink to this definition">¶</a></dt>
@@ -1029,8 +1031,12 @@ in the event of RPC abortion.</li>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A pair of a Call object for the RPC and a stream.Consumer to which the
+<dt>A pair of a Call object for the RPC and a stream.Consumer to which the</dt>
+<dd><p class="first last">request values of the RPC should be passed.</p>
+</dd>
+</dl>
+</p>
</td>
</td>
</tr>
</tr>
</tbody>
</tbody>
@@ -1051,10 +1057,14 @@ request values of the RPC should be passed.</p>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A future.Future representing the RPC. In the event of RPC completion, the
-returned Future’s result value will be the response value of the RPC.
-<li><strong>request</strong> – The request value for the RPC.</li>
-<li><strong>timeout</strong> – A duration of time in seconds to allow for the RPC.</li>
-</ul>
-</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A CancellableIterator that yields the response values of the RPC and
-affords RPC cancellation. Drawing response values from the returned
-CancellableIterator may raise exceptions.RpcError indicating abortion
<code class="descname">event</code><span class="sig-paren">(</span><em>request</em>, <em>response_callback</em>, <em>abortion_callback</em>, <em>timeout</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/face/interfaces.html#UnaryUnaryMultiCallable.event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.face.interfaces.UnaryUnaryMultiCallable.event" title="Permalink to this definition">¶</a></dt>
<code class="descname">event</code><span class="sig-paren">(</span><em>request</em>, <em>response_callback</em>, <em>abortion_callback</em>, <em>timeout</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/face/interfaces.html#UnaryUnaryMultiCallable.event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.face.interfaces.UnaryUnaryMultiCallable.event" title="Permalink to this definition">¶</a></dt>
@@ -1188,10 +1149,14 @@ in the event of RPC abortion.</li>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A future.Future representing the RPC. In the event of RPC completion, the
-returned Future’s result value will be the response value of the RPC.
+<code class="descname">RAISED</code><em class="property"> = <Kind.RAISED: <object object at 0x7f788b900e40>></em><a class="headerlink" href="#grpc.framework.foundation.callable_util.Outcome.Kind.RAISED" title="Permalink to this definition">¶</a></dt>
+<code class="descname">RETURNED</code><em class="property"> = <Kind.RETURNED: <object object at 0x7f788b900e30>></em><a class="headerlink" href="#grpc.framework.foundation.callable_util.Outcome.Kind.RETURNED" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
</dd></dl>
</dd></dl>
</dd></dl>
</dd></dl>
@@ -262,8 +260,12 @@ Kind.RAISED.</p>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">An Outcome describing whether the given behavior returned a value or raised
+<dt>An Outcome describing whether the given behavior returned a value or raised</dt>
+<dd><p class="first last">an exception.</p>
+</dd>
+</dl>
+</p>
</td>
</td>
</tr>
</tr>
</tbody>
</tbody>
@@ -284,10 +286,14 @@ an exception.</p>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A callable that when executed invokes the given behavior. The returned
-callable takes the same arguments as the given behavior but returns a
+<dt>A callable that when executed invokes the given behavior. The returned</dt>
+<dd><p class="first last">callable takes the same arguments as the given behavior but returns a
future.Outcome describing whether the given behavior returned a value or
future.Outcome describing whether the given behavior returned a value or
raised an exception.</p>
raised an exception.</p>
+</dd>
+</dl>
+</p>
</td>
</td>
</tr>
</tr>
</tbody>
</tbody>
@@ -353,13 +359,16 @@ immediately.</p>
<col class="field-name" />
<col class="field-name" />
<col class="field-body" />
<col class="field-body" />
<tbody valign="top">
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if the computation has not yet begun, will not be allowed to take
-place, and determination of both was possible without blocking. False
+<dt>True if the computation has not yet begun, will not be allowed to take</dt>
+<dd>place, and determination of both was possible without blocking. False
under all other circumstances including but not limited to the
under all other circumstances including but not limited to the
computation’s already having begun, the computation’s already having
computation’s already having begun, the computation’s already having
finished, and the computation’s having been scheduled for execution on a
finished, and the computation’s having been scheduled for execution on a
remote system for which a determination of whether or not it commenced
remote system for which a determination of whether or not it commenced
-before being cancelled cannot be made without blocking.</td>
+before being cancelled cannot be made without blocking.</dd>
+</dl>
+</td>
</tr>
</tr>
</tbody>
</tbody>
</table>
</table>
@@ -374,10 +383,13 @@ before being cancelled cannot be made without blocking.</td>
<col class="field-name" />
<col class="field-name" />
<col class="field-body" />
<col class="field-body" />
<tbody valign="top">
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if the computation was cancelled any time before its result became
-immediately available. False under all other circumstances including but
+<dt>True if the computation was cancelled any time before its result became</dt>
+<dd>immediately available. False under all other circumstances including but
not limited to this object’s cancel method not having been called and
not limited to this object’s cancel method not having been called and
-the computation’s result having become immediately available.</td>
+the computation’s result having become immediately available.</dd>
+</dl>
+</td>
</tr>
</tr>
</tbody>
</tbody>
</table>
</table>
@@ -392,9 +404,12 @@ the computation’s result having become immediately available.</td>
<col class="field-name" />
<col class="field-name" />
<col class="field-body" />
<col class="field-body" />
<tbody valign="top">
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if the computation is known to have either completed or have been
-unscheduled or interrupted. False if the computation may possibly be
+<dt>True if the computation is known to have either completed or have been</dt>
+<dd>unscheduled or interrupted. False if the computation may possibly be
+executing or scheduled to execute later.</dd>
+</dl>
+</td>
</tr>
</tr>
</tbody>
</tbody>
</table>
</table>
@@ -415,16 +430,18 @@ the computation is terminated or is cancelled no matter how long that
takes.</p>
takes.</p>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The exception raised by the computation, or None if the computation did
-If a timeout value is passed and the computation does not
+<li><a class="reference internal" href="#grpc.framework.foundation.future.TimeoutError" title="grpc.framework.foundation.future.TimeoutError"><code class="xref py py-exc docutils literal"><span class="pre">TimeoutError</span></code></a> – If a timeout value is passed and the computation does not
-If a timeout value is passed and the computation does not
+<li><a class="reference internal" href="#grpc.framework.foundation.future.TimeoutError" title="grpc.framework.foundation.future.TimeoutError"><code class="xref py py-exc docutils literal"><span class="pre">TimeoutError</span></code></a> – If a timeout value is passed and the computation does not
-If the computation raised an exception, this call will raise
+<li><a class="reference internal" href="#grpc.framework.foundation.future.CancelledError" title="grpc.framework.foundation.future.CancelledError"><code class="xref py py-exc docutils literal"><span class="pre">CancelledError</span></code></a> – If the computation was cancelled.</li>
+<li><code class="xref py py-exc docutils literal"><span class="pre">Exception</span></code> – If the computation raised an exception, this call will raise
the same exception.</li>
the same exception.</li>
</ul>
</ul>
</td>
</td>
@@ -474,9 +488,12 @@ the same exception.</li>
<col class="field-name" />
<col class="field-name" />
<col class="field-body" />
<col class="field-body" />
<tbody valign="top">
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if the computation is scheduled to take place in the future or is
-taking place now, or False if the computation took place in the past or
+<dt>True if the computation is scheduled to take place in the future or is</dt>
+<dd>taking place now, or False if the computation took place in the past or
+was cancelled.</dd>
+</dl>
+</td>
</tr>
</tr>
</tbody>
</tbody>
</table>
</table>
@@ -497,16 +514,18 @@ the computation is terminated or is cancelled no matter how long that
takes.</p>
takes.</p>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The traceback of the exception raised by the computation, or None if the
-If a timeout value is passed and the computation does not
+<li><a class="reference internal" href="#grpc.framework.foundation.future.TimeoutError" title="grpc.framework.foundation.future.TimeoutError"><code class="xref py py-exc docutils literal"><span class="pre">TimeoutError</span></code></a> – If a timeout value is passed and the computation does not
+<li><a class="reference internal" href="#grpc.framework.foundation.future.CancelledError" title="grpc.framework.foundation.future.CancelledError"><code class="xref py py-exc docutils literal"><span class="pre">CancelledError</span></code></a> – If the computation was cancelled.</li>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
@@ -564,8 +583,11 @@ about the maximum length of time that will pass.</li>
<tbody valign="top">
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>max_workers</strong> – The maximum number of worker threads to allow the pool.</td>
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>max_workers</strong> – The maximum number of worker threads to allow the pool.</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A futures.ThreadPoolExecutor-compatible thread pool that logs exceptions
+<dt>A futures.ThreadPoolExecutor-compatible thread pool that logs exceptions</dt>
+<dd>raised by the tasks executed within it.</dd>
+</dl>
+</td>
</tr>
</tr>
</tbody>
</tbody>
</table>
</table>
@@ -632,8 +654,12 @@ Relay later.</li>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">An object that is both an activated.Activated and a Relay. The object is
-only valid for use as a Relay when activated.</p>
+<dt>An object that is both an activated.Activated and a Relay. The object is</dt>
+<dd><p class="first last">only valid for use as a Relay when activated.</p>
+</dd>
+</dl>
+</p>
</td>
</td>
</tr>
</tr>
</tbody>
</tbody>
@@ -652,8 +678,11 @@ only valid for use as a Relay when activated.</p>
passed values dropped until a different behavior is given to the returned
passed values dropped until a different behavior is given to the returned
Relay later.</td>
Relay later.</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">An object that is both an activated.Activated and a Relay. The object is
-only valid for use as a Relay when activated.</td>
@@ -231,11 +231,15 @@ implementation affording custom state and behavior.</li>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A pair of objects affording information about the operation and action
-continuing the operation. The first element of the returned pair is an
+<dt>A pair of objects affording information about the operation and action</dt>
+<dd><p class="first last">continuing the operation. The first element of the returned pair is an
OperationContext for the operation and the second element of the
OperationContext for the operation and the second element of the
returned pair is an Operator to which operation values not passed in
returned pair is an Operator to which operation values not passed in
this call should later be passed.</p>
this call should later be passed.</p>
+</dd>
+</dl>
+</p>
</td>
</td>
</tr>
</tr>
</tbody>
</tbody>
@@ -250,8 +254,11 @@ this call should later be passed.</p>
<col class="field-name" />
<col class="field-name" />
<col class="field-body" />
<col class="field-body" />
<tbody valign="top">
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">A dictionary from Outcome.Kind value to an integer identifying the number
-of operations that terminated with that outcome kind.</td>
+<dt>A dictionary from Outcome.Kind value to an integer identifying the number</dt>
+<dd>of operations that terminated with that outcome kind.</dd>
+</dl>
+</td>
</tr>
</tr>
</tbody>
</tbody>
</table>
</table>
@@ -279,12 +286,15 @@ terminate before being forcefully terminated by the stopping of this
End. May be zero to terminate all ongoing operations and immediately
End. May be zero to terminate all ongoing operations and immediately
stop.</td>
stop.</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">A threading.Event that will be set to indicate all operations having
-terminated and this End having completely stopped. The returned event
+<dt>A threading.Event that will be set to indicate all operations having</dt>
+<dd>terminated and this End having completely stopped. The returned event
may not be set until after the full grace period (if some ongoing
may not be set until after the full grace period (if some ongoing
operation continues for the full length of the period) or it may be set
operation continues for the full length of the period) or it may be set
much sooner (if for example this End had no operations in progress at
much sooner (if for example this End had no operations in progress at
-the time its stop method was called).</td>
+the time its stop method was called).</dd>
+</dl>
+</td>
</tr>
</tr>
</tbody>
</tbody>
</table>
</table>
@@ -329,10 +339,13 @@ along with indication of operation termination. May be None.</p>
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>callback</strong> – A callable to be passed an Outcome value on operation
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>callback</strong> – A callable to be passed an Outcome value on operation
termination.</td>
termination.</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">None if the operation has not yet terminated and the passed callback will
-later be called when it does terminate, or if the operation has already
+<dt>None if the operation has not yet terminated and the passed callback will</dt>
+<dd>later be called when it does terminate, or if the operation has already
terminated an Outcome value describing the operation termination and the
terminated an Outcome value describing the operation termination and the
-passed callback will not be called as a result of this method call.</td>
+passed callback will not be called as a result of this method call.</dd>
+</dl>
+</td>
</tr>
</tr>
</tbody>
</tbody>
</table>
</table>
@@ -366,8 +379,11 @@ passed callback will not be called as a result of this method call.</td>
<col class="field-name" />
<col class="field-name" />
<col class="field-body" />
<col class="field-body" />
<tbody valign="top">
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">None if the operation is still active or the Outcome value for the
+<code class="descname">TRANSMISSION_FAILURE</code><em class="property"> = <Kind.TRANSMISSION_FAILURE: 'transmission failure'></em><a class="headerlink" href="#grpc.framework.interfaces.base.base.Outcome.Kind.TRANSMISSION_FAILURE" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
</dd></dl>
</dd></dl>
</dd></dl>
</dd></dl>
@@ -500,16 +561,18 @@ operation.</li>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">A Subscription via which this object may or may not accept more values of
-If this Servicer does not handle operations with the
+<li><a class="reference internal" href="#grpc.framework.interfaces.base.base.NoSuchMethodError" title="grpc.framework.interfaces.base.base.NoSuchMethodError"><code class="xref py py-exc docutils literal"><span class="pre">NoSuchMethodError</span></code></a> – If this Servicer does not handle operations with the
+<li><code class="xref py py-exc docutils literal"><span class="pre">abandonment.Abandoned</span></code> – If the operation has been aborted and there no
longer is any reason to service the operation.</li>
longer is any reason to service the operation.</li>
+<code class="descname">TERMINATION_ONLY</code><em class="property"> = <Kind.TERMINATION_ONLY: 'termination only'></em><a class="headerlink" href="#grpc.framework.interfaces.base.base.Subscription.Kind.TERMINATION_ONLY" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
</dd></dl>
</dd></dl>
</dd></dl>
</dd></dl>
@@ -611,8 +689,12 @@ Kind.FULL.</p>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A base.Subscription of kind base.Subscription.Kind.FULL wrapping the given
+<code class="descname">REMOTE_SHUTDOWN</code><em class="property"> = <Kind.REMOTE_SHUTDOWN: 'remote shutdown'></em><a class="headerlink" href="#grpc.framework.interfaces.face.face.Abortion.Kind.REMOTE_SHUTDOWN" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
</dd></dl>
</dd></dl>
</dd></dl>
</dd></dl>
@@ -235,8 +270,11 @@ emitted from the service-side of the RPC.</p>
<col class="field-name" />
<col class="field-name" />
<col class="field-body" />
<col class="field-body" />
<tbody valign="top">
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The code object emitted by the service-side of the RPC, or None if there
+<dt>The code object emitted by the service-side of the RPC, or None if there</dt>
+<dd>was no such value.</dd>
+</dl>
+</td>
</tr>
</tr>
</tbody>
</tbody>
</table>
</table>
@@ -252,8 +290,11 @@ emitted from the service-side of the RPC.</p>
<col class="field-name" />
<col class="field-name" />
<col class="field-body" />
<col class="field-body" />
<tbody valign="top">
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The details value emitted by the service-side of the RPC, or None if there
+<dt>The details value emitted by the service-side of the RPC, or None if there</dt>
+<dd>was no such value.</dd>
+</dl>
+</td>
</tr>
</tr>
</tbody>
</tbody>
</table>
</table>
@@ -269,8 +310,11 @@ emitted from the service-side of the RPC.</p>
<col class="field-name" />
<col class="field-name" />
<col class="field-body" />
<col class="field-body" />
<tbody valign="top">
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The initial metadata object emitted by the service-side of the RPC, or
+<dt>The initial metadata object emitted by the service-side of the RPC, or</dt>
+<dd>None if there was no such value.</dd>
+</dl>
+</td>
</tr>
</tr>
</tbody>
</tbody>
</table>
</table>
@@ -286,8 +330,11 @@ emitted from the service-side of the RPC.</p>
<col class="field-name" />
<col class="field-name" />
<col class="field-body" />
<col class="field-body" />
<tbody valign="top">
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The terminal metadata object emitted by the service-side of the RPC, or
+<dt>The terminal metadata object emitted by the service-side of the RPC, or</dt>
+<dd>None if there was no such value.</dd>
+</dl>
+</td>
</tr>
</tr>
</tbody>
</tbody>
</table>
</table>
@@ -350,18 +397,21 @@ RPC abortion).</p>
<li><strong>timeout</strong> – A duration of time in seconds to allow for the RPC.</li>
<li><strong>timeout</strong> – A duration of time in seconds to allow for the RPC.</li>
<li><strong>metadata</strong> – A metadata value to be passed to the service-side of the RPC.</li>
<li><strong>metadata</strong> – A metadata value to be passed to the service-side of the RPC.</li>
<li><strong>with_call</strong> – Whether or not to include return a Call for the RPC in addition
<li><strong>with_call</strong> – Whether or not to include return a Call for the RPC in addition
-to the reponse.</li>
+to the response.</li>
<li><strong>protocol_options</strong> – A value specified by the provider of a Face interface
<li><strong>protocol_options</strong> – A value specified by the provider of a Face interface
implementation affording custom state and behavior.</li>
implementation affording custom state and behavior.</li>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The response value for the RPC, and a Call for the RPC if with_call was
+<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#grpc.framework.interfaces.face.face.AbortionError" title="grpc.framework.interfaces.face.face.AbortionError"><code class="xref py py-exc docutils literal"><span class="pre">AbortionError</span></code></a> – Indicating that the RPC was aborted.</p>
</td>
</td>
</tr>
</tr>
</tbody>
</tbody>
@@ -386,18 +436,21 @@ RPC abortion).</p>
<li><strong>timeout</strong> – A duration of time in seconds to allow for the RPC.</li>
<li><strong>timeout</strong> – A duration of time in seconds to allow for the RPC.</li>
<li><strong>metadata</strong> – A metadata value to be passed to the service-side of the RPC.</li>
<li><strong>metadata</strong> – A metadata value to be passed to the service-side of the RPC.</li>
<li><strong>with_call</strong> – Whether or not to include return a Call for the RPC in addition
<li><strong>with_call</strong> – Whether or not to include return a Call for the RPC in addition
-to the reponse.</li>
+to the response.</li>
<li><strong>protocol_options</strong> – A value specified by the provider of a Face interface
<li><strong>protocol_options</strong> – A value specified by the provider of a Face interface
implementation affording custom state and behavior.</li>
implementation affording custom state and behavior.</li>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The response value for the RPC, and a Call for the RPC if with_call was
+<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#grpc.framework.interfaces.face.face.AbortionError" title="grpc.framework.interfaces.face.face.AbortionError"><code class="xref py py-exc docutils literal"><span class="pre">AbortionError</span></code></a> – Indicating that the RPC was aborted.</p>
</td>
</td>
</tr>
</tr>
</tbody>
</tbody>
@@ -425,8 +478,12 @@ implementation affording custom state and behavior.</li>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A pair of a Call object for the RPC and a stream.Consumer to which the
+<dt>A pair of a Call object for the RPC and a stream.Consumer to which the</dt>
+<dd><p class="first last">request values of the RPC should be passed.</p>
+</dd>
+</dl>
+</p>
</td>
</td>
</tr>
</tr>
</tbody>
</tbody>
@@ -454,8 +511,12 @@ implementation affording custom state and behavior.</li>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A pair of a Call object for the RPC and a stream.Consumer to which the
+<dt>A pair of a Call object for the RPC and a stream.Consumer to which the</dt>
+<dd><p class="first last">request values of the RPC should be passed.</p>
+</dd>
+</dl>
+</p>
</td>
</td>
</tr>
</tr>
</tbody>
</tbody>
@@ -539,10 +600,14 @@ implementation affording custom state and behavior.</li>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">An object that is both a Call for the RPC and a future.Future. In the
-event of RPC completion, the return Future’s result value will be the
+<dt>An object that is both a Call for the RPC and a future.Future. In the</dt>
+<dd><p class="first last">event of RPC completion, the return Future’s result value will be the
response value of the RPC. In the event of RPC abortion, the returned
response value of the RPC. In the event of RPC abortion, the returned
Future’s exception value will be an AbortionError.</p>
Future’s exception value will be an AbortionError.</p>
+</dd>
+</dl>
+</p>
</td>
</td>
</tr>
</tr>
</tbody>
</tbody>
@@ -568,10 +633,14 @@ implementation affording custom state and behavior.</li>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">An object that is both a Call for the RPC and a future.Future. In the
-event of RPC completion, the return Future’s result value will be the
+<dt>An object that is both a Call for the RPC and a future.Future. In the</dt>
+<dd><p class="first last">event of RPC completion, the return Future’s result value will be the
response value of the RPC. In the event of RPC abortion, the returned
response value of the RPC. In the event of RPC abortion, the returned
Future’s exception value will be an AbortionError.</p>
Future’s exception value will be an AbortionError.</p>
+</dd>
+</dl>
+</p>
</td>
</td>
</tr>
</tr>
</tbody>
</tbody>
@@ -597,9 +666,13 @@ implementation affording custom state and behavior.</li>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">An object that is both a Call for the RPC and an iterator of response
-values. Drawing response values from the returned iterator may raise
+<dt>An object that is both a Call for the RPC and an iterator of response</dt>
+<dd><p class="first last">values. Drawing response values from the returned iterator may raise
AbortionError indicating abortion of the RPC.</p>
AbortionError indicating abortion of the RPC.</p>
+</dd>
+</dl>
+</p>
</td>
</td>
</tr>
</tr>
</tbody>
</tbody>
@@ -625,9 +698,13 @@ implementation affording custom state and behavior.</li>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">An object that is both a Call for the RPC and an iterator of response
-values. Drawing response values from the returned iterator may raise
+<dt>An object that is both a Call for the RPC and an iterator of response</dt>
+<dd><p class="first last">values. Drawing response values from the returned iterator may raise
AbortionError indicating abortion of the RPC.</p>
AbortionError indicating abortion of the RPC.</p>
+</dd>
+</dl>
+</p>
</td>
</td>
</tr>
</tr>
</tbody>
</tbody>
@@ -851,20 +928,22 @@ values of the RPC.</li>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">A stream.Consumer with which to accept the request values of the RPC. The
-consumer returned from this method may or may not be invoked to
+<li><code class="xref py py-exc docutils literal"><span class="pre">abandonment.Abandoned</span></code> – May or may not be raised when the RPC has been
-If this MultiMethod does not recognize the given group
+<li><a class="reference internal" href="#grpc.framework.interfaces.face.face.NoSuchMethodError" title="grpc.framework.interfaces.face.face.NoSuchMethodError"><code class="xref py py-exc docutils literal"><span class="pre">NoSuchMethodError</span></code></a> – If this MultiMethod does not recognize the given group
and name for the RPC and is not able to service the RPC.</li>
and name for the RPC and is not able to service the RPC.</li>
</ul>
</ul>
</td>
</td>
@@ -1012,8 +1091,11 @@ in the event of RPC abortion.</td>
<col class="field-name" />
<col class="field-name" />
<col class="field-body" />
<col class="field-body" />
<tbody valign="top">
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">A value specified by the provider of a Face interface implementation
+<dt>A value specified by the provider of a Face interface implementation</dt>
+<dd>affording custom state and behavior.</dd>
+</dl>
+</td>
</tr>
</tr>
</tbody>
</tbody>
</table>
</table>
@@ -1103,8 +1185,11 @@ emitted from the invocation-side of the RPC.</p>
<col class="field-name" />
<col class="field-name" />
<col class="field-body" />
<col class="field-body" />
<tbody valign="top">
<tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The metadata object emitted by the invocation-side of the RPC, or None if
-<li><strong>request_iterator</strong> – An iterator that yields request values for the RPC.</li>
-<li><strong>timeout</strong> – A duration of time in seconds to allow for the RPC.</li>
-<li><strong>metadata</strong> – A metadata value to be passed to the service-side of
-the RPC.</li>
-<li><strong>protocol_options</strong> – A value specified by the provider of a Face interface
-implementation affording custom state and behavior.</li>
-</ul>
-</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">An object that is both a Call for the RPC and an iterator of response
-values. Drawing response values from the returned iterator may raise
-AbortionError indicating abortion of the RPC.</p>
<code class="descname">event</code><span class="sig-paren">(</span><em>receiver</em>, <em>abortion_callback</em>, <em>timeout</em>, <em>metadata=None</em>, <em>protocol_options=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#StreamStreamMultiCallable.event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.StreamStreamMultiCallable.event" title="Permalink to this definition">¶</a></dt>
<code class="descname">event</code><span class="sig-paren">(</span><em>receiver</em>, <em>abortion_callback</em>, <em>timeout</em>, <em>metadata=None</em>, <em>protocol_options=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#StreamStreamMultiCallable.event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.StreamStreamMultiCallable.event" title="Permalink to this definition">¶</a></dt>
@@ -1181,8 +1239,12 @@ implementation affording custom state and behavior.</li>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A single object that is both a Call object for the RPC and a
-stream.Consumer to which the request values of the RPC should be passed.</p>
-<li><strong>request_iterator</strong> – An iterator that yields request values for the RPC.</li>
-<li><strong>timeout</strong> – A duration of time in seconds to allow for the RPC.</li>
-<li><strong>metadata</strong> – A metadata value to be passed to the service-side of
-the RPC.</li>
-<li><strong>with_call</strong> – Whether or not to include return a Call for the RPC in addition
-to the reponse.</li>
-<li><strong>protocol_options</strong> – A value specified by the provider of a Face interface
-implementation affording custom state and behavior.</li>
-</ul>
-</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The response value for the RPC, and a Call for the RPC if with_call was
<code class="descname">event</code><span class="sig-paren">(</span><em>receiver</em>, <em>abortion_callback</em>, <em>timeout</em>, <em>metadata=None</em>, <em>protocol_options=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#StreamUnaryMultiCallable.event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.StreamUnaryMultiCallable.event" title="Permalink to this definition">¶</a></dt>
<code class="descname">event</code><span class="sig-paren">(</span><em>receiver</em>, <em>abortion_callback</em>, <em>timeout</em>, <em>metadata=None</em>, <em>protocol_options=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#StreamUnaryMultiCallable.event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.StreamUnaryMultiCallable.event" title="Permalink to this definition">¶</a></dt>
@@ -1248,8 +1278,12 @@ implementation affording custom state and behavior.</li>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A single object that is both a Call object for the RPC and a
-stream.Consumer to which the request values of the RPC should be passed.</p>
+<dt>A single object that is both a Call object for the RPC and a</dt>
+<dd><p class="first last">stream.Consumer to which the request values of the RPC should be passed.</p>
+</dd>
+</dl>
+</p>
</td>
</td>
</tr>
</tr>
</tbody>
</tbody>
@@ -1274,10 +1308,14 @@ implementation affording custom state and behavior.</li>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">An object that is both a Call for the RPC and a future.Future. In the
-event of RPC completion, the return Future’s result value will be the
-<li><strong>request</strong> – The request value for the RPC.</li>
-<li><strong>timeout</strong> – A duration of time in seconds to allow for the RPC.</li>
-<li><strong>metadata</strong> – A metadata value to be passed to the service-side of
-the RPC.</li>
-<li><strong>protocol_options</strong> – A value specified by the provider of a Face interface
-implementation affording custom state and behavior.</li>
-</ul>
-</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">An object that is both a Call for the RPC and an iterator of response
-values. Drawing response values from the returned iterator may raise
-AbortionError indicating abortion of the RPC.</p>
-<li><strong>request</strong> – The request value for the RPC.</li>
-<li><strong>timeout</strong> – A duration of time in seconds to allow for the RPC.</li>
-<li><strong>metadata</strong> – A metadata value to be passed to the service-side of
-the RPC.</li>
-<li><strong>with_call</strong> – Whether or not to include return a Call for the RPC in addition
-to the reponse.</li>
-<li><strong>protocol_options</strong> – A value specified by the provider of a Face interface
-implementation affording custom state and behavior.</li>
-</ul>
-</td>
-</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">The response value for the RPC, and a Call for the RPC if with_call was
<code class="descname">event</code><span class="sig-paren">(</span><em>request</em>, <em>receiver</em>, <em>abortion_callback</em>, <em>timeout</em>, <em>metadata=None</em>, <em>protocol_options=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#UnaryUnaryMultiCallable.event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.UnaryUnaryMultiCallable.event" title="Permalink to this definition">¶</a></dt>
<code class="descname">event</code><span class="sig-paren">(</span><em>request</em>, <em>receiver</em>, <em>abortion_callback</em>, <em>timeout</em>, <em>metadata=None</em>, <em>protocol_options=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#UnaryUnaryMultiCallable.event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.UnaryUnaryMultiCallable.event" title="Permalink to this definition">¶</a></dt>
@@ -1431,10 +1410,14 @@ implementation affording custom state and behavior.</li>
</ul>
</ul>
</td>
</td>
</tr>
</tr>
-<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">An object that is both a Call for the RPC and a future.Future. In the
-event of RPC completion, the return Future’s result value will be the