Auto-update Python documentation
This commit is contained in:
Richard Belleville
parent
613d554899
commit
ef2eaefd2d
|
|
@ -1,4 +1,4 @@
|
|||
# Sphinx build info version 1
|
||||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
|
||||
config: 7defff909b49dfc8fa09a509a9048c22
|
||||
config: b9ca8daac7497672a92742b12782dfa7
|
||||
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
||||
|
|
|
|||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
|
|
@ -4,8 +4,8 @@
|
|||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>grpc — gRPC Python 1.31.0 documentation</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>grpc — gRPC Python 1.32.0 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
|
||||
|
||||
|
||||
<p class="blurb">1.31.0</p>
|
||||
<p class="blurb">1.32.0</p>
|
||||
|
||||
|
||||
|
||||
|
|
@ -1956,6 +1956,23 @@
|
|||
<span class="k">return</span> <span class="n">ServerCredentials</span><span class="p">(</span><span class="n">_cygrpc</span><span class="o">.</span><span class="n">server_credentials_alts</span><span class="p">())</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="compute_engine_channel_credentials"><a class="viewcode-back" href="../grpc.html#grpc.compute_engine_channel_credentials">[docs]</a><span class="k">def</span> <span class="nf">compute_engine_channel_credentials</span><span class="p">(</span><span class="n">call_credentials</span><span class="p">):</span>
|
||||
<span class="sd">"""Creates a compute engine channel credential.</span>
|
||||
|
||||
<span class="sd"> This credential can only be used in a GCP environment as it relies on</span>
|
||||
<span class="sd"> a handshaker service. For more info about ALTS, see</span>
|
||||
<span class="sd"> https://cloud.google.com/security/encryption-in-transit/application-layer-transport-security</span>
|
||||
|
||||
<span class="sd"> This channel credential is expected to be used as part of a composite</span>
|
||||
<span class="sd"> credential in conjunction with a call credentials that authenticates the</span>
|
||||
<span class="sd"> VM's default service account. If used with any other sort of call</span>
|
||||
<span class="sd"> credential, the connection may suddenly and unexpectedly begin failing RPCs.</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="k">return</span> <span class="n">ChannelCredentials</span><span class="p">(</span>
|
||||
<span class="n">_cygrpc</span><span class="o">.</span><span class="n">channel_credentials_compute_engine</span><span class="p">(</span>
|
||||
<span class="n">call_credentials</span><span class="o">.</span><span class="n">_credentials</span><span class="p">))</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="channel_ready_future"><a class="viewcode-back" href="../grpc.html#grpc.channel_ready_future">[docs]</a><span class="k">def</span> <span class="nf">channel_ready_future</span><span class="p">(</span><span class="n">channel</span><span class="p">):</span>
|
||||
<span class="sd">"""Creates a Future that tracks when a Channel is ready.</span>
|
||||
|
||||
|
|
@ -2109,6 +2126,8 @@
|
|||
<span class="n">Gzip</span> <span class="o">=</span> <span class="n">_compression</span><span class="o">.</span><span class="n">Gzip</span></div>
|
||||
|
||||
|
||||
<span class="kn">from</span> <span class="nn">grpc._runtime_protos</span> <span class="kn">import</span> <span class="n">protos</span><span class="p">,</span> <span class="n">services</span><span class="p">,</span> <span class="n">protos_and_services</span> <span class="c1"># pylint: disable=wrong-import-position</span>
|
||||
|
||||
<span class="c1">################################### __all__ #################################</span>
|
||||
|
||||
<span class="n">__all__</span> <span class="o">=</span> <span class="p">(</span>
|
||||
|
|
@ -2169,6 +2188,9 @@
|
|||
<span class="s1">'secure_channel'</span><span class="p">,</span>
|
||||
<span class="s1">'intercept_channel'</span><span class="p">,</span>
|
||||
<span class="s1">'server'</span><span class="p">,</span>
|
||||
<span class="s1">'protos'</span><span class="p">,</span>
|
||||
<span class="s1">'services'</span><span class="p">,</span>
|
||||
<span class="s1">'protos_and_services'</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="c1">############################### Extension Shims ################################</span>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,139 @@
|
|||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>grpc._cython — gRPC Python 1.24.3 documentation</title>
|
||||
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></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/language_data.js"></script>
|
||||
<link rel="index" title="Index" href="../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../search.html" />
|
||||
|
||||
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
<div class="document">
|
||||
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h1 class="logo"><a href="../../index.html">gRPC Python</a></h1>
|
||||
|
||||
|
||||
|
||||
<p class="blurb">1.24.3</p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Navigation</h3>
|
||||
<p class="caption"><span class="caption-text">Contents:</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../grpc.html">gRPC</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../grpc_channelz.html">gRPC Channelz</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../grpc_health_checking.html">gRPC Health Checking</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../grpc_reflection.html">gRPC Reflection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../grpc_status.html">gRPC Status</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../grpc_testing.html">gRPC Testing</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../../index.html">Documentation overview</a><ul>
|
||||
<li><a href="../index.html">Module code</a><ul>
|
||||
<li><a href="../grpc.html">grpc</a><ul>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../../search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
<h1>Source code for grpc._cython</h1><div class="highlight"><pre>
|
||||
<span></span><span class="c1"># Copyright 2015 gRPC authors.</span>
|
||||
<span class="c1">#</span>
|
||||
<span class="c1"># Licensed under the Apache License, Version 2.0 (the "License");</span>
|
||||
<span class="c1"># you may not use this file except in compliance with the License.</span>
|
||||
<span class="c1"># You may obtain a copy of the License at</span>
|
||||
<span class="c1">#</span>
|
||||
<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span>
|
||||
<span class="c1">#</span>
|
||||
<span class="c1"># Unless required by applicable law or agreed to in writing, software</span>
|
||||
<span class="c1"># distributed under the License is distributed on an "AS IS" BASIS,</span>
|
||||
<span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
|
||||
<span class="c1"># See the License for the specific language governing permissions and</span>
|
||||
<span class="c1"># limitations under the License.</span>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2018, The gRPC Authors.
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
|
||||
var _gaq = _gaq || [];
|
||||
_gaq.push(['_setAccount', 'UA-60127042-1']);
|
||||
_gaq.push(['_setDomainName', 'none']);
|
||||
_gaq.push(['_setAllowLinker', true]);
|
||||
_gaq.push(['_trackPageview']);
|
||||
|
||||
(function() {
|
||||
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
|
||||
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
|
||||
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
|
||||
})();
|
||||
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,295 @@
|
|||
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>grpc._runtime_protos — gRPC Python 1.32.0 documentation</title>
|
||||
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
|
||||
<script src="../../_static/jquery.js"></script>
|
||||
<script src="../../_static/underscore.js"></script>
|
||||
<script src="../../_static/doctools.js"></script>
|
||||
<script src="../../_static/language_data.js"></script>
|
||||
<link rel="index" title="Index" href="../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../search.html" />
|
||||
|
||||
<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
<div class="document">
|
||||
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h1 class="logo"><a href="../../index.html">gRPC Python</a></h1>
|
||||
|
||||
|
||||
|
||||
<p class="blurb">1.32.0</p>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Navigation</h3>
|
||||
<p class="caption"><span class="caption-text">Contents:</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../grpc.html">gRPC</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../grpc_asyncio.html">gRPC AsyncIO API</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../grpc_channelz.html">gRPC Channelz</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../grpc_health_checking.html">gRPC Health Checking</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../grpc_reflection.html">gRPC Reflection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../grpc_status.html">gRPC Status</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../grpc_testing.html">gRPC Testing</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../glossary.html">Glossary</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../../index.html">Documentation overview</a><ul>
|
||||
<li><a href="../index.html">Module code</a><ul>
|
||||
<li><a href="../grpc.html">grpc</a><ul>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
<h1>Source code for grpc._runtime_protos</h1><div class="highlight"><pre>
|
||||
<span></span><span class="c1"># Copyright 2020 The gRPC authors.</span>
|
||||
<span class="c1">#</span>
|
||||
<span class="c1"># Licensed under the Apache License, Version 2.0 (the "License");</span>
|
||||
<span class="c1"># you may not use this file except in compliance with the License.</span>
|
||||
<span class="c1"># You may obtain a copy of the License at</span>
|
||||
<span class="c1">#</span>
|
||||
<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span>
|
||||
<span class="c1">#</span>
|
||||
<span class="c1"># Unless required by applicable law or agreed to in writing, software</span>
|
||||
<span class="c1"># distributed under the License is distributed on an "AS IS" BASIS,</span>
|
||||
<span class="c1"># WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
|
||||
<span class="c1"># See the License for the specific language governing permissions and</span>
|
||||
<span class="c1"># limitations under the License.</span>
|
||||
|
||||
<span class="kn">import</span> <span class="nn">sys</span>
|
||||
|
||||
<span class="n">_REQUIRED_SYMBOLS</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"_protos"</span><span class="p">,</span> <span class="s2">"_services"</span><span class="p">,</span> <span class="s2">"_protos_and_services"</span><span class="p">)</span>
|
||||
|
||||
|
||||
<span class="k">def</span> <span class="nf">_uninstalled_protos</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
||||
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span>
|
||||
<span class="s2">"Install the grpcio-tools package (1.32.0+) to use the protos function."</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
|
||||
<span class="k">def</span> <span class="nf">_uninstalled_services</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
||||
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span>
|
||||
<span class="s2">"Install the grpcio-tools package (1.32.0+) to use the services function."</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
|
||||
<span class="k">def</span> <span class="nf">_uninstalled_protos_and_services</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
||||
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span>
|
||||
<span class="s2">"Install the grpcio-tools package (1.32.0+) to use the protos_and_services function."</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
|
||||
<span class="k">def</span> <span class="nf">_interpreter_version_protos</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
||||
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span>
|
||||
<span class="s2">"The protos function is only on available on Python 3.X interpreters."</span><span class="p">)</span>
|
||||
|
||||
|
||||
<span class="k">def</span> <span class="nf">_interpreter_version_services</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
||||
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span>
|
||||
<span class="s2">"The services function is only on available on Python 3.X interpreters."</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
|
||||
<span class="k">def</span> <span class="nf">_interpreter_version_protos_and_services</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
|
||||
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span>
|
||||
<span class="s2">"The protos_and_services function is only on available on Python 3.X interpreters."</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="protos"><a class="viewcode-back" href="../../grpc.html#grpc.protos">[docs]</a><span class="k">def</span> <span class="nf">protos</span><span class="p">(</span><span class="n">protobuf_path</span><span class="p">):</span> <span class="c1"># pylint: disable=unused-argument</span>
|
||||
<span class="sd">"""Returns a module generated by the indicated .proto file.</span>
|
||||
|
||||
<span class="sd"> THIS IS AN EXPERIMENTAL API.</span>
|
||||
|
||||
<span class="sd"> Use this function to retrieve classes corresponding to message</span>
|
||||
<span class="sd"> definitions in the .proto file.</span>
|
||||
|
||||
<span class="sd"> To inspect the contents of the returned module, use the dir function.</span>
|
||||
<span class="sd"> For example:</span>
|
||||
|
||||
<span class="sd"> ```</span>
|
||||
<span class="sd"> protos = grpc.protos("foo.proto")</span>
|
||||
<span class="sd"> print(dir(protos))</span>
|
||||
<span class="sd"> ```</span>
|
||||
|
||||
<span class="sd"> The returned module object corresponds to the _pb2.py file generated</span>
|
||||
<span class="sd"> by protoc. The path is expected to be relative to an entry on sys.path</span>
|
||||
<span class="sd"> and all transitive dependencies of the file should also be resolveable</span>
|
||||
<span class="sd"> from an entry on sys.path.</span>
|
||||
|
||||
<span class="sd"> To completely disable the machinery behind this function, set the</span>
|
||||
<span class="sd"> GRPC_PYTHON_DISABLE_DYNAMIC_STUBS environment variable to "true".</span>
|
||||
|
||||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> protobuf_path: The path to the .proto file on the filesystem. This path</span>
|
||||
<span class="sd"> must be resolveable from an entry on sys.path and so must all of its</span>
|
||||
<span class="sd"> transitive dependencies.</span>
|
||||
|
||||
<span class="sd"> Returns:</span>
|
||||
<span class="sd"> A module object corresponding to the message code for the indicated</span>
|
||||
<span class="sd"> .proto file. Equivalent to a generated _pb2.py file.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="services"><a class="viewcode-back" href="../../grpc.html#grpc.services">[docs]</a><span class="k">def</span> <span class="nf">services</span><span class="p">(</span><span class="n">protobuf_path</span><span class="p">):</span> <span class="c1"># pylint: disable=unused-argument</span>
|
||||
<span class="sd">"""Returns a module generated by the indicated .proto file.</span>
|
||||
|
||||
<span class="sd"> THIS IS AN EXPERIMENTAL API.</span>
|
||||
|
||||
<span class="sd"> Use this function to retrieve classes and functions corresponding to</span>
|
||||
<span class="sd"> service definitions in the .proto file, including both stub and servicer</span>
|
||||
<span class="sd"> definitions.</span>
|
||||
|
||||
<span class="sd"> To inspect the contents of the returned module, use the dir function.</span>
|
||||
<span class="sd"> For example:</span>
|
||||
|
||||
<span class="sd"> ```</span>
|
||||
<span class="sd"> services = grpc.services("foo.proto")</span>
|
||||
<span class="sd"> print(dir(services))</span>
|
||||
<span class="sd"> ```</span>
|
||||
|
||||
<span class="sd"> The returned module object corresponds to the _pb2_grpc.py file generated</span>
|
||||
<span class="sd"> by protoc. The path is expected to be relative to an entry on sys.path</span>
|
||||
<span class="sd"> and all transitive dependencies of the file should also be resolveable</span>
|
||||
<span class="sd"> from an entry on sys.path.</span>
|
||||
|
||||
<span class="sd"> To completely disable the machinery behind this function, set the</span>
|
||||
<span class="sd"> GRPC_PYTHON_DISABLE_DYNAMIC_STUBS environment variable to "true".</span>
|
||||
|
||||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> protobuf_path: The path to the .proto file on the filesystem. This path</span>
|
||||
<span class="sd"> must be resolveable from an entry on sys.path and so must all of its</span>
|
||||
<span class="sd"> transitive dependencies.</span>
|
||||
|
||||
<span class="sd"> Returns:</span>
|
||||
<span class="sd"> A module object corresponding to the stub/service code for the indicated</span>
|
||||
<span class="sd"> .proto file. Equivalent to a generated _pb2_grpc.py file.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="protos_and_services"><a class="viewcode-back" href="../../grpc.html#grpc.protos_and_services">[docs]</a><span class="k">def</span> <span class="nf">protos_and_services</span><span class="p">(</span><span class="n">protobuf_path</span><span class="p">):</span> <span class="c1"># pylint: disable=unused-argument</span>
|
||||
<span class="sd">"""Returns a 2-tuple of modules corresponding to protos and services.</span>
|
||||
|
||||
<span class="sd"> THIS IS AN EXPERIMENTAL API.</span>
|
||||
|
||||
<span class="sd"> The return value of this function is equivalent to a call to protos and a</span>
|
||||
<span class="sd"> call to services.</span>
|
||||
|
||||
<span class="sd"> To completely disable the machinery behind this function, set the</span>
|
||||
<span class="sd"> GRPC_PYTHON_DISABLE_DYNAMIC_STUBS environment variable to "true".</span>
|
||||
|
||||
<span class="sd"> Args:</span>
|
||||
<span class="sd"> protobuf_path: The path to the .proto file on the filesystem. This path</span>
|
||||
<span class="sd"> must be resolveable from an entry on sys.path and so must all of its</span>
|
||||
<span class="sd"> transitive dependencies.</span>
|
||||
|
||||
<span class="sd"> Returns:</span>
|
||||
<span class="sd"> A 2-tuple of module objects corresponding to (protos(path), services(path)).</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
|
||||
<span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span> <span class="o"><</span> <span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">0</span><span class="p">):</span>
|
||||
<span class="n">protos</span> <span class="o">=</span> <span class="n">_interpreter_version_protos</span>
|
||||
<span class="n">services</span> <span class="o">=</span> <span class="n">_interpreter_version_services</span>
|
||||
<span class="n">protos_and_services</span> <span class="o">=</span> <span class="n">_interpreter_version_protos_and_services</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="k">try</span><span class="p">:</span>
|
||||
<span class="kn">import</span> <span class="nn">grpc_tools</span> <span class="c1"># pylint: disable=unused-import</span>
|
||||
<span class="k">except</span> <span class="ne">ImportError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
|
||||
<span class="c1"># NOTE: It's possible that we're encountering a transitive ImportError, so</span>
|
||||
<span class="c1"># we check for that and re-raise if so.</span>
|
||||
<span class="k">if</span> <span class="s2">"grpc_tools"</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">e</span><span class="o">.</span><span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">]:</span>
|
||||
<span class="k">raise</span>
|
||||
<span class="n">protos</span> <span class="o">=</span> <span class="n">_uninstalled_protos</span>
|
||||
<span class="n">services</span> <span class="o">=</span> <span class="n">_uninstalled_services</span>
|
||||
<span class="n">protos_and_services</span> <span class="o">=</span> <span class="n">_uninstalled_protos_and_services</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="kn">import</span> <span class="nn">grpc_tools.protoc</span> <span class="c1"># pylint: disable=unused-import</span>
|
||||
<span class="k">if</span> <span class="nb">all</span><span class="p">(</span><span class="nb">hasattr</span><span class="p">(</span><span class="n">grpc_tools</span><span class="o">.</span><span class="n">protoc</span><span class="p">,</span> <span class="n">sym</span><span class="p">)</span> <span class="k">for</span> <span class="n">sym</span> <span class="ow">in</span> <span class="n">_REQUIRED_SYMBOLS</span><span class="p">):</span>
|
||||
<span class="kn">from</span> <span class="nn">grpc_tools.protoc</span> <span class="kn">import</span> <span class="n">_protos</span> <span class="k">as</span> <span class="n">protos</span> <span class="c1"># pylint: disable=unused-import</span>
|
||||
<span class="kn">from</span> <span class="nn">grpc_tools.protoc</span> <span class="kn">import</span> <span class="n">_services</span> <span class="k">as</span> <span class="n">services</span> <span class="c1"># pylint: disable=unused-import</span>
|
||||
<span class="kn">from</span> <span class="nn">grpc_tools.protoc</span> <span class="kn">import</span> <span class="n">_protos_and_services</span> <span class="k">as</span> <span class="n">protos_and_services</span> <span class="c1"># pylint: disable=unused-import</span>
|
||||
<span class="k">else</span><span class="p">:</span>
|
||||
<span class="n">protos</span> <span class="o">=</span> <span class="n">_uninstalled_protos</span>
|
||||
<span class="n">services</span> <span class="o">=</span> <span class="n">_uninstalled_services</span>
|
||||
<span class="n">protos_and_services</span> <span class="o">=</span> <span class="n">_uninstalled_protos_and_services</span>
|
||||
</pre></div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2020, The gRPC Authors.
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
|
||||
var _gaq = _gaq || [];
|
||||
_gaq.push(['_setAccount', 'UA-60127042-1']);
|
||||
_gaq.push(['_setDomainName', 'none']);
|
||||
_gaq.push(['_setAllowLinker', true]);
|
||||
_gaq.push(['_trackPageview']);
|
||||
|
||||
(function() {
|
||||
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
|
||||
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
|
||||
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
|
||||
})();
|
||||
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -4,19 +4,19 @@
|
|||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>grpc.experimental.aio._base_call — gRPC Python 1.31.0 documentation</title>
|
||||
<link rel="stylesheet" href="../../../../_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../../_static/jquery.js"></script>
|
||||
<script src="../../../../_static/underscore.js"></script>
|
||||
<script src="../../../../_static/doctools.js"></script>
|
||||
<script src="../../../../_static/language_data.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>grpc.aio._base_call — gRPC Python 1.32.0 documentation</title>
|
||||
<link rel="stylesheet" href="../../../_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../_static/jquery.js"></script>
|
||||
<script src="../../../_static/underscore.js"></script>
|
||||
<script src="../../../_static/doctools.js"></script>
|
||||
<script src="../../../_static/language_data.js"></script>
|
||||
<link rel="index" title="Index" href="../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../search.html" />
|
||||
|
||||
<link rel="stylesheet" href="../../../../_static/custom.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
|
@ -26,11 +26,11 @@
|
|||
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h1 class="logo"><a href="../../../../index.html">gRPC Python</a></h1>
|
||||
<h1 class="logo"><a href="../../../index.html">gRPC Python</a></h1>
|
||||
|
||||
|
||||
|
||||
<p class="blurb">1.31.0</p>
|
||||
<p class="blurb">1.32.0</p>
|
||||
|
||||
|
||||
|
||||
|
|
@ -40,22 +40,22 @@
|
|||
<h3>Navigation</h3>
|
||||
<p class="caption"><span class="caption-text">Contents:</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc.html">gRPC</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_asyncio.html">gRPC AsyncIO API</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_channelz.html">gRPC Channelz</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_health_checking.html">gRPC Health Checking</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_reflection.html">gRPC Reflection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_status.html">gRPC Status</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_testing.html">gRPC Testing</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../glossary.html">Glossary</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc.html">gRPC</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_asyncio.html">gRPC AsyncIO API</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_channelz.html">gRPC Channelz</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_health_checking.html">gRPC Health Checking</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_reflection.html">gRPC Reflection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_status.html">gRPC Status</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_testing.html">gRPC Testing</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../glossary.html">Glossary</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../../../../index.html">Documentation overview</a><ul>
|
||||
<li><a href="../../../index.html">Module code</a><ul>
|
||||
<li><a href="../../../grpc.html">grpc</a><ul>
|
||||
<li><a href="../../../index.html">Documentation overview</a><ul>
|
||||
<li><a href="../../index.html">Module code</a><ul>
|
||||
<li><a href="../../grpc.html">grpc</a><ul>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
|
|
@ -64,7 +64,7 @@
|
|||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../../../../search.html" method="get">
|
||||
<form class="search" action="../../../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
|
|
@ -87,7 +87,7 @@
|
|||
|
||||
<div class="body" role="main">
|
||||
|
||||
<h1>Source code for grpc.experimental.aio._base_call</h1><div class="highlight"><pre>
|
||||
<h1>Source code for grpc.aio._base_call</h1><div class="highlight"><pre>
|
||||
<span></span><span class="c1"># Copyright 2019 The gRPC Authors</span>
|
||||
<span class="c1">#</span>
|
||||
<span class="c1"># Licensed under the Apache License, Version 2.0 (the "License");</span>
|
||||
|
|
@ -119,10 +119,10 @@
|
|||
<span class="n">__all__</span> <span class="o">=</span> <span class="s1">'RpcContext'</span><span class="p">,</span> <span class="s1">'Call'</span><span class="p">,</span> <span class="s1">'UnaryUnaryCall'</span><span class="p">,</span> <span class="s1">'UnaryStreamCall'</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="RpcContext"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.RpcContext">[docs]</a><span class="k">class</span> <span class="nc">RpcContext</span><span class="p">(</span><span class="n">metaclass</span><span class="o">=</span><span class="n">ABCMeta</span><span class="p">):</span>
|
||||
<div class="viewcode-block" id="RpcContext"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.RpcContext">[docs]</a><span class="k">class</span> <span class="nc">RpcContext</span><span class="p">(</span><span class="n">metaclass</span><span class="o">=</span><span class="n">ABCMeta</span><span class="p">):</span>
|
||||
<span class="sd">"""Provides RPC-related information and action."""</span>
|
||||
|
||||
<div class="viewcode-block" id="RpcContext.cancelled"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.RpcContext.cancelled">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<div class="viewcode-block" id="RpcContext.cancelled"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.RpcContext.cancelled">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<span class="k">def</span> <span class="nf">cancelled</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span>
|
||||
<span class="sd">"""Return True if the RPC is cancelled.</span>
|
||||
|
||||
|
|
@ -132,7 +132,7 @@
|
|||
<span class="sd"> A bool indicates whether the RPC is cancelled or not.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="RpcContext.done"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.RpcContext.done">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<div class="viewcode-block" id="RpcContext.done"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.RpcContext.done">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<span class="k">def</span> <span class="nf">done</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span>
|
||||
<span class="sd">"""Return True if the RPC is done.</span>
|
||||
|
||||
|
|
@ -142,7 +142,7 @@
|
|||
<span class="sd"> A bool indicates if the RPC is done.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="RpcContext.time_remaining"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.RpcContext.time_remaining">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<div class="viewcode-block" id="RpcContext.time_remaining"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.RpcContext.time_remaining">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<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="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="nb">float</span><span class="p">]:</span>
|
||||
<span class="sd">"""Describes the length of allowed time remaining for the RPC.</span>
|
||||
|
||||
|
|
@ -152,7 +152,7 @@
|
|||
<span class="sd"> timed out, or None if no deadline was specified for the RPC.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="RpcContext.cancel"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.RpcContext.cancel">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<div class="viewcode-block" id="RpcContext.cancel"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.RpcContext.cancel">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<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="o">-></span> <span class="nb">bool</span><span class="p">:</span>
|
||||
<span class="sd">"""Cancels the RPC.</span>
|
||||
|
||||
|
|
@ -162,7 +162,7 @@
|
|||
<span class="sd"> A bool indicates if the cancellation is performed or not.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="RpcContext.add_done_callback"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.RpcContext.add_done_callback">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<div class="viewcode-block" id="RpcContext.add_done_callback"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.RpcContext.add_done_callback">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<span class="k">def</span> <span class="nf">add_done_callback</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">callback</span><span class="p">:</span> <span class="n">DoneCallbackType</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="sd">"""Registers a callback to be called on RPC termination.</span>
|
||||
|
||||
|
|
@ -172,10 +172,10 @@
|
|||
<span class="sd"> """</span></div></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="Call"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.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="n">metaclass</span><span class="o">=</span><span class="n">ABCMeta</span><span class="p">):</span>
|
||||
<div class="viewcode-block" id="Call"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.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="n">metaclass</span><span class="o">=</span><span class="n">ABCMeta</span><span class="p">):</span>
|
||||
<span class="sd">"""The abstract base class of an RPC on the client-side."""</span>
|
||||
|
||||
<div class="viewcode-block" id="Call.initial_metadata"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.Call.initial_metadata">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<div class="viewcode-block" id="Call.initial_metadata"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.Call.initial_metadata">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<span class="k">async</span> <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="o">-></span> <span class="n">Metadata</span><span class="p">:</span>
|
||||
<span class="sd">"""Accesses the initial metadata sent by the server.</span>
|
||||
|
||||
|
|
@ -183,7 +183,7 @@
|
|||
<span class="sd"> The initial :term:`metadata`.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="Call.trailing_metadata"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.Call.trailing_metadata">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<div class="viewcode-block" id="Call.trailing_metadata"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.Call.trailing_metadata">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<span class="k">async</span> <span class="k">def</span> <span class="nf">trailing_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Metadata</span><span class="p">:</span>
|
||||
<span class="sd">"""Accesses the trailing metadata sent by the server.</span>
|
||||
|
||||
|
|
@ -191,7 +191,7 @@
|
|||
<span class="sd"> The trailing :term:`metadata`.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="Call.code"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.Call.code">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<div class="viewcode-block" id="Call.code"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.Call.code">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<span class="k">async</span> <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="o">-></span> <span class="n">grpc</span><span class="o">.</span><span class="n">StatusCode</span><span class="p">:</span>
|
||||
<span class="sd">"""Accesses the status code sent by the server.</span>
|
||||
|
||||
|
|
@ -199,7 +199,7 @@
|
|||
<span class="sd"> The StatusCode value for the RPC.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="Call.details"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.Call.details">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<div class="viewcode-block" id="Call.details"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.Call.details">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<span class="k">async</span> <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="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="sd">"""Accesses the details sent by the server.</span>
|
||||
|
||||
|
|
@ -207,7 +207,7 @@
|
|||
<span class="sd"> The details string of the RPC.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="Call.wait_for_connection"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.Call.wait_for_connection">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<div class="viewcode-block" id="Call.wait_for_connection"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.Call.wait_for_connection">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<span class="k">async</span> <span class="k">def</span> <span class="nf">wait_for_connection</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="sd">"""Waits until connected to peer and raises aio.AioRpcError if failed.</span>
|
||||
|
||||
|
|
@ -221,12 +221,12 @@
|
|||
<span class="sd"> """</span></div></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="UnaryUnaryCall"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.UnaryUnaryCall">[docs]</a><span class="k">class</span> <span class="nc">UnaryUnaryCall</span><span class="p">(</span><span class="n">Generic</span><span class="p">[</span><span class="n">RequestType</span><span class="p">,</span> <span class="n">ResponseType</span><span class="p">],</span>
|
||||
<div class="viewcode-block" id="UnaryUnaryCall"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.UnaryUnaryCall">[docs]</a><span class="k">class</span> <span class="nc">UnaryUnaryCall</span><span class="p">(</span><span class="n">Generic</span><span class="p">[</span><span class="n">RequestType</span><span class="p">,</span> <span class="n">ResponseType</span><span class="p">],</span>
|
||||
<span class="n">Call</span><span class="p">,</span>
|
||||
<span class="n">metaclass</span><span class="o">=</span><span class="n">ABCMeta</span><span class="p">):</span>
|
||||
<span class="sd">"""The abstract base class of an unary-unary RPC on the client-side."""</span>
|
||||
|
||||
<div class="viewcode-block" id="UnaryUnaryCall.__await__"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.UnaryUnaryCall.__await__">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<div class="viewcode-block" id="UnaryUnaryCall.__await__"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.UnaryUnaryCall.__await__">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<span class="k">def</span> <span class="fm">__await__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Awaitable</span><span class="p">[</span><span class="n">ResponseType</span><span class="p">]:</span>
|
||||
<span class="sd">"""Await the response message to be ready.</span>
|
||||
|
||||
|
|
@ -235,11 +235,11 @@
|
|||
<span class="sd"> """</span></div></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="UnaryStreamCall"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.UnaryStreamCall">[docs]</a><span class="k">class</span> <span class="nc">UnaryStreamCall</span><span class="p">(</span><span class="n">Generic</span><span class="p">[</span><span class="n">RequestType</span><span class="p">,</span> <span class="n">ResponseType</span><span class="p">],</span>
|
||||
<div class="viewcode-block" id="UnaryStreamCall"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.UnaryStreamCall">[docs]</a><span class="k">class</span> <span class="nc">UnaryStreamCall</span><span class="p">(</span><span class="n">Generic</span><span class="p">[</span><span class="n">RequestType</span><span class="p">,</span> <span class="n">ResponseType</span><span class="p">],</span>
|
||||
<span class="n">Call</span><span class="p">,</span>
|
||||
<span class="n">metaclass</span><span class="o">=</span><span class="n">ABCMeta</span><span class="p">):</span>
|
||||
|
||||
<div class="viewcode-block" id="UnaryStreamCall.__aiter__"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.UnaryStreamCall.__aiter__">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<div class="viewcode-block" id="UnaryStreamCall.__aiter__"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.UnaryStreamCall.__aiter__">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<span class="k">def</span> <span class="fm">__aiter__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">AsyncIterable</span><span class="p">[</span><span class="n">ResponseType</span><span class="p">]:</span>
|
||||
<span class="sd">"""Returns the async iterable representation that yields messages.</span>
|
||||
|
||||
|
|
@ -249,7 +249,7 @@
|
|||
<span class="sd"> An async iterable object that yields messages.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="UnaryStreamCall.read"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.UnaryStreamCall.read">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<div class="viewcode-block" id="UnaryStreamCall.read"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.UnaryStreamCall.read">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<span class="k">async</span> <span class="k">def</span> <span class="nf">read</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Union</span><span class="p">[</span><span class="n">EOFType</span><span class="p">,</span> <span class="n">ResponseType</span><span class="p">]:</span>
|
||||
<span class="sd">"""Reads one message from the stream.</span>
|
||||
|
||||
|
|
@ -262,11 +262,11 @@
|
|||
<span class="sd"> """</span></div></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="StreamUnaryCall"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.StreamUnaryCall">[docs]</a><span class="k">class</span> <span class="nc">StreamUnaryCall</span><span class="p">(</span><span class="n">Generic</span><span class="p">[</span><span class="n">RequestType</span><span class="p">,</span> <span class="n">ResponseType</span><span class="p">],</span>
|
||||
<div class="viewcode-block" id="StreamUnaryCall"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.StreamUnaryCall">[docs]</a><span class="k">class</span> <span class="nc">StreamUnaryCall</span><span class="p">(</span><span class="n">Generic</span><span class="p">[</span><span class="n">RequestType</span><span class="p">,</span> <span class="n">ResponseType</span><span class="p">],</span>
|
||||
<span class="n">Call</span><span class="p">,</span>
|
||||
<span class="n">metaclass</span><span class="o">=</span><span class="n">ABCMeta</span><span class="p">):</span>
|
||||
|
||||
<div class="viewcode-block" id="StreamUnaryCall.write"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.StreamUnaryCall.write">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<div class="viewcode-block" id="StreamUnaryCall.write"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.StreamUnaryCall.write">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<span class="k">async</span> <span class="k">def</span> <span class="nf">write</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">RequestType</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="sd">"""Writes one message to the stream.</span>
|
||||
|
||||
|
|
@ -274,7 +274,7 @@
|
|||
<span class="sd"> An RpcError exception if the write failed.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="StreamUnaryCall.done_writing"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.StreamUnaryCall.done_writing">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<div class="viewcode-block" id="StreamUnaryCall.done_writing"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.StreamUnaryCall.done_writing">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<span class="k">async</span> <span class="k">def</span> <span class="nf">done_writing</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="sd">"""Notifies server that the client is done sending messages.</span>
|
||||
|
||||
|
|
@ -282,7 +282,7 @@
|
|||
<span class="sd"> function will fail. This function is idempotent.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="StreamUnaryCall.__await__"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.StreamUnaryCall.__await__">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<div class="viewcode-block" id="StreamUnaryCall.__await__"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.StreamUnaryCall.__await__">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<span class="k">def</span> <span class="fm">__await__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Awaitable</span><span class="p">[</span><span class="n">ResponseType</span><span class="p">]:</span>
|
||||
<span class="sd">"""Await the response message to be ready.</span>
|
||||
|
||||
|
|
@ -291,11 +291,11 @@
|
|||
<span class="sd"> """</span></div></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="StreamStreamCall"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.StreamStreamCall">[docs]</a><span class="k">class</span> <span class="nc">StreamStreamCall</span><span class="p">(</span><span class="n">Generic</span><span class="p">[</span><span class="n">RequestType</span><span class="p">,</span> <span class="n">ResponseType</span><span class="p">],</span>
|
||||
<div class="viewcode-block" id="StreamStreamCall"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.StreamStreamCall">[docs]</a><span class="k">class</span> <span class="nc">StreamStreamCall</span><span class="p">(</span><span class="n">Generic</span><span class="p">[</span><span class="n">RequestType</span><span class="p">,</span> <span class="n">ResponseType</span><span class="p">],</span>
|
||||
<span class="n">Call</span><span class="p">,</span>
|
||||
<span class="n">metaclass</span><span class="o">=</span><span class="n">ABCMeta</span><span class="p">):</span>
|
||||
|
||||
<div class="viewcode-block" id="StreamStreamCall.__aiter__"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.StreamStreamCall.__aiter__">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<div class="viewcode-block" id="StreamStreamCall.__aiter__"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.StreamStreamCall.__aiter__">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<span class="k">def</span> <span class="fm">__aiter__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">AsyncIterable</span><span class="p">[</span><span class="n">ResponseType</span><span class="p">]:</span>
|
||||
<span class="sd">"""Returns the async iterable representation that yields messages.</span>
|
||||
|
||||
|
|
@ -305,7 +305,7 @@
|
|||
<span class="sd"> An async iterable object that yields messages.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="StreamStreamCall.read"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.StreamStreamCall.read">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<div class="viewcode-block" id="StreamStreamCall.read"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.StreamStreamCall.read">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<span class="k">async</span> <span class="k">def</span> <span class="nf">read</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Union</span><span class="p">[</span><span class="n">EOFType</span><span class="p">,</span> <span class="n">ResponseType</span><span class="p">]:</span>
|
||||
<span class="sd">"""Reads one message from the stream.</span>
|
||||
|
||||
|
|
@ -317,7 +317,7 @@
|
|||
<span class="sd"> stream.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="StreamStreamCall.write"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.StreamStreamCall.write">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<div class="viewcode-block" id="StreamStreamCall.write"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.StreamStreamCall.write">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<span class="k">async</span> <span class="k">def</span> <span class="nf">write</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">RequestType</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="sd">"""Writes one message to the stream.</span>
|
||||
|
||||
|
|
@ -325,7 +325,7 @@
|
|||
<span class="sd"> An RpcError exception if the write failed.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="StreamStreamCall.done_writing"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.StreamStreamCall.done_writing">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<div class="viewcode-block" id="StreamStreamCall.done_writing"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.StreamStreamCall.done_writing">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<span class="k">async</span> <span class="k">def</span> <span class="nf">done_writing</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="sd">"""Notifies server that the client is done sending messages.</span>
|
||||
|
||||
|
|
@ -4,19 +4,19 @@
|
|||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>grpc.experimental.aio._base_channel — gRPC Python 1.31.0 documentation</title>
|
||||
<link rel="stylesheet" href="../../../../_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../../_static/jquery.js"></script>
|
||||
<script src="../../../../_static/underscore.js"></script>
|
||||
<script src="../../../../_static/doctools.js"></script>
|
||||
<script src="../../../../_static/language_data.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>grpc.aio._base_channel — gRPC Python 1.32.0 documentation</title>
|
||||
<link rel="stylesheet" href="../../../_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../_static/jquery.js"></script>
|
||||
<script src="../../../_static/underscore.js"></script>
|
||||
<script src="../../../_static/doctools.js"></script>
|
||||
<script src="../../../_static/language_data.js"></script>
|
||||
<link rel="index" title="Index" href="../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../search.html" />
|
||||
|
||||
<link rel="stylesheet" href="../../../../_static/custom.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
|
@ -26,11 +26,11 @@
|
|||
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h1 class="logo"><a href="../../../../index.html">gRPC Python</a></h1>
|
||||
<h1 class="logo"><a href="../../../index.html">gRPC Python</a></h1>
|
||||
|
||||
|
||||
|
||||
<p class="blurb">1.31.0</p>
|
||||
<p class="blurb">1.32.0</p>
|
||||
|
||||
|
||||
|
||||
|
|
@ -40,22 +40,22 @@
|
|||
<h3>Navigation</h3>
|
||||
<p class="caption"><span class="caption-text">Contents:</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc.html">gRPC</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_asyncio.html">gRPC AsyncIO API</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_channelz.html">gRPC Channelz</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_health_checking.html">gRPC Health Checking</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_reflection.html">gRPC Reflection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_status.html">gRPC Status</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_testing.html">gRPC Testing</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../glossary.html">Glossary</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc.html">gRPC</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_asyncio.html">gRPC AsyncIO API</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_channelz.html">gRPC Channelz</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_health_checking.html">gRPC Health Checking</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_reflection.html">gRPC Reflection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_status.html">gRPC Status</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_testing.html">gRPC Testing</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../glossary.html">Glossary</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../../../../index.html">Documentation overview</a><ul>
|
||||
<li><a href="../../../index.html">Module code</a><ul>
|
||||
<li><a href="../../../grpc.html">grpc</a><ul>
|
||||
<li><a href="../../../index.html">Documentation overview</a><ul>
|
||||
<li><a href="../../index.html">Module code</a><ul>
|
||||
<li><a href="../../grpc.html">grpc</a><ul>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
|
|
@ -64,7 +64,7 @@
|
|||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../../../../search.html" method="get">
|
||||
<form class="search" action="../../../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
|
|
@ -87,7 +87,7 @@
|
|||
|
||||
<div class="body" role="main">
|
||||
|
||||
<h1>Source code for grpc.experimental.aio._base_channel</h1><div class="highlight"><pre>
|
||||
<h1>Source code for grpc.aio._base_channel</h1><div class="highlight"><pre>
|
||||
<span></span><span class="c1"># Copyright 2020 The gRPC Authors</span>
|
||||
<span class="c1">#</span>
|
||||
<span class="c1"># Licensed under the Apache License, Version 2.0 (the "License");</span>
|
||||
|
|
@ -114,10 +114,10 @@
|
|||
<span class="kn">from</span> <span class="nn">._metadata</span> <span class="kn">import</span> <span class="n">Metadata</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="UnaryUnaryMultiCallable"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.UnaryUnaryMultiCallable">[docs]</a><span class="k">class</span> <span class="nc">UnaryUnaryMultiCallable</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABC</span><span class="p">):</span>
|
||||
<div class="viewcode-block" id="UnaryUnaryMultiCallable"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.UnaryUnaryMultiCallable">[docs]</a><span class="k">class</span> <span class="nc">UnaryUnaryMultiCallable</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABC</span><span class="p">):</span>
|
||||
<span class="sd">"""Enables asynchronous invocation of a unary-call RPC."""</span>
|
||||
|
||||
<div class="viewcode-block" id="UnaryUnaryMultiCallable.__call__"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.UnaryUnaryMultiCallable.__call__">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<div class="viewcode-block" id="UnaryUnaryMultiCallable.__call__"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.UnaryUnaryMultiCallable.__call__">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<span class="k">def</span> <span class="fm">__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">Any</span><span class="p">,</span>
|
||||
<span class="o">*</span><span class="p">,</span>
|
||||
|
|
@ -152,10 +152,10 @@
|
|||
<span class="sd"> """</span></div></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="UnaryStreamMultiCallable"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.UnaryStreamMultiCallable">[docs]</a><span class="k">class</span> <span class="nc">UnaryStreamMultiCallable</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABC</span><span class="p">):</span>
|
||||
<div class="viewcode-block" id="UnaryStreamMultiCallable"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.UnaryStreamMultiCallable">[docs]</a><span class="k">class</span> <span class="nc">UnaryStreamMultiCallable</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABC</span><span class="p">):</span>
|
||||
<span class="sd">"""Enables asynchronous invocation of a server-streaming RPC."""</span>
|
||||
|
||||
<div class="viewcode-block" id="UnaryStreamMultiCallable.__call__"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.UnaryStreamMultiCallable.__call__">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<div class="viewcode-block" id="UnaryStreamMultiCallable.__call__"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.UnaryStreamMultiCallable.__call__">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<span class="k">def</span> <span class="fm">__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">Any</span><span class="p">,</span>
|
||||
<span class="o">*</span><span class="p">,</span>
|
||||
|
|
@ -190,10 +190,10 @@
|
|||
<span class="sd"> """</span></div></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="StreamUnaryMultiCallable"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.StreamUnaryMultiCallable">[docs]</a><span class="k">class</span> <span class="nc">StreamUnaryMultiCallable</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABC</span><span class="p">):</span>
|
||||
<div class="viewcode-block" id="StreamUnaryMultiCallable"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.StreamUnaryMultiCallable">[docs]</a><span class="k">class</span> <span class="nc">StreamUnaryMultiCallable</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABC</span><span class="p">):</span>
|
||||
<span class="sd">"""Enables asynchronous invocation of a client-streaming RPC."""</span>
|
||||
|
||||
<div class="viewcode-block" id="StreamUnaryMultiCallable.__call__"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.StreamUnaryMultiCallable.__call__">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<div class="viewcode-block" id="StreamUnaryMultiCallable.__call__"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.StreamUnaryMultiCallable.__call__">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<span class="k">def</span> <span class="fm">__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">Optional</span><span class="p">[</span><span class="n">RequestIterableType</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">timeout</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">float</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
|
|
@ -228,10 +228,10 @@
|
|||
<span class="sd"> """</span></div></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="StreamStreamMultiCallable"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.StreamStreamMultiCallable">[docs]</a><span class="k">class</span> <span class="nc">StreamStreamMultiCallable</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABC</span><span class="p">):</span>
|
||||
<div class="viewcode-block" id="StreamStreamMultiCallable"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.StreamStreamMultiCallable">[docs]</a><span class="k">class</span> <span class="nc">StreamStreamMultiCallable</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABC</span><span class="p">):</span>
|
||||
<span class="sd">"""Enables asynchronous invocation of a bidirectional-streaming RPC."""</span>
|
||||
|
||||
<div class="viewcode-block" id="StreamStreamMultiCallable.__call__"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.StreamStreamMultiCallable.__call__">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<div class="viewcode-block" id="StreamStreamMultiCallable.__call__"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.StreamStreamMultiCallable.__call__">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<span class="k">def</span> <span class="fm">__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">Optional</span><span class="p">[</span><span class="n">RequestIterableType</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">timeout</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">float</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
|
|
@ -266,7 +266,7 @@
|
|||
<span class="sd"> """</span></div></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="Channel"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.Channel">[docs]</a><span class="k">class</span> <span class="nc">Channel</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABC</span><span class="p">):</span>
|
||||
<div class="viewcode-block" id="Channel"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.Channel">[docs]</a><span class="k">class</span> <span class="nc">Channel</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABC</span><span class="p">):</span>
|
||||
<span class="sd">"""Enables asynchronous RPC invocation as a client.</span>
|
||||
|
||||
<span class="sd"> Channel objects implement the Asynchronous Context Manager (aka. async</span>
|
||||
|
|
@ -274,7 +274,7 @@
|
|||
<span class="sd"> multiple times.</span>
|
||||
<span class="sd"> """</span>
|
||||
|
||||
<div class="viewcode-block" id="Channel.__aenter__"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.Channel.__aenter__">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<div class="viewcode-block" id="Channel.__aenter__"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.Channel.__aenter__">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<span class="k">async</span> <span class="k">def</span> <span class="fm">__aenter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="sd">"""Starts an asynchronous context manager.</span>
|
||||
|
||||
|
|
@ -282,14 +282,14 @@
|
|||
<span class="sd"> Channel the channel that was instantiated.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="Channel.__aexit__"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.Channel.__aexit__">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<div class="viewcode-block" id="Channel.__aexit__"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.Channel.__aexit__">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<span class="k">async</span> <span class="k">def</span> <span class="fm">__aexit__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">exc_type</span><span class="p">,</span> <span class="n">exc_val</span><span class="p">,</span> <span class="n">exc_tb</span><span class="p">):</span>
|
||||
<span class="sd">"""Finishes the asynchronous context manager by closing the channel.</span>
|
||||
|
||||
<span class="sd"> Still active RPCs will be cancelled.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="Channel.close"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.Channel.close">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<div class="viewcode-block" id="Channel.close"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.Channel.close">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<span class="k">async</span> <span class="k">def</span> <span class="nf">close</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">grace</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">float</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">):</span>
|
||||
<span class="sd">"""Closes this Channel and releases all resources held by it.</span>
|
||||
|
||||
|
|
@ -304,7 +304,7 @@
|
|||
<span class="sd"> This method is idempotent.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="Channel.get_state"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.Channel.get_state">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<div class="viewcode-block" id="Channel.get_state"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.Channel.get_state">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<span class="k">def</span> <span class="nf">get_state</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
|
||||
<span class="n">try_to_connect</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">)</span> <span class="o">-></span> <span class="n">grpc</span><span class="o">.</span><span class="n">ChannelConnectivity</span><span class="p">:</span>
|
||||
<span class="sd">"""Checks the connectivity state of a channel.</span>
|
||||
|
|
@ -322,7 +322,7 @@
|
|||
<span class="sd"> Returns: A ChannelConnectivity object.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="Channel.wait_for_state_change"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.Channel.wait_for_state_change">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<div class="viewcode-block" id="Channel.wait_for_state_change"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.Channel.wait_for_state_change">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<span class="k">async</span> <span class="k">def</span> <span class="nf">wait_for_state_change</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="n">last_observed_state</span><span class="p">:</span> <span class="n">grpc</span><span class="o">.</span><span class="n">ChannelConnectivity</span><span class="p">,</span>
|
||||
|
|
@ -348,11 +348,11 @@
|
|||
<span class="sd"> the last known state.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="Channel.channel_ready"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.Channel.channel_ready">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<div class="viewcode-block" id="Channel.channel_ready"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.Channel.channel_ready">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<span class="k">async</span> <span class="k">def</span> <span class="nf">channel_ready</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="sd">"""Creates a coroutine that blocks until the Channel is READY."""</span></div>
|
||||
|
||||
<div class="viewcode-block" id="Channel.unary_unary"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.Channel.unary_unary">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<div class="viewcode-block" id="Channel.unary_unary"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.Channel.unary_unary">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<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">method</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
|
|
@ -373,7 +373,7 @@
|
|||
<span class="sd"> A UnaryUnaryMultiCallable value for the named unary-unary method.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="Channel.unary_stream"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.Channel.unary_stream">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<div class="viewcode-block" id="Channel.unary_stream"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.Channel.unary_stream">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<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">method</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
|
|
@ -394,7 +394,7 @@
|
|||
<span class="sd"> A UnarySteramMultiCallable value for the named unary-stream method.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="Channel.stream_unary"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.Channel.stream_unary">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<div class="viewcode-block" id="Channel.stream_unary"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.Channel.stream_unary">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<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">method</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
|
|
@ -415,7 +415,7 @@
|
|||
<span class="sd"> A StreamUnaryMultiCallable value for the named stream-unary method.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="Channel.stream_stream"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.Channel.stream_stream">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<div class="viewcode-block" id="Channel.stream_stream"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.Channel.stream_stream">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<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">method</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
|
|
@ -4,19 +4,19 @@
|
|||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>grpc.experimental.aio._base_server — gRPC Python 1.31.0 documentation</title>
|
||||
<link rel="stylesheet" href="../../../../_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../../_static/jquery.js"></script>
|
||||
<script src="../../../../_static/underscore.js"></script>
|
||||
<script src="../../../../_static/doctools.js"></script>
|
||||
<script src="../../../../_static/language_data.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>grpc.aio._base_server — gRPC Python 1.32.0 documentation</title>
|
||||
<link rel="stylesheet" href="../../../_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../_static/jquery.js"></script>
|
||||
<script src="../../../_static/underscore.js"></script>
|
||||
<script src="../../../_static/doctools.js"></script>
|
||||
<script src="../../../_static/language_data.js"></script>
|
||||
<link rel="index" title="Index" href="../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../search.html" />
|
||||
|
||||
<link rel="stylesheet" href="../../../../_static/custom.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
|
@ -26,11 +26,11 @@
|
|||
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h1 class="logo"><a href="../../../../index.html">gRPC Python</a></h1>
|
||||
<h1 class="logo"><a href="../../../index.html">gRPC Python</a></h1>
|
||||
|
||||
|
||||
|
||||
<p class="blurb">1.31.0</p>
|
||||
<p class="blurb">1.32.0</p>
|
||||
|
||||
|
||||
|
||||
|
|
@ -40,22 +40,22 @@
|
|||
<h3>Navigation</h3>
|
||||
<p class="caption"><span class="caption-text">Contents:</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc.html">gRPC</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_asyncio.html">gRPC AsyncIO API</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_channelz.html">gRPC Channelz</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_health_checking.html">gRPC Health Checking</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_reflection.html">gRPC Reflection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_status.html">gRPC Status</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_testing.html">gRPC Testing</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../glossary.html">Glossary</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc.html">gRPC</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_asyncio.html">gRPC AsyncIO API</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_channelz.html">gRPC Channelz</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_health_checking.html">gRPC Health Checking</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_reflection.html">gRPC Reflection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_status.html">gRPC Status</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_testing.html">gRPC Testing</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../glossary.html">Glossary</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../../../../index.html">Documentation overview</a><ul>
|
||||
<li><a href="../../../index.html">Module code</a><ul>
|
||||
<li><a href="../../../grpc.html">grpc</a><ul>
|
||||
<li><a href="../../../index.html">Documentation overview</a><ul>
|
||||
<li><a href="../../index.html">Module code</a><ul>
|
||||
<li><a href="../../grpc.html">grpc</a><ul>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
|
|
@ -64,7 +64,7 @@
|
|||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../../../../search.html" method="get">
|
||||
<form class="search" action="../../../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
|
|
@ -87,7 +87,7 @@
|
|||
|
||||
<div class="body" role="main">
|
||||
|
||||
<h1>Source code for grpc.experimental.aio._base_server</h1><div class="highlight"><pre>
|
||||
<h1>Source code for grpc.aio._base_server</h1><div class="highlight"><pre>
|
||||
<span></span><span class="c1"># Copyright 2020 The gRPC Authors</span>
|
||||
<span class="c1">#</span>
|
||||
<span class="c1"># Licensed under the Apache License, Version 2.0 (the "License");</span>
|
||||
|
|
@ -112,10 +112,10 @@
|
|||
<span class="kn">from</span> <span class="nn">._metadata</span> <span class="kn">import</span> <span class="n">Metadata</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="Server"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.Server">[docs]</a><span class="k">class</span> <span class="nc">Server</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABC</span><span class="p">):</span>
|
||||
<div class="viewcode-block" id="Server"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.Server">[docs]</a><span class="k">class</span> <span class="nc">Server</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABC</span><span class="p">):</span>
|
||||
<span class="sd">"""Serves RPCs."""</span>
|
||||
|
||||
<div class="viewcode-block" id="Server.add_generic_rpc_handlers"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.Server.add_generic_rpc_handlers">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<div class="viewcode-block" id="Server.add_generic_rpc_handlers"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.Server.add_generic_rpc_handlers">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<span class="k">def</span> <span class="nf">add_generic_rpc_handlers</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span>
|
||||
<span class="n">generic_rpc_handlers</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="n">grpc</span><span class="o">.</span><span class="n">GenericRpcHandler</span><span class="p">])</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
|
|
@ -128,7 +128,7 @@
|
|||
<span class="sd"> used to service RPCs.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="Server.add_insecure_port"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.Server.add_insecure_port">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<div class="viewcode-block" id="Server.add_insecure_port"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.Server.add_insecure_port">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<span class="k">def</span> <span class="nf">add_insecure_port</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">address</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="nb">int</span><span class="p">:</span>
|
||||
<span class="sd">"""Opens an insecure port for accepting RPCs.</span>
|
||||
|
||||
|
|
@ -145,7 +145,7 @@
|
|||
<span class="sd"> An integer port on which the server will accept RPC requests.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="Server.add_secure_port"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.Server.add_secure_port">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<div class="viewcode-block" id="Server.add_secure_port"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.Server.add_secure_port">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<span class="k">def</span> <span class="nf">add_secure_port</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">address</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="n">server_credentials</span><span class="p">:</span> <span class="n">grpc</span><span class="o">.</span><span class="n">ServerCredentials</span><span class="p">)</span> <span class="o">-></span> <span class="nb">int</span><span class="p">:</span>
|
||||
<span class="sd">"""Opens a secure port for accepting RPCs.</span>
|
||||
|
|
@ -165,14 +165,14 @@
|
|||
<span class="sd"> An integer port on which the server will accept RPC requests.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="Server.start"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.Server.start">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<div class="viewcode-block" id="Server.start"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.Server.start">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<span class="k">async</span> <span class="k">def</span> <span class="nf">start</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="sd">"""Starts this Server.</span>
|
||||
|
||||
<span class="sd"> This method may only be called once. (i.e. it is not idempotent).</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="Server.stop"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.Server.stop">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<div class="viewcode-block" id="Server.stop"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.Server.stop">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<span class="k">async</span> <span class="k">def</span> <span class="nf">stop</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">grace</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">float</span><span class="p">])</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="sd">"""Stops this Server.</span>
|
||||
|
||||
|
|
@ -196,7 +196,7 @@
|
|||
<span class="sd"> grace: A duration of time in seconds or None.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="Server.wait_for_termination"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.Server.wait_for_termination">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<div class="viewcode-block" id="Server.wait_for_termination"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.Server.wait_for_termination">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<span class="k">async</span> <span class="k">def</span> <span class="nf">wait_for_termination</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
|
||||
<span class="n">timeout</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">float</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span>
|
||||
<span class="sd">"""Continues current coroutine once the server stops.</span>
|
||||
|
|
@ -221,10 +221,10 @@
|
|||
<span class="sd"> """</span></div></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="ServicerContext"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.ServicerContext">[docs]</a><span class="k">class</span> <span class="nc">ServicerContext</span><span class="p">(</span><span class="n">Generic</span><span class="p">[</span><span class="n">RequestType</span><span class="p">,</span> <span class="n">ResponseType</span><span class="p">],</span> <span class="n">abc</span><span class="o">.</span><span class="n">ABC</span><span class="p">):</span>
|
||||
<div class="viewcode-block" id="ServicerContext"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.ServicerContext">[docs]</a><span class="k">class</span> <span class="nc">ServicerContext</span><span class="p">(</span><span class="n">Generic</span><span class="p">[</span><span class="n">RequestType</span><span class="p">,</span> <span class="n">ResponseType</span><span class="p">],</span> <span class="n">abc</span><span class="o">.</span><span class="n">ABC</span><span class="p">):</span>
|
||||
<span class="sd">"""A context object passed to method implementations."""</span>
|
||||
|
||||
<div class="viewcode-block" id="ServicerContext.read"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.ServicerContext.read">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<div class="viewcode-block" id="ServicerContext.read"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.ServicerContext.read">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<span class="k">async</span> <span class="k">def</span> <span class="nf">read</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">RequestType</span><span class="p">:</span>
|
||||
<span class="sd">"""Reads one message from the RPC.</span>
|
||||
|
||||
|
|
@ -237,7 +237,7 @@
|
|||
<span class="sd"> An RpcError exception if the read failed.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="ServicerContext.write"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.ServicerContext.write">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<div class="viewcode-block" id="ServicerContext.write"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.ServicerContext.write">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<span class="k">async</span> <span class="k">def</span> <span class="nf">write</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="p">:</span> <span class="n">ResponseType</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="sd">"""Writes one message to the RPC.</span>
|
||||
|
||||
|
|
@ -247,7 +247,7 @@
|
|||
<span class="sd"> An RpcError exception if the write failed.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="ServicerContext.send_initial_metadata"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.ServicerContext.send_initial_metadata">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<div class="viewcode-block" id="ServicerContext.send_initial_metadata"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.ServicerContext.send_initial_metadata">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<span class="k">async</span> <span class="k">def</span> <span class="nf">send_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="n">Metadata</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="sd">"""Sends the initial metadata value to the client.</span>
|
||||
|
||||
|
|
@ -258,7 +258,7 @@
|
|||
<span class="sd"> initial_metadata: The initial :term:`metadata`.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="ServicerContext.abort"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.ServicerContext.abort">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<div class="viewcode-block" id="ServicerContext.abort"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.ServicerContext.abort">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<span class="k">async</span> <span class="k">def</span> <span class="nf">abort</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="n">grpc</span><span class="o">.</span><span class="n">StatusCode</span><span class="p">,</span> <span class="n">details</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="n">trailing_metadata</span><span class="p">:</span> <span class="n">Metadata</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="sd">"""Raises an exception to terminate the RPC with a non-OK status.</span>
|
||||
|
|
@ -279,7 +279,7 @@
|
|||
<span class="sd"> RPC to the gRPC runtime.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="ServicerContext.set_trailing_metadata"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.ServicerContext.set_trailing_metadata">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<div class="viewcode-block" id="ServicerContext.set_trailing_metadata"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.ServicerContext.set_trailing_metadata">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<span class="k">async</span> <span class="k">def</span> <span class="nf">set_trailing_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">trailing_metadata</span><span class="p">:</span> <span class="n">Metadata</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="sd">"""Sends the trailing metadata for the RPC.</span>
|
||||
|
||||
|
|
@ -290,7 +290,7 @@
|
|||
<span class="sd"> trailing_metadata: The trailing :term:`metadata`.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="ServicerContext.invocation_metadata"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.ServicerContext.invocation_metadata">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<div class="viewcode-block" id="ServicerContext.invocation_metadata"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.ServicerContext.invocation_metadata">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<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="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Metadata</span><span class="p">]:</span>
|
||||
<span class="sd">"""Accesses the metadata from the sent by the client.</span>
|
||||
|
||||
|
|
@ -298,7 +298,7 @@
|
|||
<span class="sd"> The invocation :term:`metadata`.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="ServicerContext.set_code"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.ServicerContext.set_code">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<div class="viewcode-block" id="ServicerContext.set_code"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.ServicerContext.set_code">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<span class="k">def</span> <span class="nf">set_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="n">grpc</span><span class="o">.</span><span class="n">StatusCode</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="sd">"""Sets the value to be used as status code upon RPC completion.</span>
|
||||
|
||||
|
|
@ -309,7 +309,7 @@
|
|||
<span class="sd"> code: A StatusCode object to be sent to the client.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="ServicerContext.set_details"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.ServicerContext.set_details">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<div class="viewcode-block" id="ServicerContext.set_details"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.ServicerContext.set_details">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<span class="k">def</span> <span class="nf">set_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="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="sd">"""Sets the value to be used the as detail string upon RPC completion.</span>
|
||||
|
||||
|
|
@ -321,7 +321,7 @@
|
|||
<span class="sd"> termination of the RPC.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="ServicerContext.set_compression"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.ServicerContext.set_compression">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<div class="viewcode-block" id="ServicerContext.set_compression"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.ServicerContext.set_compression">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<span class="k">def</span> <span class="nf">set_compression</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">compression</span><span class="p">:</span> <span class="n">grpc</span><span class="o">.</span><span class="n">Compression</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="sd">"""Set the compression algorithm to be used for the entire call.</span>
|
||||
|
||||
|
|
@ -332,7 +332,7 @@
|
|||
<span class="sd"> grpc.compression.Gzip.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="ServicerContext.disable_next_message_compression"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.ServicerContext.disable_next_message_compression">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<div class="viewcode-block" id="ServicerContext.disable_next_message_compression"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.ServicerContext.disable_next_message_compression">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<span class="k">def</span> <span class="nf">disable_next_message_compression</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="sd">"""Disables compression for the next response message.</span>
|
||||
|
||||
|
|
@ -342,7 +342,7 @@
|
|||
<span class="sd"> server creation or set on the call.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="ServicerContext.peer"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.ServicerContext.peer">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<div class="viewcode-block" id="ServicerContext.peer"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.ServicerContext.peer">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<span class="k">def</span> <span class="nf">peer</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="sd">"""Identifies the peer that invoked the RPC being serviced.</span>
|
||||
|
||||
|
|
@ -351,7 +351,7 @@
|
|||
<span class="sd"> The string format is determined by gRPC runtime.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="ServicerContext.peer_identities"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.ServicerContext.peer_identities">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<div class="viewcode-block" id="ServicerContext.peer_identities"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.ServicerContext.peer_identities">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<span class="k">def</span> <span class="nf">peer_identities</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Iterable</span><span class="p">[</span><span class="nb">bytes</span><span class="p">]]:</span>
|
||||
<span class="sd">"""Gets one or more peer identity(s).</span>
|
||||
|
||||
|
|
@ -363,7 +363,7 @@
|
|||
<span class="sd"> authenticated. Each identity is returned as a raw bytes type.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="ServicerContext.peer_identity_key"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.ServicerContext.peer_identity_key">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<div class="viewcode-block" id="ServicerContext.peer_identity_key"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.ServicerContext.peer_identity_key">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<span class="k">def</span> <span class="nf">peer_identity_key</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
|
||||
<span class="sd">"""The auth property used to identify the peer.</span>
|
||||
|
||||
|
|
@ -375,7 +375,7 @@
|
|||
<span class="sd"> peer identity, or None if the call is not authenticated.</span>
|
||||
<span class="sd"> """</span></div>
|
||||
|
||||
<div class="viewcode-block" id="ServicerContext.auth_context"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.ServicerContext.auth_context">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<div class="viewcode-block" id="ServicerContext.auth_context"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.ServicerContext.auth_context">[docs]</a> <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
|
||||
<span class="k">def</span> <span class="nf">auth_context</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Mapping</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Iterable</span><span class="p">[</span><span class="nb">bytes</span><span class="p">]]:</span>
|
||||
<span class="sd">"""Gets the auth context for the call.</span>
|
||||
|
||||
|
|
@ -4,19 +4,19 @@
|
|||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>grpc.experimental.aio._call — gRPC Python 1.31.0 documentation</title>
|
||||
<link rel="stylesheet" href="../../../../_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../../_static/jquery.js"></script>
|
||||
<script src="../../../../_static/underscore.js"></script>
|
||||
<script src="../../../../_static/doctools.js"></script>
|
||||
<script src="../../../../_static/language_data.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>grpc.aio._call — gRPC Python 1.32.0 documentation</title>
|
||||
<link rel="stylesheet" href="../../../_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../_static/jquery.js"></script>
|
||||
<script src="../../../_static/underscore.js"></script>
|
||||
<script src="../../../_static/doctools.js"></script>
|
||||
<script src="../../../_static/language_data.js"></script>
|
||||
<link rel="index" title="Index" href="../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../search.html" />
|
||||
|
||||
<link rel="stylesheet" href="../../../../_static/custom.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
|
@ -26,11 +26,11 @@
|
|||
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h1 class="logo"><a href="../../../../index.html">gRPC Python</a></h1>
|
||||
<h1 class="logo"><a href="../../../index.html">gRPC Python</a></h1>
|
||||
|
||||
|
||||
|
||||
<p class="blurb">1.31.0</p>
|
||||
<p class="blurb">1.32.0</p>
|
||||
|
||||
|
||||
|
||||
|
|
@ -40,22 +40,22 @@
|
|||
<h3>Navigation</h3>
|
||||
<p class="caption"><span class="caption-text">Contents:</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc.html">gRPC</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_asyncio.html">gRPC AsyncIO API</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_channelz.html">gRPC Channelz</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_health_checking.html">gRPC Health Checking</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_reflection.html">gRPC Reflection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_status.html">gRPC Status</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_testing.html">gRPC Testing</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../glossary.html">Glossary</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc.html">gRPC</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_asyncio.html">gRPC AsyncIO API</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_channelz.html">gRPC Channelz</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_health_checking.html">gRPC Health Checking</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_reflection.html">gRPC Reflection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_status.html">gRPC Status</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_testing.html">gRPC Testing</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../glossary.html">Glossary</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../../../../index.html">Documentation overview</a><ul>
|
||||
<li><a href="../../../index.html">Module code</a><ul>
|
||||
<li><a href="../../../grpc.html">grpc</a><ul>
|
||||
<li><a href="../../../index.html">Documentation overview</a><ul>
|
||||
<li><a href="../../index.html">Module code</a><ul>
|
||||
<li><a href="../../grpc.html">grpc</a><ul>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
|
|
@ -64,7 +64,7 @@
|
|||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../../../../search.html" method="get">
|
||||
<form class="search" action="../../../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
|
|
@ -87,7 +87,7 @@
|
|||
|
||||
<div class="body" role="main">
|
||||
|
||||
<h1>Source code for grpc.experimental.aio._call</h1><div class="highlight"><pre>
|
||||
<h1>Source code for grpc.aio._call</h1><div class="highlight"><pre>
|
||||
<span></span><span class="c1"># Copyright 2019 gRPC authors.</span>
|
||||
<span class="c1">#</span>
|
||||
<span class="c1"># Licensed under the Apache License, Version 2.0 (the "License");</span>
|
||||
|
|
@ -142,7 +142,7 @@
|
|||
<span class="n">_LOGGER</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="AioRpcError"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.AioRpcError">[docs]</a><span class="k">class</span> <span class="nc">AioRpcError</span><span class="p">(</span><span class="n">grpc</span><span class="o">.</span><span class="n">RpcError</span><span class="p">):</span>
|
||||
<div class="viewcode-block" id="AioRpcError"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.AioRpcError">[docs]</a><span class="k">class</span> <span class="nc">AioRpcError</span><span class="p">(</span><span class="n">grpc</span><span class="o">.</span><span class="n">RpcError</span><span class="p">):</span>
|
||||
<span class="sd">"""An implementation of RpcError to be used by the asynchronous API.</span>
|
||||
|
||||
<span class="sd"> Raised RpcError is a snapshot of the final status of the RPC, values are</span>
|
||||
|
|
@ -178,7 +178,7 @@
|
|||
<span class="bp">self</span><span class="o">.</span><span class="n">_trailing_metadata</span> <span class="o">=</span> <span class="n">trailing_metadata</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_debug_error_string</span> <span class="o">=</span> <span class="n">debug_error_string</span>
|
||||
|
||||
<div class="viewcode-block" id="AioRpcError.code"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.AioRpcError.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="o">-></span> <span class="n">grpc</span><span class="o">.</span><span class="n">StatusCode</span><span class="p">:</span>
|
||||
<div class="viewcode-block" id="AioRpcError.code"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.AioRpcError.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="o">-></span> <span class="n">grpc</span><span class="o">.</span><span class="n">StatusCode</span><span class="p">:</span>
|
||||
<span class="sd">"""Accesses the status code sent by the server.</span>
|
||||
|
||||
<span class="sd"> Returns:</span>
|
||||
|
|
@ -186,7 +186,7 @@
|
|||
<span class="sd"> """</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_code</span></div>
|
||||
|
||||
<div class="viewcode-block" id="AioRpcError.details"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.AioRpcError.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="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
|
||||
<div class="viewcode-block" id="AioRpcError.details"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.AioRpcError.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="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
|
||||
<span class="sd">"""Accesses the details sent by the server.</span>
|
||||
|
||||
<span class="sd"> Returns:</span>
|
||||
|
|
@ -194,7 +194,7 @@
|
|||
<span class="sd"> """</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_details</span></div>
|
||||
|
||||
<div class="viewcode-block" id="AioRpcError.initial_metadata"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.AioRpcError.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="o">-></span> <span class="n">Metadata</span><span class="p">:</span>
|
||||
<div class="viewcode-block" id="AioRpcError.initial_metadata"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.AioRpcError.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="o">-></span> <span class="n">Metadata</span><span class="p">:</span>
|
||||
<span class="sd">"""Accesses the initial metadata sent by the server.</span>
|
||||
|
||||
<span class="sd"> Returns:</span>
|
||||
|
|
@ -202,7 +202,7 @@
|
|||
<span class="sd"> """</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_initial_metadata</span></div>
|
||||
|
||||
<div class="viewcode-block" id="AioRpcError.trailing_metadata"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.AioRpcError.trailing_metadata">[docs]</a> <span class="k">def</span> <span class="nf">trailing_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Metadata</span><span class="p">:</span>
|
||||
<div class="viewcode-block" id="AioRpcError.trailing_metadata"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.AioRpcError.trailing_metadata">[docs]</a> <span class="k">def</span> <span class="nf">trailing_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Metadata</span><span class="p">:</span>
|
||||
<span class="sd">"""Accesses the trailing metadata sent by the server.</span>
|
||||
|
||||
<span class="sd"> Returns:</span>
|
||||
|
|
@ -210,7 +210,7 @@
|
|||
<span class="sd"> """</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_trailing_metadata</span></div>
|
||||
|
||||
<div class="viewcode-block" id="AioRpcError.debug_error_string"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.AioRpcError.debug_error_string">[docs]</a> <span class="k">def</span> <span class="nf">debug_error_string</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<div class="viewcode-block" id="AioRpcError.debug_error_string"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.AioRpcError.debug_error_string">[docs]</a> <span class="k">def</span> <span class="nf">debug_error_string</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
||||
<span class="sd">"""Accesses the debug error string sent by the server.</span>
|
||||
|
||||
<span class="sd"> Returns:</span>
|
||||
|
|
@ -4,19 +4,19 @@
|
|||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>grpc.experimental.aio._channel — gRPC Python 1.31.0 documentation</title>
|
||||
<link rel="stylesheet" href="../../../../_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../../_static/jquery.js"></script>
|
||||
<script src="../../../../_static/underscore.js"></script>
|
||||
<script src="../../../../_static/doctools.js"></script>
|
||||
<script src="../../../../_static/language_data.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>grpc.aio._channel — gRPC Python 1.32.0 documentation</title>
|
||||
<link rel="stylesheet" href="../../../_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../_static/jquery.js"></script>
|
||||
<script src="../../../_static/underscore.js"></script>
|
||||
<script src="../../../_static/doctools.js"></script>
|
||||
<script src="../../../_static/language_data.js"></script>
|
||||
<link rel="index" title="Index" href="../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../search.html" />
|
||||
|
||||
<link rel="stylesheet" href="../../../../_static/custom.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
|
@ -26,11 +26,11 @@
|
|||
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h1 class="logo"><a href="../../../../index.html">gRPC Python</a></h1>
|
||||
<h1 class="logo"><a href="../../../index.html">gRPC Python</a></h1>
|
||||
|
||||
|
||||
|
||||
<p class="blurb">1.31.0</p>
|
||||
<p class="blurb">1.32.0</p>
|
||||
|
||||
|
||||
|
||||
|
|
@ -40,22 +40,22 @@
|
|||
<h3>Navigation</h3>
|
||||
<p class="caption"><span class="caption-text">Contents:</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc.html">gRPC</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_asyncio.html">gRPC AsyncIO API</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_channelz.html">gRPC Channelz</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_health_checking.html">gRPC Health Checking</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_reflection.html">gRPC Reflection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_status.html">gRPC Status</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_testing.html">gRPC Testing</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../glossary.html">Glossary</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc.html">gRPC</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_asyncio.html">gRPC AsyncIO API</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_channelz.html">gRPC Channelz</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_health_checking.html">gRPC Health Checking</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_reflection.html">gRPC Reflection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_status.html">gRPC Status</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_testing.html">gRPC Testing</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../glossary.html">Glossary</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../../../../index.html">Documentation overview</a><ul>
|
||||
<li><a href="../../../index.html">Module code</a><ul>
|
||||
<li><a href="../../../grpc.html">grpc</a><ul>
|
||||
<li><a href="../../../index.html">Documentation overview</a><ul>
|
||||
<li><a href="../../index.html">Module code</a><ul>
|
||||
<li><a href="../../grpc.html">grpc</a><ul>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
|
|
@ -64,7 +64,7 @@
|
|||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../../../../search.html" method="get">
|
||||
<form class="search" action="../../../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
|
|
@ -87,7 +87,7 @@
|
|||
|
||||
<div class="body" role="main">
|
||||
|
||||
<h1>Source code for grpc.experimental.aio._channel</h1><div class="highlight"><pre>
|
||||
<h1>Source code for grpc.aio._channel</h1><div class="highlight"><pre>
|
||||
<span></span><span class="c1"># Copyright 2019 gRPC authors.</span>
|
||||
<span class="c1">#</span>
|
||||
<span class="c1"># Licensed under the Apache License, Version 2.0 (the "License");</span>
|
||||
|
|
@ -512,7 +512,7 @@
|
|||
<span class="bp">self</span><span class="o">.</span><span class="n">_loop</span><span class="p">)</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="insecure_channel"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.insecure_channel">[docs]</a><span class="k">def</span> <span class="nf">insecure_channel</span><span class="p">(</span>
|
||||
<div class="viewcode-block" id="insecure_channel"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.insecure_channel">[docs]</a><span class="k">def</span> <span class="nf">insecure_channel</span><span class="p">(</span>
|
||||
<span class="n">target</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="n">options</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">ChannelArgumentType</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">compression</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">grpc</span><span class="o">.</span><span class="n">Compression</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
|
|
@ -535,7 +535,7 @@
|
|||
<span class="n">compression</span><span class="p">,</span> <span class="n">interceptors</span><span class="p">)</span></div>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="secure_channel"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.secure_channel">[docs]</a><span class="k">def</span> <span class="nf">secure_channel</span><span class="p">(</span><span class="n">target</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<div class="viewcode-block" id="secure_channel"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.secure_channel">[docs]</a><span class="k">def</span> <span class="nf">secure_channel</span><span class="p">(</span><span class="n">target</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="n">credentials</span><span class="p">:</span> <span class="n">grpc</span><span class="o">.</span><span class="n">ChannelCredentials</span><span class="p">,</span>
|
||||
<span class="n">options</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">ChannelArgumentType</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">compression</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">grpc</span><span class="o">.</span><span class="n">Compression</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
|
|
@ -4,19 +4,19 @@
|
|||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>grpc.experimental.aio._interceptor — gRPC Python 1.31.0 documentation</title>
|
||||
<link rel="stylesheet" href="../../../../_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../../_static/jquery.js"></script>
|
||||
<script src="../../../../_static/underscore.js"></script>
|
||||
<script src="../../../../_static/doctools.js"></script>
|
||||
<script src="../../../../_static/language_data.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>grpc.aio._interceptor — gRPC Python 1.32.0 documentation</title>
|
||||
<link rel="stylesheet" href="../../../_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../_static/jquery.js"></script>
|
||||
<script src="../../../_static/underscore.js"></script>
|
||||
<script src="../../../_static/doctools.js"></script>
|
||||
<script src="../../../_static/language_data.js"></script>
|
||||
<link rel="index" title="Index" href="../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../search.html" />
|
||||
|
||||
<link rel="stylesheet" href="../../../../_static/custom.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
|
@ -26,11 +26,11 @@
|
|||
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h1 class="logo"><a href="../../../../index.html">gRPC Python</a></h1>
|
||||
<h1 class="logo"><a href="../../../index.html">gRPC Python</a></h1>
|
||||
|
||||
|
||||
|
||||
<p class="blurb">1.31.0</p>
|
||||
<p class="blurb">1.32.0</p>
|
||||
|
||||
|
||||
|
||||
|
|
@ -40,22 +40,22 @@
|
|||
<h3>Navigation</h3>
|
||||
<p class="caption"><span class="caption-text">Contents:</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc.html">gRPC</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_asyncio.html">gRPC AsyncIO API</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_channelz.html">gRPC Channelz</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_health_checking.html">gRPC Health Checking</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_reflection.html">gRPC Reflection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_status.html">gRPC Status</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_testing.html">gRPC Testing</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../glossary.html">Glossary</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc.html">gRPC</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_asyncio.html">gRPC AsyncIO API</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_channelz.html">gRPC Channelz</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_health_checking.html">gRPC Health Checking</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_reflection.html">gRPC Reflection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_status.html">gRPC Status</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_testing.html">gRPC Testing</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../glossary.html">Glossary</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../../../../index.html">Documentation overview</a><ul>
|
||||
<li><a href="../../../index.html">Module code</a><ul>
|
||||
<li><a href="../../../grpc.html">grpc</a><ul>
|
||||
<li><a href="../../../index.html">Documentation overview</a><ul>
|
||||
<li><a href="../../index.html">Module code</a><ul>
|
||||
<li><a href="../../grpc.html">grpc</a><ul>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
|
|
@ -64,7 +64,7 @@
|
|||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../../../../search.html" method="get">
|
||||
<form class="search" action="../../../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
|
|
@ -87,7 +87,7 @@
|
|||
|
||||
<div class="body" role="main">
|
||||
|
||||
<h1>Source code for grpc.experimental.aio._interceptor</h1><div class="highlight"><pre>
|
||||
<h1>Source code for grpc.aio._interceptor</h1><div class="highlight"><pre>
|
||||
<span></span><span class="c1"># Copyright 2019 gRPC authors.</span>
|
||||
<span class="c1">#</span>
|
||||
<span class="c1"># Licensed under the Apache License, Version 2.0 (the "License");</span>
|
||||
|
|
@ -152,7 +152,7 @@
|
|||
<span class="sd"> """</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="ClientCallDetails"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.ClientCallDetails">[docs]</a><span class="k">class</span> <span class="nc">ClientCallDetails</span><span class="p">(</span>
|
||||
<div class="viewcode-block" id="ClientCallDetails"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.ClientCallDetails">[docs]</a><span class="k">class</span> <span class="nc">ClientCallDetails</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="s1">'ClientCallDetails'</span><span class="p">,</span>
|
||||
<span class="p">(</span><span class="s1">'method'</span><span class="p">,</span> <span class="s1">'timeout'</span><span class="p">,</span> <span class="s1">'metadata'</span><span class="p">,</span> <span class="s1">'credentials'</span><span class="p">,</span> <span class="s1">'wait_for_ready'</span><span class="p">)),</span>
|
||||
|
|
@ -182,10 +182,10 @@
|
|||
<span class="sd">"""Base class used for all Aio Client Interceptor classes"""</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="UnaryUnaryClientInterceptor"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.UnaryUnaryClientInterceptor">[docs]</a><span class="k">class</span> <span class="nc">UnaryUnaryClientInterceptor</span><span class="p">(</span><span class="n">ClientInterceptor</span><span class="p">,</span> <span class="n">metaclass</span><span class="o">=</span><span class="n">ABCMeta</span><span class="p">):</span>
|
||||
<div class="viewcode-block" id="UnaryUnaryClientInterceptor"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.UnaryUnaryClientInterceptor">[docs]</a><span class="k">class</span> <span class="nc">UnaryUnaryClientInterceptor</span><span class="p">(</span><span class="n">ClientInterceptor</span><span class="p">,</span> <span class="n">metaclass</span><span class="o">=</span><span class="n">ABCMeta</span><span class="p">):</span>
|
||||
<span class="sd">"""Affords intercepting unary-unary invocations."""</span>
|
||||
|
||||
<div class="viewcode-block" id="UnaryUnaryClientInterceptor.intercept_unary_unary"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.UnaryUnaryClientInterceptor.intercept_unary_unary">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<div class="viewcode-block" id="UnaryUnaryClientInterceptor.intercept_unary_unary"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.UnaryUnaryClientInterceptor.intercept_unary_unary">[docs]</a> <span class="nd">@abstractmethod</span>
|
||||
<span class="k">async</span> <span class="k">def</span> <span class="nf">intercept_unary_unary</span><span class="p">(</span>
|
||||
<span class="bp">self</span><span class="p">,</span> <span class="n">continuation</span><span class="p">:</span> <span class="n">Callable</span><span class="p">[[</span><span class="n">ClientCallDetails</span><span class="p">,</span> <span class="n">RequestType</span><span class="p">],</span>
|
||||
<span class="n">UnaryUnaryCall</span><span class="p">],</span>
|
||||
|
|
@ -633,7 +633,7 @@
|
|||
<span class="n">return_when</span><span class="o">=</span><span class="n">asyncio</span><span class="o">.</span><span class="n">FIRST_COMPLETED</span><span class="p">)</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="InterceptedUnaryUnaryCall"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.InterceptedUnaryUnaryCall">[docs]</a><span class="k">class</span> <span class="nc">InterceptedUnaryUnaryCall</span><span class="p">(</span><span class="n">_InterceptedUnaryResponseMixin</span><span class="p">,</span> <span class="n">InterceptedCall</span><span class="p">,</span>
|
||||
<div class="viewcode-block" id="InterceptedUnaryUnaryCall"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.InterceptedUnaryUnaryCall">[docs]</a><span class="k">class</span> <span class="nc">InterceptedUnaryUnaryCall</span><span class="p">(</span><span class="n">_InterceptedUnaryResponseMixin</span><span class="p">,</span> <span class="n">InterceptedCall</span><span class="p">,</span>
|
||||
<span class="n">_base_call</span><span class="o">.</span><span class="n">UnaryUnaryCall</span><span class="p">):</span>
|
||||
<span class="sd">"""Used for running a `UnaryUnaryCall` wrapped by interceptors.</span>
|
||||
|
||||
|
|
@ -704,7 +704,7 @@
|
|||
<span class="k">return</span> <span class="k">await</span> <span class="n">_run_interceptor</span><span class="p">(</span><span class="nb">iter</span><span class="p">(</span><span class="n">interceptors</span><span class="p">),</span> <span class="n">client_call_details</span><span class="p">,</span>
|
||||
<span class="n">request</span><span class="p">)</span>
|
||||
|
||||
<div class="viewcode-block" id="InterceptedUnaryUnaryCall.time_remaining"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.InterceptedUnaryUnaryCall.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="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="nb">float</span><span class="p">]:</span>
|
||||
<div class="viewcode-block" id="InterceptedUnaryUnaryCall.time_remaining"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.InterceptedUnaryUnaryCall.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="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="nb">float</span><span class="p">]:</span>
|
||||
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>
|
||||
|
||||
|
||||
|
|
@ -4,19 +4,19 @@
|
|||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>grpc.experimental.aio._server — gRPC Python 1.31.0 documentation</title>
|
||||
<link rel="stylesheet" href="../../../../_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../../_static/jquery.js"></script>
|
||||
<script src="../../../../_static/underscore.js"></script>
|
||||
<script src="../../../../_static/doctools.js"></script>
|
||||
<script src="../../../../_static/language_data.js"></script>
|
||||
<link rel="index" title="Index" href="../../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../../search.html" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>grpc.aio._server — gRPC Python 1.32.0 documentation</title>
|
||||
<link rel="stylesheet" href="../../../_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
|
||||
<script src="../../../_static/jquery.js"></script>
|
||||
<script src="../../../_static/underscore.js"></script>
|
||||
<script src="../../../_static/doctools.js"></script>
|
||||
<script src="../../../_static/language_data.js"></script>
|
||||
<link rel="index" title="Index" href="../../../genindex.html" />
|
||||
<link rel="search" title="Search" href="../../../search.html" />
|
||||
|
||||
<link rel="stylesheet" href="../../../../_static/custom.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
|
@ -26,11 +26,11 @@
|
|||
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h1 class="logo"><a href="../../../../index.html">gRPC Python</a></h1>
|
||||
<h1 class="logo"><a href="../../../index.html">gRPC Python</a></h1>
|
||||
|
||||
|
||||
|
||||
<p class="blurb">1.31.0</p>
|
||||
<p class="blurb">1.32.0</p>
|
||||
|
||||
|
||||
|
||||
|
|
@ -40,22 +40,22 @@
|
|||
<h3>Navigation</h3>
|
||||
<p class="caption"><span class="caption-text">Contents:</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc.html">gRPC</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_asyncio.html">gRPC AsyncIO API</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_channelz.html">gRPC Channelz</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_health_checking.html">gRPC Health Checking</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_reflection.html">gRPC Reflection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_status.html">gRPC Status</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../grpc_testing.html">gRPC Testing</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../../glossary.html">Glossary</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc.html">gRPC</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_asyncio.html">gRPC AsyncIO API</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_channelz.html">gRPC Channelz</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_health_checking.html">gRPC Health Checking</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_reflection.html">gRPC Reflection</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_status.html">gRPC Status</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../grpc_testing.html">gRPC Testing</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../../../glossary.html">Glossary</a></li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="../../../../index.html">Documentation overview</a><ul>
|
||||
<li><a href="../../../index.html">Module code</a><ul>
|
||||
<li><a href="../../../grpc.html">grpc</a><ul>
|
||||
<li><a href="../../../index.html">Documentation overview</a><ul>
|
||||
<li><a href="../../index.html">Module code</a><ul>
|
||||
<li><a href="../../grpc.html">grpc</a><ul>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
</ul></li>
|
||||
|
|
@ -64,7 +64,7 @@
|
|||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="../../../../search.html" method="get">
|
||||
<form class="search" action="../../../search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
|
|
@ -87,7 +87,7 @@
|
|||
|
||||
<div class="body" role="main">
|
||||
|
||||
<h1>Source code for grpc.experimental.aio._server</h1><div class="highlight"><pre>
|
||||
<h1>Source code for grpc.aio._server</h1><div class="highlight"><pre>
|
||||
<span></span><span class="c1"># Copyright 2019 The gRPC Authors</span>
|
||||
<span class="c1">#</span>
|
||||
<span class="c1"># Licensed under the Apache License, Version 2.0 (the "License");</span>
|
||||
|
|
@ -170,7 +170,8 @@
|
|||
<span class="sd"> Returns:</span>
|
||||
<span class="sd"> An integer port on which the server will accept RPC requests.</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_server</span><span class="o">.</span><span class="n">add_insecure_port</span><span class="p">(</span><span class="n">_common</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">address</span><span class="p">))</span>
|
||||
<span class="k">return</span> <span class="n">_common</span><span class="o">.</span><span class="n">validate_port_binding_result</span><span class="p">(</span>
|
||||
<span class="n">address</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_server</span><span class="o">.</span><span class="n">add_insecure_port</span><span class="p">(</span><span class="n">_common</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">address</span><span class="p">)))</span>
|
||||
|
||||
<span class="k">def</span> <span class="nf">add_secure_port</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">address</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
||||
<span class="n">server_credentials</span><span class="p">:</span> <span class="n">grpc</span><span class="o">.</span><span class="n">ServerCredentials</span><span class="p">)</span> <span class="o">-></span> <span class="nb">int</span><span class="p">:</span>
|
||||
|
|
@ -187,8 +188,10 @@
|
|||
<span class="sd"> Returns:</span>
|
||||
<span class="sd"> An integer port on which the server will accept RPC requests.</span>
|
||||
<span class="sd"> """</span>
|
||||
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_server</span><span class="o">.</span><span class="n">add_secure_port</span><span class="p">(</span><span class="n">_common</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">address</span><span class="p">),</span>
|
||||
<span class="n">server_credentials</span><span class="p">)</span>
|
||||
<span class="k">return</span> <span class="n">_common</span><span class="o">.</span><span class="n">validate_port_binding_result</span><span class="p">(</span>
|
||||
<span class="n">address</span><span class="p">,</span>
|
||||
<span class="bp">self</span><span class="o">.</span><span class="n">_server</span><span class="o">.</span><span class="n">add_secure_port</span><span class="p">(</span><span class="n">_common</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="n">address</span><span class="p">),</span>
|
||||
<span class="n">server_credentials</span><span class="p">))</span>
|
||||
|
||||
<span class="k">async</span> <span class="k">def</span> <span class="nf">start</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
||||
<span class="sd">"""Starts this Server.</span>
|
||||
|
|
@ -259,7 +262,7 @@
|
|||
<span class="p">)</span>
|
||||
|
||||
|
||||
<div class="viewcode-block" id="server"><a class="viewcode-back" href="../../../../grpc_asyncio.html#grpc.experimental.aio.server">[docs]</a><span class="k">def</span> <span class="nf">server</span><span class="p">(</span><span class="n">migration_thread_pool</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Executor</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<div class="viewcode-block" id="server"><a class="viewcode-back" href="../../../grpc_asyncio.html#grpc.experimental.aio.server">[docs]</a><span class="k">def</span> <span class="nf">server</span><span class="p">(</span><span class="n">migration_thread_pool</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Executor</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">handlers</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Sequence</span><span class="p">[</span><span class="n">grpc</span><span class="o">.</span><span class="n">GenericRpcHandler</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">interceptors</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Sequence</span><span class="p">[</span><span class="n">Any</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
<span class="n">options</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">ChannelArgumentType</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
||||
|
|
@ -4,8 +4,8 @@
|
|||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>grpc_channelz.v1._servicer — gRPC Python 1.31.0 documentation</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>grpc_channelz.v1._servicer — gRPC Python 1.32.0 documentation</title>
|
||||
<link rel="stylesheet" href="../../../_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
|
||||
|
||||
|
||||
<p class="blurb">1.31.0</p>
|
||||
<p class="blurb">1.32.0</p>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -4,8 +4,8 @@
|
|||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>grpc_channelz.v1.channelz — gRPC Python 1.31.0 documentation</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>grpc_channelz.v1.channelz — gRPC Python 1.32.0 documentation</title>
|
||||
<link rel="stylesheet" href="../../../_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
|
||||
|
||||
|
||||
<p class="blurb">1.31.0</p>
|
||||
<p class="blurb">1.32.0</p>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -4,8 +4,8 @@
|
|||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>grpc_health.v1.health — gRPC Python 1.31.0 documentation</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>grpc_health.v1.health — gRPC Python 1.32.0 documentation</title>
|
||||
<link rel="stylesheet" href="../../../_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
|
||||
|
||||
|
||||
<p class="blurb">1.31.0</p>
|
||||
<p class="blurb">1.32.0</p>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -4,8 +4,8 @@
|
|||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>grpc_reflection.v1alpha.reflection — gRPC Python 1.31.0 documentation</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>grpc_reflection.v1alpha.reflection — gRPC Python 1.32.0 documentation</title>
|
||||
<link rel="stylesheet" href="../../../_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
|
||||
|
||||
|
||||
<p class="blurb">1.31.0</p>
|
||||
<p class="blurb">1.32.0</p>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -4,8 +4,8 @@
|
|||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>grpc_status.rpc_status — gRPC Python 1.31.0 documentation</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>grpc_status.rpc_status — gRPC Python 1.32.0 documentation</title>
|
||||
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
|
||||
|
||||
|
||||
<p class="blurb">1.31.0</p>
|
||||
<p class="blurb">1.32.0</p>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -4,8 +4,8 @@
|
|||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>grpc_testing — gRPC Python 1.31.0 documentation</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>grpc_testing — gRPC Python 1.32.0 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
|
||||
|
||||
|
||||
<p class="blurb">1.31.0</p>
|
||||
<p class="blurb">1.32.0</p>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -4,8 +4,8 @@
|
|||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>Overview: module code — gRPC Python 1.31.0 documentation</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Overview: module code — gRPC Python 1.32.0 documentation</title>
|
||||
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
|
||||
|
||||
|
||||
<p class="blurb">1.31.0</p>
|
||||
<p class="blurb">1.32.0</p>
|
||||
|
||||
|
||||
|
||||
|
|
@ -86,13 +86,14 @@
|
|||
<h1>All modules for which code is available</h1>
|
||||
<ul><li><a href="grpc.html">grpc</a></li>
|
||||
<ul><li><a href="grpc/_cython/cygrpc.html">grpc._cython.cygrpc</a></li>
|
||||
<li><a href="grpc/experimental/aio/_base_call.html">grpc.experimental.aio._base_call</a></li>
|
||||
<li><a href="grpc/experimental/aio/_base_channel.html">grpc.experimental.aio._base_channel</a></li>
|
||||
<li><a href="grpc/experimental/aio/_base_server.html">grpc.experimental.aio._base_server</a></li>
|
||||
<li><a href="grpc/experimental/aio/_call.html">grpc.experimental.aio._call</a></li>
|
||||
<li><a href="grpc/experimental/aio/_channel.html">grpc.experimental.aio._channel</a></li>
|
||||
<li><a href="grpc/experimental/aio/_interceptor.html">grpc.experimental.aio._interceptor</a></li>
|
||||
<li><a href="grpc/experimental/aio/_server.html">grpc.experimental.aio._server</a></li>
|
||||
<li><a href="grpc/_runtime_protos.html">grpc._runtime_protos</a></li>
|
||||
<li><a href="grpc/aio/_base_call.html">grpc.aio._base_call</a></li>
|
||||
<li><a href="grpc/aio/_base_channel.html">grpc.aio._base_channel</a></li>
|
||||
<li><a href="grpc/aio/_base_server.html">grpc.aio._base_server</a></li>
|
||||
<li><a href="grpc/aio/_call.html">grpc.aio._call</a></li>
|
||||
<li><a href="grpc/aio/_channel.html">grpc.aio._channel</a></li>
|
||||
<li><a href="grpc/aio/_interceptor.html">grpc.aio._interceptor</a></li>
|
||||
<li><a href="grpc/aio/_server.html">grpc.aio._server</a></li>
|
||||
</ul><li><a href="grpc_channelz/v1/_servicer.html">grpc_channelz.v1._servicer</a></li>
|
||||
<li><a href="grpc_channelz/v1/channelz.html">grpc_channelz.v1.channelz</a></li>
|
||||
<li><a href="grpc_health/v1/health.html">grpc_health.v1.health</a></li>
|
||||
|
|
|
|||
|
|
@ -41,6 +41,7 @@ Create Client Credentials
|
|||
.. autofunction:: composite_call_credentials
|
||||
.. autofunction:: composite_channel_credentials
|
||||
.. autofunction:: local_channel_credentials(local_connect_type=grpc.LocalConnectionType.LOCAL_TCP)
|
||||
.. autofunction:: compute_engine_channel_credentials
|
||||
|
||||
|
||||
Create Server
|
||||
|
|
@ -186,3 +187,10 @@ Compression
|
|||
^^^^^^^^^^^
|
||||
|
||||
.. autoclass:: Compression
|
||||
|
||||
Runtime Protobuf Parsing
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. autofunction:: protos
|
||||
.. autofunction:: services
|
||||
.. autofunction:: protos_and_services
|
||||
|
|
|
|||
Binary file not shown.
|
After Width: | Height: | Size: 673 B |
|
|
@ -693,7 +693,7 @@ pre {
|
|||
overflow-y: hidden; /* fixes display issues on Chrome browsers */
|
||||
}
|
||||
|
||||
pre, div[class|="highlight"] {
|
||||
pre, div[class*="highlight-"] {
|
||||
clear: both;
|
||||
}
|
||||
|
||||
|
|
@ -704,7 +704,7 @@ span.pre {
|
|||
hyphens: none;
|
||||
}
|
||||
|
||||
div[class^="highlight-"] {
|
||||
div[class*="highlight-"] {
|
||||
margin: 1em 0;
|
||||
}
|
||||
|
||||
|
|
|
|||
Binary file not shown.
|
After Width: | Height: | Size: 756 B |
Binary file not shown.
|
After Width: | Height: | Size: 829 B |
Binary file not shown.
|
After Width: | Height: | Size: 641 B |
|
|
@ -1,6 +1,6 @@
|
|||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
|
||||
VERSION: '1.31.0',
|
||||
VERSION: '1.32.0',
|
||||
LANGUAGE: 'en',
|
||||
COLLAPSE_INDEX: false,
|
||||
BUILDER: 'html',
|
||||
|
|
|
|||
Binary file not shown.
|
After Width: | Height: | Size: 222 B |
Binary file not shown.
|
After Width: | Height: | Size: 202 B |
File diff suppressed because it is too large
Load Diff
|
|
@ -166,8 +166,7 @@ var Search = {
|
|||
objectterms.push(tmp[i].toLowerCase());
|
||||
}
|
||||
|
||||
if ($u.indexOf(stopwords, tmp[i].toLowerCase()) != -1 || tmp[i].match(/^\d+$/) ||
|
||||
tmp[i] === "") {
|
||||
if ($u.indexOf(stopwords, tmp[i].toLowerCase()) != -1 || tmp[i] === "") {
|
||||
// skip this "word"
|
||||
continue;
|
||||
}
|
||||
|
|
|
|||
Binary file not shown.
|
After Width: | Height: | Size: 214 B |
Binary file not shown.
|
After Width: | Height: | Size: 203 B |
|
|
@ -0,0 +1,808 @@
|
|||
/*
|
||||
* websupport.js
|
||||
* ~~~~~~~~~~~~~
|
||||
*
|
||||
* sphinx.websupport utilities for all documentation.
|
||||
*
|
||||
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
(function($) {
|
||||
$.fn.autogrow = function() {
|
||||
return this.each(function() {
|
||||
var textarea = this;
|
||||
|
||||
$.fn.autogrow.resize(textarea);
|
||||
|
||||
$(textarea)
|
||||
.focus(function() {
|
||||
textarea.interval = setInterval(function() {
|
||||
$.fn.autogrow.resize(textarea);
|
||||
}, 500);
|
||||
})
|
||||
.blur(function() {
|
||||
clearInterval(textarea.interval);
|
||||
});
|
||||
});
|
||||
};
|
||||
|
||||
$.fn.autogrow.resize = function(textarea) {
|
||||
var lineHeight = parseInt($(textarea).css('line-height'), 10);
|
||||
var lines = textarea.value.split('\n');
|
||||
var columns = textarea.cols;
|
||||
var lineCount = 0;
|
||||
$.each(lines, function() {
|
||||
lineCount += Math.ceil(this.length / columns) || 1;
|
||||
});
|
||||
var height = lineHeight * (lineCount + 1);
|
||||
$(textarea).css('height', height);
|
||||
};
|
||||
})(jQuery);
|
||||
|
||||
(function($) {
|
||||
var comp, by;
|
||||
|
||||
function init() {
|
||||
initEvents();
|
||||
initComparator();
|
||||
}
|
||||
|
||||
function initEvents() {
|
||||
$(document).on("click", 'a.comment-close', function(event) {
|
||||
event.preventDefault();
|
||||
hide($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.vote', function(event) {
|
||||
event.preventDefault();
|
||||
handleVote($(this));
|
||||
});
|
||||
$(document).on("click", 'a.reply', function(event) {
|
||||
event.preventDefault();
|
||||
openReply($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.close-reply', function(event) {
|
||||
event.preventDefault();
|
||||
closeReply($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.sort-option', function(event) {
|
||||
event.preventDefault();
|
||||
handleReSort($(this));
|
||||
});
|
||||
$(document).on("click", 'a.show-proposal', function(event) {
|
||||
event.preventDefault();
|
||||
showProposal($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.hide-proposal', function(event) {
|
||||
event.preventDefault();
|
||||
hideProposal($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.show-propose-change', function(event) {
|
||||
event.preventDefault();
|
||||
showProposeChange($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.hide-propose-change', function(event) {
|
||||
event.preventDefault();
|
||||
hideProposeChange($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.accept-comment', function(event) {
|
||||
event.preventDefault();
|
||||
acceptComment($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.delete-comment', function(event) {
|
||||
event.preventDefault();
|
||||
deleteComment($(this).attr('id').substring(2));
|
||||
});
|
||||
$(document).on("click", 'a.comment-markup', function(event) {
|
||||
event.preventDefault();
|
||||
toggleCommentMarkupBox($(this).attr('id').substring(2));
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Set comp, which is a comparator function used for sorting and
|
||||
* inserting comments into the list.
|
||||
*/
|
||||
function setComparator() {
|
||||
// If the first three letters are "asc", sort in ascending order
|
||||
// and remove the prefix.
|
||||
if (by.substring(0,3) == 'asc') {
|
||||
var i = by.substring(3);
|
||||
comp = function(a, b) { return a[i] - b[i]; };
|
||||
} else {
|
||||
// Otherwise sort in descending order.
|
||||
comp = function(a, b) { return b[by] - a[by]; };
|
||||
}
|
||||
|
||||
// Reset link styles and format the selected sort option.
|
||||
$('a.sel').attr('href', '#').removeClass('sel');
|
||||
$('a.by' + by).removeAttr('href').addClass('sel');
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a comp function. If the user has preferences stored in
|
||||
* the sortBy cookie, use those, otherwise use the default.
|
||||
*/
|
||||
function initComparator() {
|
||||
by = 'rating'; // Default to sort by rating.
|
||||
// If the sortBy cookie is set, use that instead.
|
||||
if (document.cookie.length > 0) {
|
||||
var start = document.cookie.indexOf('sortBy=');
|
||||
if (start != -1) {
|
||||
start = start + 7;
|
||||
var end = document.cookie.indexOf(";", start);
|
||||
if (end == -1) {
|
||||
end = document.cookie.length;
|
||||
by = unescape(document.cookie.substring(start, end));
|
||||
}
|
||||
}
|
||||
}
|
||||
setComparator();
|
||||
}
|
||||
|
||||
/**
|
||||
* Show a comment div.
|
||||
*/
|
||||
function show(id) {
|
||||
$('#ao' + id).hide();
|
||||
$('#ah' + id).show();
|
||||
var context = $.extend({id: id}, opts);
|
||||
var popup = $(renderTemplate(popupTemplate, context)).hide();
|
||||
popup.find('textarea[name="proposal"]').hide();
|
||||
popup.find('a.by' + by).addClass('sel');
|
||||
var form = popup.find('#cf' + id);
|
||||
form.submit(function(event) {
|
||||
event.preventDefault();
|
||||
addComment(form);
|
||||
});
|
||||
$('#s' + id).after(popup);
|
||||
popup.slideDown('fast', function() {
|
||||
getComments(id);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Hide a comment div.
|
||||
*/
|
||||
function hide(id) {
|
||||
$('#ah' + id).hide();
|
||||
$('#ao' + id).show();
|
||||
var div = $('#sc' + id);
|
||||
div.slideUp('fast', function() {
|
||||
div.remove();
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Perform an ajax request to get comments for a node
|
||||
* and insert the comments into the comments tree.
|
||||
*/
|
||||
function getComments(id) {
|
||||
$.ajax({
|
||||
type: 'GET',
|
||||
url: opts.getCommentsURL,
|
||||
data: {node: id},
|
||||
success: function(data, textStatus, request) {
|
||||
var ul = $('#cl' + id);
|
||||
var speed = 100;
|
||||
$('#cf' + id)
|
||||
.find('textarea[name="proposal"]')
|
||||
.data('source', data.source);
|
||||
|
||||
if (data.comments.length === 0) {
|
||||
ul.html('<li>No comments yet.</li>');
|
||||
ul.data('empty', true);
|
||||
} else {
|
||||
// If there are comments, sort them and put them in the list.
|
||||
var comments = sortComments(data.comments);
|
||||
speed = data.comments.length * 100;
|
||||
appendComments(comments, ul);
|
||||
ul.data('empty', false);
|
||||
}
|
||||
$('#cn' + id).slideUp(speed + 200);
|
||||
ul.slideDown(speed);
|
||||
},
|
||||
error: function(request, textStatus, error) {
|
||||
showError('Oops, there was a problem retrieving the comments.');
|
||||
},
|
||||
dataType: 'json'
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Add a comment via ajax and insert the comment into the comment tree.
|
||||
*/
|
||||
function addComment(form) {
|
||||
var node_id = form.find('input[name="node"]').val();
|
||||
var parent_id = form.find('input[name="parent"]').val();
|
||||
var text = form.find('textarea[name="comment"]').val();
|
||||
var proposal = form.find('textarea[name="proposal"]').val();
|
||||
|
||||
if (text == '') {
|
||||
showError('Please enter a comment.');
|
||||
return;
|
||||
}
|
||||
|
||||
// Disable the form that is being submitted.
|
||||
form.find('textarea,input').attr('disabled', 'disabled');
|
||||
|
||||
// Send the comment to the server.
|
||||
$.ajax({
|
||||
type: "POST",
|
||||
url: opts.addCommentURL,
|
||||
dataType: 'json',
|
||||
data: {
|
||||
node: node_id,
|
||||
parent: parent_id,
|
||||
text: text,
|
||||
proposal: proposal
|
||||
},
|
||||
success: function(data, textStatus, error) {
|
||||
// Reset the form.
|
||||
if (node_id) {
|
||||
hideProposeChange(node_id);
|
||||
}
|
||||
form.find('textarea')
|
||||
.val('')
|
||||
.add(form.find('input'))
|
||||
.removeAttr('disabled');
|
||||
var ul = $('#cl' + (node_id || parent_id));
|
||||
if (ul.data('empty')) {
|
||||
$(ul).empty();
|
||||
ul.data('empty', false);
|
||||
}
|
||||
insertComment(data.comment);
|
||||
var ao = $('#ao' + node_id);
|
||||
ao.find('img').attr({'src': opts.commentBrightImage});
|
||||
if (node_id) {
|
||||
// if this was a "root" comment, remove the commenting box
|
||||
// (the user can get it back by reopening the comment popup)
|
||||
$('#ca' + node_id).slideUp();
|
||||
}
|
||||
},
|
||||
error: function(request, textStatus, error) {
|
||||
form.find('textarea,input').removeAttr('disabled');
|
||||
showError('Oops, there was a problem adding the comment.');
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Recursively append comments to the main comment list and children
|
||||
* lists, creating the comment tree.
|
||||
*/
|
||||
function appendComments(comments, ul) {
|
||||
$.each(comments, function() {
|
||||
var div = createCommentDiv(this);
|
||||
ul.append($(document.createElement('li')).html(div));
|
||||
appendComments(this.children, div.find('ul.comment-children'));
|
||||
// To avoid stagnating data, don't store the comments children in data.
|
||||
this.children = null;
|
||||
div.data('comment', this);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* After adding a new comment, it must be inserted in the correct
|
||||
* location in the comment tree.
|
||||
*/
|
||||
function insertComment(comment) {
|
||||
var div = createCommentDiv(comment);
|
||||
|
||||
// To avoid stagnating data, don't store the comments children in data.
|
||||
comment.children = null;
|
||||
div.data('comment', comment);
|
||||
|
||||
var ul = $('#cl' + (comment.node || comment.parent));
|
||||
var siblings = getChildren(ul);
|
||||
|
||||
var li = $(document.createElement('li'));
|
||||
li.hide();
|
||||
|
||||
// Determine where in the parents children list to insert this comment.
|
||||
for(var i=0; i < siblings.length; i++) {
|
||||
if (comp(comment, siblings[i]) <= 0) {
|
||||
$('#cd' + siblings[i].id)
|
||||
.parent()
|
||||
.before(li.html(div));
|
||||
li.slideDown('fast');
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
// If we get here, this comment rates lower than all the others,
|
||||
// or it is the only comment in the list.
|
||||
ul.append(li.html(div));
|
||||
li.slideDown('fast');
|
||||
}
|
||||
|
||||
function acceptComment(id) {
|
||||
$.ajax({
|
||||
type: 'POST',
|
||||
url: opts.acceptCommentURL,
|
||||
data: {id: id},
|
||||
success: function(data, textStatus, request) {
|
||||
$('#cm' + id).fadeOut('fast');
|
||||
$('#cd' + id).removeClass('moderate');
|
||||
},
|
||||
error: function(request, textStatus, error) {
|
||||
showError('Oops, there was a problem accepting the comment.');
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
function deleteComment(id) {
|
||||
$.ajax({
|
||||
type: 'POST',
|
||||
url: opts.deleteCommentURL,
|
||||
data: {id: id},
|
||||
success: function(data, textStatus, request) {
|
||||
var div = $('#cd' + id);
|
||||
if (data == 'delete') {
|
||||
// Moderator mode: remove the comment and all children immediately
|
||||
div.slideUp('fast', function() {
|
||||
div.remove();
|
||||
});
|
||||
return;
|
||||
}
|
||||
// User mode: only mark the comment as deleted
|
||||
div
|
||||
.find('span.user-id:first')
|
||||
.text('[deleted]').end()
|
||||
.find('div.comment-text:first')
|
||||
.text('[deleted]').end()
|
||||
.find('#cm' + id + ', #dc' + id + ', #ac' + id + ', #rc' + id +
|
||||
', #sp' + id + ', #hp' + id + ', #cr' + id + ', #rl' + id)
|
||||
.remove();
|
||||
var comment = div.data('comment');
|
||||
comment.username = '[deleted]';
|
||||
comment.text = '[deleted]';
|
||||
div.data('comment', comment);
|
||||
},
|
||||
error: function(request, textStatus, error) {
|
||||
showError('Oops, there was a problem deleting the comment.');
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
function showProposal(id) {
|
||||
$('#sp' + id).hide();
|
||||
$('#hp' + id).show();
|
||||
$('#pr' + id).slideDown('fast');
|
||||
}
|
||||
|
||||
function hideProposal(id) {
|
||||
$('#hp' + id).hide();
|
||||
$('#sp' + id).show();
|
||||
$('#pr' + id).slideUp('fast');
|
||||
}
|
||||
|
||||
function showProposeChange(id) {
|
||||
$('#pc' + id).hide();
|
||||
$('#hc' + id).show();
|
||||
var textarea = $('#pt' + id);
|
||||
textarea.val(textarea.data('source'));
|
||||
$.fn.autogrow.resize(textarea[0]);
|
||||
textarea.slideDown('fast');
|
||||
}
|
||||
|
||||
function hideProposeChange(id) {
|
||||
$('#hc' + id).hide();
|
||||
$('#pc' + id).show();
|
||||
var textarea = $('#pt' + id);
|
||||
textarea.val('').removeAttr('disabled');
|
||||
textarea.slideUp('fast');
|
||||
}
|
||||
|
||||
function toggleCommentMarkupBox(id) {
|
||||
$('#mb' + id).toggle();
|
||||
}
|
||||
|
||||
/** Handle when the user clicks on a sort by link. */
|
||||
function handleReSort(link) {
|
||||
var classes = link.attr('class').split(/\s+/);
|
||||
for (var i=0; i<classes.length; i++) {
|
||||
if (classes[i] != 'sort-option') {
|
||||
by = classes[i].substring(2);
|
||||
}
|
||||
}
|
||||
setComparator();
|
||||
// Save/update the sortBy cookie.
|
||||
var expiration = new Date();
|
||||
expiration.setDate(expiration.getDate() + 365);
|
||||
document.cookie= 'sortBy=' + escape(by) +
|
||||
';expires=' + expiration.toUTCString();
|
||||
$('ul.comment-ul').each(function(index, ul) {
|
||||
var comments = getChildren($(ul), true);
|
||||
comments = sortComments(comments);
|
||||
appendComments(comments, $(ul).empty());
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Function to process a vote when a user clicks an arrow.
|
||||
*/
|
||||
function handleVote(link) {
|
||||
if (!opts.voting) {
|
||||
showError("You'll need to login to vote.");
|
||||
return;
|
||||
}
|
||||
|
||||
var id = link.attr('id');
|
||||
if (!id) {
|
||||
// Didn't click on one of the voting arrows.
|
||||
return;
|
||||
}
|
||||
// If it is an unvote, the new vote value is 0,
|
||||
// Otherwise it's 1 for an upvote, or -1 for a downvote.
|
||||
var value = 0;
|
||||
if (id.charAt(1) != 'u') {
|
||||
value = id.charAt(0) == 'u' ? 1 : -1;
|
||||
}
|
||||
// The data to be sent to the server.
|
||||
var d = {
|
||||
comment_id: id.substring(2),
|
||||
value: value
|
||||
};
|
||||
|
||||
// Swap the vote and unvote links.
|
||||
link.hide();
|
||||
$('#' + id.charAt(0) + (id.charAt(1) == 'u' ? 'v' : 'u') + d.comment_id)
|
||||
.show();
|
||||
|
||||
// The div the comment is displayed in.
|
||||
var div = $('div#cd' + d.comment_id);
|
||||
var data = div.data('comment');
|
||||
|
||||
// If this is not an unvote, and the other vote arrow has
|
||||
// already been pressed, unpress it.
|
||||
if ((d.value !== 0) && (data.vote === d.value * -1)) {
|
||||
$('#' + (d.value == 1 ? 'd' : 'u') + 'u' + d.comment_id).hide();
|
||||
$('#' + (d.value == 1 ? 'd' : 'u') + 'v' + d.comment_id).show();
|
||||
}
|
||||
|
||||
// Update the comments rating in the local data.
|
||||
data.rating += (data.vote === 0) ? d.value : (d.value - data.vote);
|
||||
data.vote = d.value;
|
||||
div.data('comment', data);
|
||||
|
||||
// Change the rating text.
|
||||
div.find('.rating:first')
|
||||
.text(data.rating + ' point' + (data.rating == 1 ? '' : 's'));
|
||||
|
||||
// Send the vote information to the server.
|
||||
$.ajax({
|
||||
type: "POST",
|
||||
url: opts.processVoteURL,
|
||||
data: d,
|
||||
error: function(request, textStatus, error) {
|
||||
showError('Oops, there was a problem casting that vote.');
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Open a reply form used to reply to an existing comment.
|
||||
*/
|
||||
function openReply(id) {
|
||||
// Swap out the reply link for the hide link
|
||||
$('#rl' + id).hide();
|
||||
$('#cr' + id).show();
|
||||
|
||||
// Add the reply li to the children ul.
|
||||
var div = $(renderTemplate(replyTemplate, {id: id})).hide();
|
||||
$('#cl' + id)
|
||||
.prepend(div)
|
||||
// Setup the submit handler for the reply form.
|
||||
.find('#rf' + id)
|
||||
.submit(function(event) {
|
||||
event.preventDefault();
|
||||
addComment($('#rf' + id));
|
||||
closeReply(id);
|
||||
})
|
||||
.find('input[type=button]')
|
||||
.click(function() {
|
||||
closeReply(id);
|
||||
});
|
||||
div.slideDown('fast', function() {
|
||||
$('#rf' + id).find('textarea').focus();
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Close the reply form opened with openReply.
|
||||
*/
|
||||
function closeReply(id) {
|
||||
// Remove the reply div from the DOM.
|
||||
$('#rd' + id).slideUp('fast', function() {
|
||||
$(this).remove();
|
||||
});
|
||||
|
||||
// Swap out the hide link for the reply link
|
||||
$('#cr' + id).hide();
|
||||
$('#rl' + id).show();
|
||||
}
|
||||
|
||||
/**
|
||||
* Recursively sort a tree of comments using the comp comparator.
|
||||
*/
|
||||
function sortComments(comments) {
|
||||
comments.sort(comp);
|
||||
$.each(comments, function() {
|
||||
this.children = sortComments(this.children);
|
||||
});
|
||||
return comments;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the children comments from a ul. If recursive is true,
|
||||
* recursively include childrens' children.
|
||||
*/
|
||||
function getChildren(ul, recursive) {
|
||||
var children = [];
|
||||
ul.children().children("[id^='cd']")
|
||||
.each(function() {
|
||||
var comment = $(this).data('comment');
|
||||
if (recursive)
|
||||
comment.children = getChildren($(this).find('#cl' + comment.id), true);
|
||||
children.push(comment);
|
||||
});
|
||||
return children;
|
||||
}
|
||||
|
||||
/** Create a div to display a comment in. */
|
||||
function createCommentDiv(comment) {
|
||||
if (!comment.displayed && !opts.moderator) {
|
||||
return $('<div class="moderate">Thank you! Your comment will show up '
|
||||
+ 'once it is has been approved by a moderator.</div>');
|
||||
}
|
||||
// Prettify the comment rating.
|
||||
comment.pretty_rating = comment.rating + ' point' +
|
||||
(comment.rating == 1 ? '' : 's');
|
||||
// Make a class (for displaying not yet moderated comments differently)
|
||||
comment.css_class = comment.displayed ? '' : ' moderate';
|
||||
// Create a div for this comment.
|
||||
var context = $.extend({}, opts, comment);
|
||||
var div = $(renderTemplate(commentTemplate, context));
|
||||
|
||||
// If the user has voted on this comment, highlight the correct arrow.
|
||||
if (comment.vote) {
|
||||
var direction = (comment.vote == 1) ? 'u' : 'd';
|
||||
div.find('#' + direction + 'v' + comment.id).hide();
|
||||
div.find('#' + direction + 'u' + comment.id).show();
|
||||
}
|
||||
|
||||
if (opts.moderator || comment.text != '[deleted]') {
|
||||
div.find('a.reply').show();
|
||||
if (comment.proposal_diff)
|
||||
div.find('#sp' + comment.id).show();
|
||||
if (opts.moderator && !comment.displayed)
|
||||
div.find('#cm' + comment.id).show();
|
||||
if (opts.moderator || (opts.username == comment.username))
|
||||
div.find('#dc' + comment.id).show();
|
||||
}
|
||||
return div;
|
||||
}
|
||||
|
||||
/**
|
||||
* A simple template renderer. Placeholders such as <%id%> are replaced
|
||||
* by context['id'] with items being escaped. Placeholders such as <#id#>
|
||||
* are not escaped.
|
||||
*/
|
||||
function renderTemplate(template, context) {
|
||||
var esc = $(document.createElement('div'));
|
||||
|
||||
function handle(ph, escape) {
|
||||
var cur = context;
|
||||
$.each(ph.split('.'), function() {
|
||||
cur = cur[this];
|
||||
});
|
||||
return escape ? esc.text(cur || "").html() : cur;
|
||||
}
|
||||
|
||||
return template.replace(/<([%#])([\w\.]*)\1>/g, function() {
|
||||
return handle(arguments[2], arguments[1] == '%' ? true : false);
|
||||
});
|
||||
}
|
||||
|
||||
/** Flash an error message briefly. */
|
||||
function showError(message) {
|
||||
$(document.createElement('div')).attr({'class': 'popup-error'})
|
||||
.append($(document.createElement('div'))
|
||||
.attr({'class': 'error-message'}).text(message))
|
||||
.appendTo('body')
|
||||
.fadeIn("slow")
|
||||
.delay(2000)
|
||||
.fadeOut("slow");
|
||||
}
|
||||
|
||||
/** Add a link the user uses to open the comments popup. */
|
||||
$.fn.comment = function() {
|
||||
return this.each(function() {
|
||||
var id = $(this).attr('id').substring(1);
|
||||
var count = COMMENT_METADATA[id];
|
||||
var title = count + ' comment' + (count == 1 ? '' : 's');
|
||||
var image = count > 0 ? opts.commentBrightImage : opts.commentImage;
|
||||
var addcls = count == 0 ? ' nocomment' : '';
|
||||
$(this)
|
||||
.append(
|
||||
$(document.createElement('a')).attr({
|
||||
href: '#',
|
||||
'class': 'sphinx-comment-open' + addcls,
|
||||
id: 'ao' + id
|
||||
})
|
||||
.append($(document.createElement('img')).attr({
|
||||
src: image,
|
||||
alt: 'comment',
|
||||
title: title
|
||||
}))
|
||||
.click(function(event) {
|
||||
event.preventDefault();
|
||||
show($(this).attr('id').substring(2));
|
||||
})
|
||||
)
|
||||
.append(
|
||||
$(document.createElement('a')).attr({
|
||||
href: '#',
|
||||
'class': 'sphinx-comment-close hidden',
|
||||
id: 'ah' + id
|
||||
})
|
||||
.append($(document.createElement('img')).attr({
|
||||
src: opts.closeCommentImage,
|
||||
alt: 'close',
|
||||
title: 'close'
|
||||
}))
|
||||
.click(function(event) {
|
||||
event.preventDefault();
|
||||
hide($(this).attr('id').substring(2));
|
||||
})
|
||||
);
|
||||
});
|
||||
};
|
||||
|
||||
var opts = {
|
||||
processVoteURL: '/_process_vote',
|
||||
addCommentURL: '/_add_comment',
|
||||
getCommentsURL: '/_get_comments',
|
||||
acceptCommentURL: '/_accept_comment',
|
||||
deleteCommentURL: '/_delete_comment',
|
||||
commentImage: '/static/_static/comment.png',
|
||||
closeCommentImage: '/static/_static/comment-close.png',
|
||||
loadingImage: '/static/_static/ajax-loader.gif',
|
||||
commentBrightImage: '/static/_static/comment-bright.png',
|
||||
upArrow: '/static/_static/up.png',
|
||||
downArrow: '/static/_static/down.png',
|
||||
upArrowPressed: '/static/_static/up-pressed.png',
|
||||
downArrowPressed: '/static/_static/down-pressed.png',
|
||||
voting: false,
|
||||
moderator: false
|
||||
};
|
||||
|
||||
if (typeof COMMENT_OPTIONS != "undefined") {
|
||||
opts = jQuery.extend(opts, COMMENT_OPTIONS);
|
||||
}
|
||||
|
||||
var popupTemplate = '\
|
||||
<div class="sphinx-comments" id="sc<%id%>">\
|
||||
<p class="sort-options">\
|
||||
Sort by:\
|
||||
<a href="#" class="sort-option byrating">best rated</a>\
|
||||
<a href="#" class="sort-option byascage">newest</a>\
|
||||
<a href="#" class="sort-option byage">oldest</a>\
|
||||
</p>\
|
||||
<div class="comment-header">Comments</div>\
|
||||
<div class="comment-loading" id="cn<%id%>">\
|
||||
loading comments... <img src="<%loadingImage%>" alt="" /></div>\
|
||||
<ul id="cl<%id%>" class="comment-ul"></ul>\
|
||||
<div id="ca<%id%>">\
|
||||
<p class="add-a-comment">Add a comment\
|
||||
(<a href="#" class="comment-markup" id="ab<%id%>">markup</a>):</p>\
|
||||
<div class="comment-markup-box" id="mb<%id%>">\
|
||||
reStructured text markup: <i>*emph*</i>, <b>**strong**</b>, \
|
||||
<code>``code``</code>, \
|
||||
code blocks: <code>::</code> and an indented block after blank line</div>\
|
||||
<form method="post" id="cf<%id%>" class="comment-form" action="">\
|
||||
<textarea name="comment" cols="80"></textarea>\
|
||||
<p class="propose-button">\
|
||||
<a href="#" id="pc<%id%>" class="show-propose-change">\
|
||||
Propose a change ▹\
|
||||
</a>\
|
||||
<a href="#" id="hc<%id%>" class="hide-propose-change">\
|
||||
Propose a change ▿\
|
||||
</a>\
|
||||
</p>\
|
||||
<textarea name="proposal" id="pt<%id%>" cols="80"\
|
||||
spellcheck="false"></textarea>\
|
||||
<input type="submit" value="Add comment" />\
|
||||
<input type="hidden" name="node" value="<%id%>" />\
|
||||
<input type="hidden" name="parent" value="" />\
|
||||
</form>\
|
||||
</div>\
|
||||
</div>';
|
||||
|
||||
var commentTemplate = '\
|
||||
<div id="cd<%id%>" class="sphinx-comment<%css_class%>">\
|
||||
<div class="vote">\
|
||||
<div class="arrow">\
|
||||
<a href="#" id="uv<%id%>" class="vote" title="vote up">\
|
||||
<img src="<%upArrow%>" />\
|
||||
</a>\
|
||||
<a href="#" id="uu<%id%>" class="un vote" title="vote up">\
|
||||
<img src="<%upArrowPressed%>" />\
|
||||
</a>\
|
||||
</div>\
|
||||
<div class="arrow">\
|
||||
<a href="#" id="dv<%id%>" class="vote" title="vote down">\
|
||||
<img src="<%downArrow%>" id="da<%id%>" />\
|
||||
</a>\
|
||||
<a href="#" id="du<%id%>" class="un vote" title="vote down">\
|
||||
<img src="<%downArrowPressed%>" />\
|
||||
</a>\
|
||||
</div>\
|
||||
</div>\
|
||||
<div class="comment-content">\
|
||||
<p class="tagline comment">\
|
||||
<span class="user-id"><%username%></span>\
|
||||
<span class="rating"><%pretty_rating%></span>\
|
||||
<span class="delta"><%time.delta%></span>\
|
||||
</p>\
|
||||
<div class="comment-text comment"><#text#></div>\
|
||||
<p class="comment-opts comment">\
|
||||
<a href="#" class="reply hidden" id="rl<%id%>">reply ▹</a>\
|
||||
<a href="#" class="close-reply" id="cr<%id%>">reply ▿</a>\
|
||||
<a href="#" id="sp<%id%>" class="show-proposal">proposal ▹</a>\
|
||||
<a href="#" id="hp<%id%>" class="hide-proposal">proposal ▿</a>\
|
||||
<a href="#" id="dc<%id%>" class="delete-comment hidden">delete</a>\
|
||||
<span id="cm<%id%>" class="moderation hidden">\
|
||||
<a href="#" id="ac<%id%>" class="accept-comment">accept</a>\
|
||||
</span>\
|
||||
</p>\
|
||||
<pre class="proposal" id="pr<%id%>">\
|
||||
<#proposal_diff#>\
|
||||
</pre>\
|
||||
<ul class="comment-children" id="cl<%id%>"></ul>\
|
||||
</div>\
|
||||
<div class="clearleft"></div>\
|
||||
</div>\
|
||||
</div>';
|
||||
|
||||
var replyTemplate = '\
|
||||
<li>\
|
||||
<div class="reply-div" id="rd<%id%>">\
|
||||
<form id="rf<%id%>">\
|
||||
<textarea name="comment" cols="80"></textarea>\
|
||||
<input type="submit" value="Add reply" />\
|
||||
<input type="button" value="Cancel" />\
|
||||
<input type="hidden" name="parent" value="<%id%>" />\
|
||||
<input type="hidden" name="node" value="" />\
|
||||
</form>\
|
||||
</div>\
|
||||
</li>';
|
||||
|
||||
$(document).ready(function() {
|
||||
init();
|
||||
});
|
||||
})(jQuery);
|
||||
|
||||
$(document).ready(function() {
|
||||
// add comment anchors for all paragraphs that are commentable
|
||||
$('.sphinx-has-comment').comment();
|
||||
|
||||
// highlight search words in search results
|
||||
$("div.context").each(function() {
|
||||
var params = $.getQueryParameters();
|
||||
var terms = (params.q) ? params.q[0].split(/\s+/) : [];
|
||||
var result = $(this);
|
||||
$.each(terms, function() {
|
||||
result.highlightText(this.toLowerCase(), 'highlighted');
|
||||
});
|
||||
});
|
||||
|
||||
// directly open comment window if requested
|
||||
var anchor = document.location.hash;
|
||||
if (anchor.substring(0, 9) == '#comment-') {
|
||||
$('#ao' + anchor.substring(9)).click();
|
||||
document.location.hash = '#s' + anchor.substring(9);
|
||||
}
|
||||
});
|
||||
|
|
@ -4,8 +4,8 @@
|
|||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>Index — gRPC Python 1.31.0 documentation</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Index — gRPC Python 1.32.0 documentation</title>
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
|
|
@ -30,7 +30,7 @@
|
|||
|
||||
|
||||
|
||||
<p class="blurb">1.31.0</p>
|
||||
<p class="blurb">1.32.0</p>
|
||||
|
||||
|
||||
|
||||
|
|
@ -333,6 +333,8 @@
|
|||
<li><a href="grpc.html#grpc.Compression">Compression (class in grpc)</a>
|
||||
</li>
|
||||
<li><a href="grpc.html#grpc.ClientCallDetails.compression">compression (grpc.ClientCallDetails attribute)</a>
|
||||
</li>
|
||||
<li><a href="grpc.html#grpc.compute_engine_channel_credentials">compute_engine_channel_credentials() (in module grpc)</a>
|
||||
</li>
|
||||
<li><a href="grpc.html#grpc.ChannelConnectivity.CONNECTING">CONNECTING (grpc.ChannelConnectivity attribute)</a>
|
||||
</li>
|
||||
|
|
@ -686,6 +688,10 @@
|
|||
</li>
|
||||
</ul></li>
|
||||
<li><a href="grpc.html#grpc.StatusCode.PERMISSION_DENIED">PERMISSION_DENIED (grpc.StatusCode attribute)</a>
|
||||
</li>
|
||||
<li><a href="grpc.html#grpc.protos">protos() (in module grpc)</a>
|
||||
</li>
|
||||
<li><a href="grpc.html#grpc.protos_and_services">protos_and_services() (in module grpc)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
|
@ -818,6 +824,8 @@
|
|||
</li>
|
||||
</ul></li>
|
||||
<li><a href="grpc.html#grpc.ServiceRpcHandler">ServiceRpcHandler (class in grpc)</a>
|
||||
</li>
|
||||
<li><a href="grpc.html#grpc.services">services() (in module grpc)</a>
|
||||
</li>
|
||||
<li><a href="grpc_health_checking.html#grpc_health.v1.health.HealthServicer.set">set() (grpc_health.v1.health.HealthServicer method)</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -4,8 +4,8 @@
|
|||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>Glossary — gRPC Python 1.31.0 documentation</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Glossary — gRPC Python 1.32.0 documentation</title>
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
|
|
@ -31,7 +31,7 @@
|
|||
|
||||
|
||||
|
||||
<p class="blurb">1.31.0</p>
|
||||
<p class="blurb">1.32.0</p>
|
||||
|
||||
|
||||
|
||||
|
|
@ -123,7 +123,7 @@ shut down or the RPC’s deadline has been reached.</p>
|
|||
server object. Channel arguments are meant for advanced usages and contain
|
||||
experimental API (some may not labeled as experimental). Full list of
|
||||
available channel arguments and documentation can be found under the
|
||||
“grpc_arg_keys” section of “grpc_types.h” header file (<a class="reference external" href="https://github.com/grpc/grpc/blob/v1.31.x/include/grpc/impl/codegen/grpc_types.h">https://github.com/grpc/grpc/blob/v1.31.x/include/grpc/impl/codegen/grpc_types.h</a>).
|
||||
“grpc_arg_keys” section of “grpc_types.h” header file (<a class="reference external" href="https://github.com/grpc/grpc/blob/v1.32.x/include/grpc/impl/codegen/grpc_types.h">https://github.com/grpc/grpc/blob/v1.32.x/include/grpc/impl/codegen/grpc_types.h</a>).
|
||||
For example, if you want to disable TCP port reuse, you may construct
|
||||
channel arguments like: <code class="docutils literal notranslate"><span class="pre">options</span> <span class="pre">=</span> <span class="pre">(('grpc.so_reuseport',</span> <span class="pre">0),)</span></code>.</p>
|
||||
</dd>
|
||||
|
|
|
|||
|
|
@ -4,8 +4,8 @@
|
|||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>gRPC — gRPC Python 1.31.0 documentation</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>gRPC — gRPC Python 1.32.0 documentation</title>
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
|
|
@ -32,7 +32,7 @@
|
|||
|
||||
|
||||
|
||||
<p class="blurb">1.31.0</p>
|
||||
<p class="blurb">1.32.0</p>
|
||||
|
||||
|
||||
|
||||
|
|
@ -69,6 +69,7 @@
|
|||
<li class="toctree-l3"><a class="reference internal" href="#multi-callable-interfaces">Multi-Callable Interfaces</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#future-interfaces">Future Interfaces</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#compression">Compression</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#runtime-protobuf-parsing">Runtime Protobuf Parsing</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
|
@ -328,6 +329,19 @@ grpc.LocalConnectionType.UDS or grpc.LocalConnectionType.LOCAL_TCP)</p>
|
|||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="grpc.compute_engine_channel_credentials">
|
||||
<code class="sig-prename descclassname">grpc.</code><code class="sig-name descname">compute_engine_channel_credentials</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">call_credentials</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc.html#compute_engine_channel_credentials"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.compute_engine_channel_credentials" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Creates a compute engine channel credential.</p>
|
||||
<p>This credential can only be used in a GCP environment as it relies on
|
||||
a handshaker service. For more info about ALTS, see
|
||||
<a class="reference external" href="https://cloud.google.com/security/encryption-in-transit/application-layer-transport-security">https://cloud.google.com/security/encryption-in-transit/application-layer-transport-security</a></p>
|
||||
<p>This channel credential is expected to be used as part of a composite
|
||||
credential in conjunction with a call credentials that authenticates the
|
||||
VM’s default service account. If used with any other sort of call
|
||||
credential, the connection may suddenly and unexpectedly begin failing RPCs.</p>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="create-server">
|
||||
<h3>Create Server<a class="headerlink" href="#create-server" title="Permalink to this headline">¶</a></h3>
|
||||
|
|
@ -2334,6 +2348,24 @@ if the computation did not raise an exception.</p>
|
|||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
<div class="section" id="runtime-protobuf-parsing">
|
||||
<h3>Runtime Protobuf Parsing<a class="headerlink" href="#runtime-protobuf-parsing" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="py function">
|
||||
<dt id="grpc.protos">
|
||||
<code class="sig-prename descclassname">grpc.</code><code class="sig-name descname">protos</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/_runtime_protos.html#protos"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.protos" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="grpc.services">
|
||||
<code class="sig-prename descclassname">grpc.</code><code class="sig-name descname">services</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/_runtime_protos.html#services"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.services" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="grpc.protos_and_services">
|
||||
<code class="sig-prename descclassname">grpc.</code><code class="sig-name descname">protos_and_services</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/_runtime_protos.html#protos_and_services"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.protos_and_services" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
|
|
@ -4,8 +4,8 @@
|
|||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>gRPC AsyncIO API — gRPC Python 1.31.0 documentation</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>gRPC AsyncIO API — gRPC Python 1.32.0 documentation</title>
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
|
|
@ -32,7 +32,7 @@
|
|||
|
||||
|
||||
|
||||
<p class="blurb">1.31.0</p>
|
||||
<p class="blurb">1.32.0</p>
|
||||
|
||||
|
||||
|
||||
|
|
@ -139,7 +139,7 @@ Channel objects works best when further encapsulate into stub objects, then the
|
|||
application can invoke remote functions as if they are local functions.</p>
|
||||
<dl class="py function">
|
||||
<dt id="grpc.experimental.aio.insecure_channel">
|
||||
<code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">insecure_channel</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">target</span></em>, <em class="sig-param"><span class="n">options</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">compression</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">interceptors</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_channel.html#insecure_channel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.insecure_channel" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">insecure_channel</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">target</span></em>, <em class="sig-param"><span class="n">options</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">compression</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">interceptors</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_channel.html#insecure_channel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.insecure_channel" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Creates an insecure asynchronous Channel to a server.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -149,7 +149,7 @@ application can invoke remote functions as if they are local functions.</p>
|
|||
in gRPC Core runtime) to configure the channel.</p></li>
|
||||
<li><p><strong>compression</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="grpc.html#grpc.Compression" title="grpc.Compression"><em>grpc.Compression</em></a><em>]</em>) – An optional value indicating the compression method to be
|
||||
used over the lifetime of the channel. This is an EXPERIMENTAL option.</p></li>
|
||||
<li><p><strong>interceptors</strong> (<em>Optional</em><em>[</em><em>Sequence</em><em>[</em><em>grpc.experimental.aio._interceptor.ClientInterceptor</em><em>]</em><em>]</em>) – An optional sequence of interceptors that will be executed for
|
||||
<li><p><strong>interceptors</strong> (<em>Optional</em><em>[</em><em>Sequence</em><em>[</em><em>grpc.aio._interceptor.ClientInterceptor</em><em>]</em><em>]</em>) – An optional sequence of interceptors that will be executed for
|
||||
any call executed with this channel.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
|
|
@ -161,7 +161,7 @@ any call executed with this channel.</p></li>
|
|||
|
||||
<dl class="py function">
|
||||
<dt id="grpc.experimental.aio.secure_channel">
|
||||
<code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">secure_channel</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">target</span></em>, <em class="sig-param"><span class="n">credentials</span></em>, <em class="sig-param"><span class="n">options</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">compression</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">interceptors</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_channel.html#secure_channel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.secure_channel" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">secure_channel</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">target</span></em>, <em class="sig-param"><span class="n">credentials</span></em>, <em class="sig-param"><span class="n">options</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">compression</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">interceptors</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_channel.html#secure_channel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.secure_channel" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Creates a secure asynchronous Channel to a server.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -172,7 +172,7 @@ any call executed with this channel.</p></li>
|
|||
in gRPC Core runtime) to configure the channel.</p></li>
|
||||
<li><p><strong>compression</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="grpc.html#grpc.Compression" title="grpc.Compression"><em>grpc.Compression</em></a><em>]</em>) – An optional value indicating the compression method to be
|
||||
used over the lifetime of the channel. This is an EXPERIMENTAL option.</p></li>
|
||||
<li><p><strong>interceptors</strong> (<em>Optional</em><em>[</em><em>Sequence</em><em>[</em><em>grpc.experimental.aio._interceptor.ClientInterceptor</em><em>]</em><em>]</em>) – An optional sequence of interceptors that will be executed for
|
||||
<li><p><strong>interceptors</strong> (<em>Optional</em><em>[</em><em>Sequence</em><em>[</em><em>grpc.aio._interceptor.ClientInterceptor</em><em>]</em><em>]</em>) – An optional sequence of interceptors that will be executed for
|
||||
any call executed with this channel.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
|
|
@ -187,14 +187,14 @@ any call executed with this channel.</p></li>
|
|||
<h3>Channel Object<a class="headerlink" href="#channel-object" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="py class">
|
||||
<dt id="grpc.experimental.aio.Channel">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">Channel</code><a class="reference internal" href="_modules/grpc/experimental/aio/_base_channel.html#Channel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Channel" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">Channel</code><a class="reference internal" href="_modules/grpc/aio/_base_channel.html#Channel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Channel" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Enables asynchronous RPC invocation as a client.</p>
|
||||
<p>Channel objects implement the Asynchronous Context Manager (aka. async
|
||||
with) type, although they are not supportted to be entered and exited
|
||||
multiple times.</p>
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.Channel.__aenter__">
|
||||
<em class="property">abstract async </em><code class="sig-name descname">__aenter__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_channel.html#Channel.__aenter__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Channel.__aenter__" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract async </em><code class="sig-name descname">__aenter__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_channel.html#Channel.__aenter__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Channel.__aenter__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Starts an asynchronous context manager.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
|
|
@ -205,14 +205,14 @@ multiple times.</p>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.Channel.__aexit__">
|
||||
<em class="property">abstract async </em><code class="sig-name descname">__aexit__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">exc_type</span></em>, <em class="sig-param"><span class="n">exc_val</span></em>, <em class="sig-param"><span class="n">exc_tb</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_channel.html#Channel.__aexit__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Channel.__aexit__" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract async </em><code class="sig-name descname">__aexit__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">exc_type</span></em>, <em class="sig-param"><span class="n">exc_val</span></em>, <em class="sig-param"><span class="n">exc_tb</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_channel.html#Channel.__aexit__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Channel.__aexit__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Finishes the asynchronous context manager by closing the channel.</p>
|
||||
<p>Still active RPCs will be cancelled.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.Channel.channel_ready">
|
||||
<em class="property">abstract async </em><code class="sig-name descname">channel_ready</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_channel.html#Channel.channel_ready"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Channel.channel_ready" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract async </em><code class="sig-name descname">channel_ready</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_channel.html#Channel.channel_ready"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Channel.channel_ready" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Creates a coroutine that blocks until the Channel is READY.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Return type</dt>
|
||||
|
|
@ -223,7 +223,7 @@ multiple times.</p>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.Channel.close">
|
||||
<em class="property">abstract async </em><code class="sig-name descname">close</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">grace</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_channel.html#Channel.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Channel.close" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract async </em><code class="sig-name descname">close</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">grace</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_channel.html#Channel.close"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Channel.close" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Closes this Channel and releases all resources held by it.</p>
|
||||
<p>This method immediately stops the channel from executing new RPCs in
|
||||
all cases.</p>
|
||||
|
|
@ -241,7 +241,7 @@ been terminated are cancelled. If a grace period is not specified
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.Channel.get_state">
|
||||
<em class="property">abstract </em><code class="sig-name descname">get_state</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">try_to_connect</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_channel.html#Channel.get_state"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Channel.get_state" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract </em><code class="sig-name descname">get_state</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">try_to_connect</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_channel.html#Channel.get_state"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Channel.get_state" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Checks the connectivity state of a channel.</p>
|
||||
<p>This is an EXPERIMENTAL API.</p>
|
||||
<p>If the channel reaches a stable connectivity state, it is guaranteed
|
||||
|
|
@ -261,7 +261,7 @@ connect to peer or not.</p>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.Channel.stream_stream">
|
||||
<em class="property">abstract </em><code class="sig-name descname">stream_stream</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">method</span></em>, <em class="sig-param"><span class="n">request_serializer</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">response_deserializer</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_channel.html#Channel.stream_stream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Channel.stream_stream" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract </em><code class="sig-name descname">stream_stream</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">method</span></em>, <em class="sig-param"><span class="n">request_serializer</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">response_deserializer</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_channel.html#Channel.stream_stream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Channel.stream_stream" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Creates a StreamStreamMultiCallable for a stream-stream method.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -278,14 +278,14 @@ is passed.</p></li>
|
|||
<dd class="field-even"><p>A StreamStreamMultiCallable value for the named stream-stream method.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p>grpc.experimental.aio._base_channel.StreamStreamMultiCallable</p>
|
||||
<dd class="field-odd"><p>grpc.aio._base_channel.StreamStreamMultiCallable</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.Channel.stream_unary">
|
||||
<em class="property">abstract </em><code class="sig-name descname">stream_unary</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">method</span></em>, <em class="sig-param"><span class="n">request_serializer</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">response_deserializer</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_channel.html#Channel.stream_unary"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Channel.stream_unary" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract </em><code class="sig-name descname">stream_unary</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">method</span></em>, <em class="sig-param"><span class="n">request_serializer</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">response_deserializer</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_channel.html#Channel.stream_unary"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Channel.stream_unary" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Creates a StreamUnaryMultiCallable for a stream-unary method.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -302,14 +302,14 @@ is passed.</p></li>
|
|||
<dd class="field-even"><p>A StreamUnaryMultiCallable value for the named stream-unary method.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p>grpc.experimental.aio._base_channel.StreamUnaryMultiCallable</p>
|
||||
<dd class="field-odd"><p>grpc.aio._base_channel.StreamUnaryMultiCallable</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.Channel.unary_stream">
|
||||
<em class="property">abstract </em><code class="sig-name descname">unary_stream</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">method</span></em>, <em class="sig-param"><span class="n">request_serializer</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">response_deserializer</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_channel.html#Channel.unary_stream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Channel.unary_stream" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract </em><code class="sig-name descname">unary_stream</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">method</span></em>, <em class="sig-param"><span class="n">request_serializer</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">response_deserializer</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_channel.html#Channel.unary_stream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Channel.unary_stream" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Creates a UnaryStreamMultiCallable for a unary-stream method.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -326,14 +326,14 @@ is passed.</p></li>
|
|||
<dd class="field-even"><p>A UnarySteramMultiCallable value for the named unary-stream method.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p>grpc.experimental.aio._base_channel.UnaryStreamMultiCallable</p>
|
||||
<dd class="field-odd"><p>grpc.aio._base_channel.UnaryStreamMultiCallable</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.Channel.unary_unary">
|
||||
<em class="property">abstract </em><code class="sig-name descname">unary_unary</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">method</span></em>, <em class="sig-param"><span class="n">request_serializer</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">response_deserializer</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_channel.html#Channel.unary_unary"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Channel.unary_unary" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract </em><code class="sig-name descname">unary_unary</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">method</span></em>, <em class="sig-param"><span class="n">request_serializer</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">response_deserializer</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_channel.html#Channel.unary_unary"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Channel.unary_unary" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Creates a UnaryUnaryMultiCallable for a unary-unary method.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -350,14 +350,14 @@ is passed.</p></li>
|
|||
<dd class="field-even"><p>A UnaryUnaryMultiCallable value for the named unary-unary method.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Return type</dt>
|
||||
<dd class="field-odd"><p>grpc.experimental.aio._base_channel.UnaryUnaryMultiCallable</p>
|
||||
<dd class="field-odd"><p>grpc.aio._base_channel.UnaryUnaryMultiCallable</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.Channel.wait_for_state_change">
|
||||
<em class="property">abstract async </em><code class="sig-name descname">wait_for_state_change</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">last_observed_state</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_channel.html#Channel.wait_for_state_change"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Channel.wait_for_state_change" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract async </em><code class="sig-name descname">wait_for_state_change</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">last_observed_state</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_channel.html#Channel.wait_for_state_change"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Channel.wait_for_state_change" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Waits for a change in connectivity state.</p>
|
||||
<p>This is an EXPERIMENTAL API.</p>
|
||||
<p>The function blocks until there is a change in the channel connectivity
|
||||
|
|
@ -387,7 +387,7 @@ the last known state.</p>
|
|||
<h3>Create Server<a class="headerlink" href="#create-server" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="py function">
|
||||
<dt id="grpc.experimental.aio.server">
|
||||
<code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">server</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">migration_thread_pool</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">handlers</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">interceptors</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">options</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">maximum_concurrent_rpcs</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">compression</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_server.html#server"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.server" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">server</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">migration_thread_pool</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">handlers</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">interceptors</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">options</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">maximum_concurrent_rpcs</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">compression</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_server.html#server"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.server" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Creates a Server with which RPCs can be serviced.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -423,11 +423,11 @@ EXPERIMENTAL option.</p></li>
|
|||
<h3>Server Object<a class="headerlink" href="#server-object" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="py class">
|
||||
<dt id="grpc.experimental.aio.Server">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">Server</code><a class="reference internal" href="_modules/grpc/experimental/aio/_base_server.html#Server"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Server" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">Server</code><a class="reference internal" href="_modules/grpc/aio/_base_server.html#Server"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Server" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Serves RPCs.</p>
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.Server.add_generic_rpc_handlers">
|
||||
<em class="property">abstract </em><code class="sig-name descname">add_generic_rpc_handlers</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">generic_rpc_handlers</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_server.html#Server.add_generic_rpc_handlers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Server.add_generic_rpc_handlers" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract </em><code class="sig-name descname">add_generic_rpc_handlers</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">generic_rpc_handlers</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_server.html#Server.add_generic_rpc_handlers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Server.add_generic_rpc_handlers" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Registers GenericRpcHandlers with this Server.</p>
|
||||
<p>This method is only safe to call before the server is started.</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -445,7 +445,7 @@ EXPERIMENTAL option.</p></li>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.Server.add_insecure_port">
|
||||
<em class="property">abstract </em><code class="sig-name descname">add_insecure_port</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">address</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_server.html#Server.add_insecure_port"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Server.add_insecure_port" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract </em><code class="sig-name descname">add_insecure_port</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">address</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_server.html#Server.add_insecure_port"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Server.add_insecure_port" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Opens an insecure port for accepting RPCs.</p>
|
||||
<p>A port is a communication endpoint that used by networking protocols,
|
||||
like TCP and UDP. To date, we only support TCP.</p>
|
||||
|
|
@ -466,7 +466,7 @@ or not specified in the address, then the gRPC runtime will choose a port.</p>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.Server.add_secure_port">
|
||||
<em class="property">abstract </em><code class="sig-name descname">add_secure_port</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">address</span></em>, <em class="sig-param"><span class="n">server_credentials</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_server.html#Server.add_secure_port"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Server.add_secure_port" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract </em><code class="sig-name descname">add_secure_port</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">address</span></em>, <em class="sig-param"><span class="n">server_credentials</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_server.html#Server.add_secure_port"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Server.add_secure_port" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Opens a secure port for accepting RPCs.</p>
|
||||
<p>A port is a communication endpoint that used by networking protocols,
|
||||
like TCP and UDP. To date, we only support TCP.</p>
|
||||
|
|
@ -491,7 +491,7 @@ runtime will choose a port.</p></li>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.Server.start">
|
||||
<em class="property">abstract async </em><code class="sig-name descname">start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_server.html#Server.start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Server.start" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract async </em><code class="sig-name descname">start</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_server.html#Server.start"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Server.start" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Starts this Server.</p>
|
||||
<p>This method may only be called once. (i.e. it is not idempotent).</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -503,7 +503,7 @@ runtime will choose a port.</p></li>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.Server.stop">
|
||||
<em class="property">abstract async </em><code class="sig-name descname">stop</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">grace</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_server.html#Server.stop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Server.stop" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract async </em><code class="sig-name descname">stop</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">grace</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_server.html#Server.stop"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Server.stop" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Stops this Server.</p>
|
||||
<p>This method immediately stops the server from servicing new RPCs in
|
||||
all cases.</p>
|
||||
|
|
@ -530,7 +530,7 @@ subsequent call will not have the effect of stopping the server later
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.Server.wait_for_termination">
|
||||
<em class="property">abstract async </em><code class="sig-name descname">wait_for_termination</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_server.html#Server.wait_for_termination"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Server.wait_for_termination" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract async </em><code class="sig-name descname">wait_for_termination</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_server.html#Server.wait_for_termination"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Server.wait_for_termination" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Continues current coroutine once the server stops.</p>
|
||||
<p>This is an EXPERIMENTAL API.</p>
|
||||
<p>The wait will not consume computational resources during blocking, and
|
||||
|
|
@ -591,7 +591,7 @@ perform certain clean-up logic, and then re-raise it.</p>
|
|||
|
||||
<dl class="py exception">
|
||||
<dt id="grpc.experimental.aio.AioRpcError">
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">AioRpcError</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">code</span></em>, <em class="sig-param"><span class="n">initial_metadata</span></em>, <em class="sig-param"><span class="n">trailing_metadata</span></em>, <em class="sig-param"><span class="n">details</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">debug_error_string</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_call.html#AioRpcError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.AioRpcError" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">exception </em><code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">AioRpcError</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">code</span></em>, <em class="sig-param"><span class="n">initial_metadata</span></em>, <em class="sig-param"><span class="n">trailing_metadata</span></em>, <em class="sig-param"><span class="n">details</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">debug_error_string</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_call.html#AioRpcError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.AioRpcError" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>An implementation of RpcError to be used by the asynchronous API.</p>
|
||||
<p>Raised RpcError is a snapshot of the final status of the RPC, values are
|
||||
determined. Hence, its methods no longer needs to be coroutines.</p>
|
||||
|
|
@ -599,8 +599,8 @@ determined. Hence, its methods no longer needs to be coroutines.</p>
|
|||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>code</strong> (<a class="reference internal" href="grpc.html#grpc.StatusCode" title="grpc.StatusCode"><em>grpc.StatusCode</em></a>) – </p></li>
|
||||
<li><p><strong>initial_metadata</strong> (<em>grpc.experimental.aio._metadata.Metadata</em>) – </p></li>
|
||||
<li><p><strong>trailing_metadata</strong> (<em>grpc.experimental.aio._metadata.Metadata</em>) – </p></li>
|
||||
<li><p><strong>initial_metadata</strong> (<em>grpc.aio._metadata.Metadata</em>) – </p></li>
|
||||
<li><p><strong>trailing_metadata</strong> (<em>grpc.aio._metadata.Metadata</em>) – </p></li>
|
||||
<li><p><strong>details</strong> (<em>Optional</em><em>[</em><em>str</em><em>]</em>) – </p></li>
|
||||
<li><p><strong>debug_error_string</strong> (<em>Optional</em><em>[</em><em>str</em><em>]</em>) – </p></li>
|
||||
</ul>
|
||||
|
|
@ -611,7 +611,7 @@ determined. Hence, its methods no longer needs to be coroutines.</p>
|
|||
</dl>
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.AioRpcError.code">
|
||||
<code class="sig-name descname">code</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_call.html#AioRpcError.code"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.AioRpcError.code" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">code</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_call.html#AioRpcError.code"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.AioRpcError.code" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Accesses the status code sent by the server.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
|
|
@ -625,7 +625,7 @@ determined. Hence, its methods no longer needs to be coroutines.</p>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.AioRpcError.debug_error_string">
|
||||
<code class="sig-name descname">debug_error_string</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_call.html#AioRpcError.debug_error_string"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.AioRpcError.debug_error_string" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">debug_error_string</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_call.html#AioRpcError.debug_error_string"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.AioRpcError.debug_error_string" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Accesses the debug error string sent by the server.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
|
|
@ -639,7 +639,7 @@ determined. Hence, its methods no longer needs to be coroutines.</p>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.AioRpcError.details">
|
||||
<code class="sig-name descname">details</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_call.html#AioRpcError.details"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.AioRpcError.details" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">details</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_call.html#AioRpcError.details"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.AioRpcError.details" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Accesses the details sent by the server.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
|
|
@ -653,28 +653,28 @@ determined. Hence, its methods no longer needs to be coroutines.</p>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.AioRpcError.initial_metadata">
|
||||
<code class="sig-name descname">initial_metadata</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_call.html#AioRpcError.initial_metadata"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.AioRpcError.initial_metadata" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">initial_metadata</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_call.html#AioRpcError.initial_metadata"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.AioRpcError.initial_metadata" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Accesses the initial metadata sent by the server.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>The initial metadata received.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p>grpc.experimental.aio._metadata.Metadata</p>
|
||||
<dd class="field-even"><p>grpc.aio._metadata.Metadata</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.AioRpcError.trailing_metadata">
|
||||
<code class="sig-name descname">trailing_metadata</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_call.html#AioRpcError.trailing_metadata"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.AioRpcError.trailing_metadata" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">trailing_metadata</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_call.html#AioRpcError.trailing_metadata"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.AioRpcError.trailing_metadata" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Accesses the trailing metadata sent by the server.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>The trailing metadata received.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p>grpc.experimental.aio._metadata.Metadata</p>
|
||||
<dd class="field-even"><p>grpc.aio._metadata.Metadata</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
|
@ -686,11 +686,11 @@ determined. Hence, its methods no longer needs to be coroutines.</p>
|
|||
<h3>Shared Context<a class="headerlink" href="#shared-context" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="py class">
|
||||
<dt id="grpc.experimental.aio.RpcContext">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">RpcContext</code><a class="reference internal" href="_modules/grpc/experimental/aio/_base_call.html#RpcContext"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.RpcContext" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">RpcContext</code><a class="reference internal" href="_modules/grpc/aio/_base_call.html#RpcContext"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.RpcContext" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Provides RPC-related information and action.</p>
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.RpcContext.add_done_callback">
|
||||
<em class="property">abstract </em><code class="sig-name descname">add_done_callback</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">callback</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_call.html#RpcContext.add_done_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.RpcContext.add_done_callback" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract </em><code class="sig-name descname">add_done_callback</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">callback</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_call.html#RpcContext.add_done_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.RpcContext.add_done_callback" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Registers a callback to be called on RPC termination.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -707,7 +707,7 @@ determined. Hence, its methods no longer needs to be coroutines.</p>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.RpcContext.cancel">
|
||||
<em class="property">abstract </em><code class="sig-name descname">cancel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_call.html#RpcContext.cancel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.RpcContext.cancel" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract </em><code class="sig-name descname">cancel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_call.html#RpcContext.cancel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.RpcContext.cancel" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Cancels the RPC.</p>
|
||||
<p>Idempotent and has no effect if the RPC has already terminated.</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -722,7 +722,7 @@ determined. Hence, its methods no longer needs to be coroutines.</p>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.RpcContext.cancelled">
|
||||
<em class="property">abstract </em><code class="sig-name descname">cancelled</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_call.html#RpcContext.cancelled"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.RpcContext.cancelled" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract </em><code class="sig-name descname">cancelled</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_call.html#RpcContext.cancelled"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.RpcContext.cancelled" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return True if the RPC is cancelled.</p>
|
||||
<p>The RPC is cancelled when the cancellation was requested with cancel().</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -737,7 +737,7 @@ determined. Hence, its methods no longer needs to be coroutines.</p>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.RpcContext.done">
|
||||
<em class="property">abstract </em><code class="sig-name descname">done</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_call.html#RpcContext.done"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.RpcContext.done" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract </em><code class="sig-name descname">done</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_call.html#RpcContext.done"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.RpcContext.done" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Return True if the RPC is done.</p>
|
||||
<p>An RPC is done if the RPC is completed, cancelled or aborted.</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -752,7 +752,7 @@ determined. Hence, its methods no longer needs to be coroutines.</p>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.RpcContext.time_remaining">
|
||||
<em class="property">abstract </em><code class="sig-name descname">time_remaining</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_call.html#RpcContext.time_remaining"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.RpcContext.time_remaining" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract </em><code class="sig-name descname">time_remaining</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_call.html#RpcContext.time_remaining"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.RpcContext.time_remaining" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Describes the length of allowed time remaining for the RPC.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
|
|
@ -773,11 +773,11 @@ timed out, or None if no deadline was specified for the RPC.</p>
|
|||
<h3>Client-Side Context<a class="headerlink" href="#client-side-context" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="py class">
|
||||
<dt id="grpc.experimental.aio.Call">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">Call</code><a class="reference internal" href="_modules/grpc/experimental/aio/_base_call.html#Call"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Call" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">Call</code><a class="reference internal" href="_modules/grpc/aio/_base_call.html#Call"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Call" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The abstract base class of an RPC on the client-side.</p>
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.Call.code">
|
||||
<em class="property">abstract async </em><code class="sig-name descname">code</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_call.html#Call.code"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Call.code" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract async </em><code class="sig-name descname">code</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_call.html#Call.code"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Call.code" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Accesses the status code sent by the server.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
|
|
@ -791,7 +791,7 @@ timed out, or None if no deadline was specified for the RPC.</p>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.Call.details">
|
||||
<em class="property">abstract async </em><code class="sig-name descname">details</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_call.html#Call.details"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Call.details" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract async </em><code class="sig-name descname">details</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_call.html#Call.details"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Call.details" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Accesses the details sent by the server.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
|
|
@ -805,35 +805,35 @@ timed out, or None if no deadline was specified for the RPC.</p>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.Call.initial_metadata">
|
||||
<em class="property">abstract async </em><code class="sig-name descname">initial_metadata</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_call.html#Call.initial_metadata"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Call.initial_metadata" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract async </em><code class="sig-name descname">initial_metadata</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_call.html#Call.initial_metadata"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Call.initial_metadata" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Accesses the initial metadata sent by the server.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>The initial <a class="reference internal" href="glossary.html#term-metadata"><span class="xref std std-term">metadata</span></a>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p>grpc.experimental.aio._metadata.Metadata</p>
|
||||
<dd class="field-even"><p>grpc.aio._metadata.Metadata</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.Call.trailing_metadata">
|
||||
<em class="property">abstract async </em><code class="sig-name descname">trailing_metadata</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_call.html#Call.trailing_metadata"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Call.trailing_metadata" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract async </em><code class="sig-name descname">trailing_metadata</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_call.html#Call.trailing_metadata"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Call.trailing_metadata" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Accesses the trailing metadata sent by the server.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>The trailing <a class="reference internal" href="glossary.html#term-metadata"><span class="xref std std-term">metadata</span></a>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p>grpc.experimental.aio._metadata.Metadata</p>
|
||||
<dd class="field-even"><p>grpc.aio._metadata.Metadata</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.Call.wait_for_connection">
|
||||
<em class="property">abstract async </em><code class="sig-name descname">wait_for_connection</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_call.html#Call.wait_for_connection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Call.wait_for_connection" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract async </em><code class="sig-name descname">wait_for_connection</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_call.html#Call.wait_for_connection"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.Call.wait_for_connection" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Waits until connected to peer and raises aio.AioRpcError if failed.</p>
|
||||
<p>This is an EXPERIMENTAL method.</p>
|
||||
<p>This method ensures the RPC has been successfully connected. Otherwise,
|
||||
|
|
@ -851,11 +851,11 @@ failure.</p>
|
|||
|
||||
<dl class="py class">
|
||||
<dt id="grpc.experimental.aio.UnaryUnaryCall">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">UnaryUnaryCall</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwds</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_call.html#UnaryUnaryCall"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.UnaryUnaryCall" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">UnaryUnaryCall</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwds</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_call.html#UnaryUnaryCall"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.UnaryUnaryCall" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The abstract base class of an unary-unary RPC on the client-side.</p>
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.UnaryUnaryCall.__await__">
|
||||
<em class="property">abstract </em><code class="sig-name descname">__await__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_call.html#UnaryUnaryCall.__await__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.UnaryUnaryCall.__await__" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract </em><code class="sig-name descname">__await__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_call.html#UnaryUnaryCall.__await__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.UnaryUnaryCall.__await__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Await the response message to be ready.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
|
|
@ -871,10 +871,10 @@ failure.</p>
|
|||
|
||||
<dl class="py class">
|
||||
<dt id="grpc.experimental.aio.UnaryStreamCall">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">UnaryStreamCall</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwds</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_call.html#UnaryStreamCall"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.UnaryStreamCall" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">UnaryStreamCall</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwds</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_call.html#UnaryStreamCall"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.UnaryStreamCall" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dt id="grpc.experimental.aio.UnaryStreamCall.__aiter__">
|
||||
<em class="property">abstract </em><code class="sig-name descname">__aiter__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_call.html#UnaryStreamCall.__aiter__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.UnaryStreamCall.__aiter__" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract </em><code class="sig-name descname">__aiter__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_call.html#UnaryStreamCall.__aiter__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.UnaryStreamCall.__aiter__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the async iterable representation that yields messages.</p>
|
||||
<p>Under the hood, it is calling the “read” method.</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -889,7 +889,7 @@ failure.</p>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.UnaryStreamCall.read">
|
||||
<em class="property">abstract async </em><code class="sig-name descname">read</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_call.html#UnaryStreamCall.read"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.UnaryStreamCall.read" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract async </em><code class="sig-name descname">read</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_call.html#UnaryStreamCall.read"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.UnaryStreamCall.read" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Reads one message from the stream.</p>
|
||||
<p>Read operations must be serialized when called from multiple
|
||||
coroutines.</p>
|
||||
|
|
@ -908,10 +908,10 @@ stream.</p>
|
|||
|
||||
<dl class="py class">
|
||||
<dt id="grpc.experimental.aio.StreamUnaryCall">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">StreamUnaryCall</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwds</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_call.html#StreamUnaryCall"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.StreamUnaryCall" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">StreamUnaryCall</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwds</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_call.html#StreamUnaryCall"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.StreamUnaryCall" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dt id="grpc.experimental.aio.StreamUnaryCall.__await__">
|
||||
<em class="property">abstract </em><code class="sig-name descname">__await__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_call.html#StreamUnaryCall.__await__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.StreamUnaryCall.__await__" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract </em><code class="sig-name descname">__await__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_call.html#StreamUnaryCall.__await__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.StreamUnaryCall.__await__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Await the response message to be ready.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
|
|
@ -925,7 +925,7 @@ stream.</p>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.StreamUnaryCall.done_writing">
|
||||
<em class="property">abstract async </em><code class="sig-name descname">done_writing</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_call.html#StreamUnaryCall.done_writing"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.StreamUnaryCall.done_writing" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract async </em><code class="sig-name descname">done_writing</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_call.html#StreamUnaryCall.done_writing"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.StreamUnaryCall.done_writing" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Notifies server that the client is done sending messages.</p>
|
||||
<p>After done_writing is called, any additional invocation to the write
|
||||
function will fail. This function is idempotent.</p>
|
||||
|
|
@ -938,7 +938,7 @@ function will fail. This function is idempotent.</p>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.StreamUnaryCall.write">
|
||||
<em class="property">abstract async </em><code class="sig-name descname">write</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_call.html#StreamUnaryCall.write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.StreamUnaryCall.write" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract async </em><code class="sig-name descname">write</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_call.html#StreamUnaryCall.write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.StreamUnaryCall.write" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Writes one message to the stream.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Raises</dt>
|
||||
|
|
@ -957,10 +957,10 @@ function will fail. This function is idempotent.</p>
|
|||
|
||||
<dl class="py class">
|
||||
<dt id="grpc.experimental.aio.StreamStreamCall">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">StreamStreamCall</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwds</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_call.html#StreamStreamCall"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.StreamStreamCall" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">StreamStreamCall</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwds</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_call.html#StreamStreamCall"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.StreamStreamCall" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><dl class="py method">
|
||||
<dt id="grpc.experimental.aio.StreamStreamCall.__aiter__">
|
||||
<em class="property">abstract </em><code class="sig-name descname">__aiter__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_call.html#StreamStreamCall.__aiter__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.StreamStreamCall.__aiter__" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract </em><code class="sig-name descname">__aiter__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_call.html#StreamStreamCall.__aiter__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.StreamStreamCall.__aiter__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Returns the async iterable representation that yields messages.</p>
|
||||
<p>Under the hood, it is calling the “read” method.</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -975,7 +975,7 @@ function will fail. This function is idempotent.</p>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.StreamStreamCall.done_writing">
|
||||
<em class="property">abstract async </em><code class="sig-name descname">done_writing</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_call.html#StreamStreamCall.done_writing"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.StreamStreamCall.done_writing" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract async </em><code class="sig-name descname">done_writing</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_call.html#StreamStreamCall.done_writing"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.StreamStreamCall.done_writing" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Notifies server that the client is done sending messages.</p>
|
||||
<p>After done_writing is called, any additional invocation to the write
|
||||
function will fail. This function is idempotent.</p>
|
||||
|
|
@ -988,7 +988,7 @@ function will fail. This function is idempotent.</p>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.StreamStreamCall.read">
|
||||
<em class="property">abstract async </em><code class="sig-name descname">read</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_call.html#StreamStreamCall.read"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.StreamStreamCall.read" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract async </em><code class="sig-name descname">read</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_call.html#StreamStreamCall.read"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.StreamStreamCall.read" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Reads one message from the stream.</p>
|
||||
<p>Read operations must be serialized when called from multiple
|
||||
coroutines.</p>
|
||||
|
|
@ -1005,7 +1005,7 @@ stream.</p>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.StreamStreamCall.write">
|
||||
<em class="property">abstract async </em><code class="sig-name descname">write</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_call.html#StreamStreamCall.write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.StreamStreamCall.write" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract async </em><code class="sig-name descname">write</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_call.html#StreamStreamCall.write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.StreamStreamCall.write" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Writes one message to the stream.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Raises</dt>
|
||||
|
|
@ -1027,11 +1027,11 @@ stream.</p>
|
|||
<h3>Server-Side Context<a class="headerlink" href="#server-side-context" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="py class">
|
||||
<dt id="grpc.experimental.aio.ServicerContext">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">ServicerContext</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwds</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_server.html#ServicerContext"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.ServicerContext" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">ServicerContext</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwds</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_server.html#ServicerContext"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.ServicerContext" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>A context object passed to method implementations.</p>
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.ServicerContext.abort">
|
||||
<em class="property">abstract async </em><code class="sig-name descname">abort</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">code</span></em>, <em class="sig-param"><span class="n">details</span></em>, <em class="sig-param"><span class="n">trailing_metadata</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_server.html#ServicerContext.abort"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.ServicerContext.abort" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract async </em><code class="sig-name descname">abort</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">code</span></em>, <em class="sig-param"><span class="n">details</span></em>, <em class="sig-param"><span class="n">trailing_metadata</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_server.html#ServicerContext.abort"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.ServicerContext.abort" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Raises an exception to terminate the RPC with a non-OK status.</p>
|
||||
<p>The code and details passed as arguments will supercede any existing
|
||||
ones.</p>
|
||||
|
|
@ -1042,7 +1042,7 @@ ones.</p>
|
|||
It must not be StatusCode.OK.</p></li>
|
||||
<li><p><strong>details</strong> (<em>str</em>) – A UTF-8-encodable string to be sent to the client upon
|
||||
termination of the RPC.</p></li>
|
||||
<li><p><strong>trailing_metadata</strong> (<em>grpc.experimental.aio._metadata.Metadata</em>) – A sequence of tuple represents the trailing
|
||||
<li><p><strong>trailing_metadata</strong> (<em>grpc.aio._metadata.Metadata</em>) – A sequence of tuple represents the trailing
|
||||
<a class="reference internal" href="glossary.html#term-metadata"><span class="xref std std-term">metadata</span></a>.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
|
|
@ -1058,7 +1058,7 @@ termination of the RPC.</p></li>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.ServicerContext.auth_context">
|
||||
<em class="property">abstract </em><code class="sig-name descname">auth_context</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_server.html#ServicerContext.auth_context"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.ServicerContext.auth_context" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract </em><code class="sig-name descname">auth_context</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_server.html#ServicerContext.auth_context"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.ServicerContext.auth_context" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Gets the auth context for the call.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
|
|
@ -1072,7 +1072,7 @@ termination of the RPC.</p></li>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.ServicerContext.disable_next_message_compression">
|
||||
<em class="property">abstract </em><code class="sig-name descname">disable_next_message_compression</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_server.html#ServicerContext.disable_next_message_compression"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.ServicerContext.disable_next_message_compression" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract </em><code class="sig-name descname">disable_next_message_compression</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_server.html#ServicerContext.disable_next_message_compression"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.ServicerContext.disable_next_message_compression" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Disables compression for the next response message.</p>
|
||||
<p>This is an EXPERIMENTAL method.</p>
|
||||
<p>This method will override any compression configuration set during
|
||||
|
|
@ -1086,21 +1086,21 @@ server creation or set on the call.</p>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.ServicerContext.invocation_metadata">
|
||||
<em class="property">abstract </em><code class="sig-name descname">invocation_metadata</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_server.html#ServicerContext.invocation_metadata"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.ServicerContext.invocation_metadata" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract </em><code class="sig-name descname">invocation_metadata</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_server.html#ServicerContext.invocation_metadata"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.ServicerContext.invocation_metadata" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Accesses the metadata from the sent by the client.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p>The invocation <a class="reference internal" href="glossary.html#term-metadata"><span class="xref std std-term">metadata</span></a>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p>Optional[grpc.experimental.aio._metadata.Metadata]</p>
|
||||
<dd class="field-even"><p>Optional[grpc.aio._metadata.Metadata]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.ServicerContext.peer">
|
||||
<em class="property">abstract </em><code class="sig-name descname">peer</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_server.html#ServicerContext.peer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.ServicerContext.peer" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract </em><code class="sig-name descname">peer</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_server.html#ServicerContext.peer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.ServicerContext.peer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Identifies the peer that invoked the RPC being serviced.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
|
|
@ -1115,7 +1115,7 @@ The string format is determined by gRPC runtime.</p>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.ServicerContext.peer_identities">
|
||||
<em class="property">abstract </em><code class="sig-name descname">peer_identities</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_server.html#ServicerContext.peer_identities"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.ServicerContext.peer_identities" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract </em><code class="sig-name descname">peer_identities</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_server.html#ServicerContext.peer_identities"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.ServicerContext.peer_identities" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Gets one or more peer identity(s).</p>
|
||||
<p>Equivalent to
|
||||
servicer_context.auth_context().get(servicer_context.peer_identity_key())</p>
|
||||
|
|
@ -1132,7 +1132,7 @@ authenticated. Each identity is returned as a raw bytes type.</p>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.ServicerContext.peer_identity_key">
|
||||
<em class="property">abstract </em><code class="sig-name descname">peer_identity_key</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_server.html#ServicerContext.peer_identity_key"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.ServicerContext.peer_identity_key" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract </em><code class="sig-name descname">peer_identity_key</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_server.html#ServicerContext.peer_identity_key"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.ServicerContext.peer_identity_key" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>The auth property used to identify the peer.</p>
|
||||
<p>For example, “x509_common_name” or “x509_subject_alternative_name” are
|
||||
used to identify an SSL peer.</p>
|
||||
|
|
@ -1149,7 +1149,7 @@ peer identity, or None if the call is not authenticated.</p>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.ServicerContext.read">
|
||||
<em class="property">abstract async </em><code class="sig-name descname">read</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_server.html#ServicerContext.read"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.ServicerContext.read" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract async </em><code class="sig-name descname">read</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_server.html#ServicerContext.read"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.ServicerContext.read" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Reads one message from the RPC.</p>
|
||||
<p>Only one read operation is allowed simultaneously.</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -1167,13 +1167,13 @@ peer identity, or None if the call is not authenticated.</p>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.ServicerContext.send_initial_metadata">
|
||||
<em class="property">abstract async </em><code class="sig-name descname">send_initial_metadata</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">initial_metadata</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_server.html#ServicerContext.send_initial_metadata"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.ServicerContext.send_initial_metadata" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract async </em><code class="sig-name descname">send_initial_metadata</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">initial_metadata</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_server.html#ServicerContext.send_initial_metadata"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.ServicerContext.send_initial_metadata" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sends the initial metadata value to the client.</p>
|
||||
<p>This method need not be called by implementations if they have no
|
||||
metadata to add to what the gRPC runtime will transmit.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>initial_metadata</strong> (<em>grpc.experimental.aio._metadata.Metadata</em>) – The initial <a class="reference internal" href="glossary.html#term-metadata"><span class="xref std std-term">metadata</span></a>.</p>
|
||||
<dd class="field-odd"><p><strong>initial_metadata</strong> (<em>grpc.aio._metadata.Metadata</em>) – The initial <a class="reference internal" href="glossary.html#term-metadata"><span class="xref std std-term">metadata</span></a>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p>None</p>
|
||||
|
|
@ -1183,7 +1183,7 @@ metadata to add to what the gRPC runtime will transmit.</p>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.ServicerContext.set_code">
|
||||
<em class="property">abstract </em><code class="sig-name descname">set_code</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">code</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_server.html#ServicerContext.set_code"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.ServicerContext.set_code" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract </em><code class="sig-name descname">set_code</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">code</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_server.html#ServicerContext.set_code"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.ServicerContext.set_code" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets the value to be used as status code upon RPC completion.</p>
|
||||
<p>This method need not be called by method implementations if they wish
|
||||
the gRPC runtime to determine the status code of the RPC.</p>
|
||||
|
|
@ -1199,7 +1199,7 @@ the gRPC runtime to determine the status code of the RPC.</p>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.ServicerContext.set_compression">
|
||||
<em class="property">abstract </em><code class="sig-name descname">set_compression</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">compression</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_server.html#ServicerContext.set_compression"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.ServicerContext.set_compression" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract </em><code class="sig-name descname">set_compression</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">compression</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_server.html#ServicerContext.set_compression"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.ServicerContext.set_compression" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Set the compression algorithm to be used for the entire call.</p>
|
||||
<p>This is an EXPERIMENTAL method.</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -1215,7 +1215,7 @@ grpc.compression.Gzip.</p>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.ServicerContext.set_details">
|
||||
<em class="property">abstract </em><code class="sig-name descname">set_details</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">details</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_server.html#ServicerContext.set_details"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.ServicerContext.set_details" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract </em><code class="sig-name descname">set_details</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">details</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_server.html#ServicerContext.set_details"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.ServicerContext.set_details" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sets the value to be used the as detail string upon RPC completion.</p>
|
||||
<p>This method need not be called by method implementations if they have
|
||||
no details to transmit.</p>
|
||||
|
|
@ -1232,13 +1232,13 @@ termination of the RPC.</p>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.ServicerContext.set_trailing_metadata">
|
||||
<em class="property">abstract async </em><code class="sig-name descname">set_trailing_metadata</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">trailing_metadata</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_server.html#ServicerContext.set_trailing_metadata"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.ServicerContext.set_trailing_metadata" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract async </em><code class="sig-name descname">set_trailing_metadata</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">trailing_metadata</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_server.html#ServicerContext.set_trailing_metadata"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.ServicerContext.set_trailing_metadata" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Sends the trailing metadata for the RPC.</p>
|
||||
<p>This method need not be called by implementations if they have no
|
||||
metadata to add to what the gRPC runtime will transmit.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>trailing_metadata</strong> (<em>grpc.experimental.aio._metadata.Metadata</em>) – The trailing <a class="reference internal" href="glossary.html#term-metadata"><span class="xref std std-term">metadata</span></a>.</p>
|
||||
<dd class="field-odd"><p><strong>trailing_metadata</strong> (<em>grpc.aio._metadata.Metadata</em>) – The trailing <a class="reference internal" href="glossary.html#term-metadata"><span class="xref std std-term">metadata</span></a>.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p>None</p>
|
||||
|
|
@ -1248,7 +1248,7 @@ metadata to add to what the gRPC runtime will transmit.</p>
|
|||
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.ServicerContext.write">
|
||||
<em class="property">abstract async </em><code class="sig-name descname">write</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">message</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_server.html#ServicerContext.write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.ServicerContext.write" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract async </em><code class="sig-name descname">write</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">message</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_server.html#ServicerContext.write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.ServicerContext.write" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Writes one message to the RPC.</p>
|
||||
<p>Only one write operation is allowed simultaneously.</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -1271,7 +1271,7 @@ metadata to add to what the gRPC runtime will transmit.</p>
|
|||
<h3>Client-Side Interceptor<a class="headerlink" href="#client-side-interceptor" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="py class">
|
||||
<dt id="grpc.experimental.aio.ClientCallDetails">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">ClientCallDetails</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">method</span></em>, <em class="sig-param"><span class="n">timeout</span></em>, <em class="sig-param"><span class="n">metadata</span></em>, <em class="sig-param"><span class="n">credentials</span></em>, <em class="sig-param"><span class="n">wait_for_ready</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_interceptor.html#ClientCallDetails"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.ClientCallDetails" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">ClientCallDetails</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">method</span></em>, <em class="sig-param"><span class="n">timeout</span></em>, <em class="sig-param"><span class="n">metadata</span></em>, <em class="sig-param"><span class="n">credentials</span></em>, <em class="sig-param"><span class="n">wait_for_ready</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_interceptor.html#ClientCallDetails"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.ClientCallDetails" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Describes an RPC to be invoked.</p>
|
||||
<p>This is an EXPERIMENTAL API.</p>
|
||||
<dl class="field-list simple">
|
||||
|
|
@ -1291,13 +1291,13 @@ flag to enable <a class="reference internal" href="glossary.html#term-wait_for_r
|
|||
|
||||
<dl class="py class">
|
||||
<dt id="grpc.experimental.aio.InterceptedUnaryUnaryCall">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">InterceptedUnaryUnaryCall</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwds</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_interceptor.html#InterceptedUnaryUnaryCall"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.InterceptedUnaryUnaryCall" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">InterceptedUnaryUnaryCall</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwds</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_interceptor.html#InterceptedUnaryUnaryCall"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.InterceptedUnaryUnaryCall" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Used for running a <cite>UnaryUnaryCall</cite> wrapped by interceptors.</p>
|
||||
<p>For the <cite>__await__</cite> method is it is proxied to the intercepted call only when
|
||||
the interceptor task is finished.</p>
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.InterceptedUnaryUnaryCall.time_remaining">
|
||||
<code class="sig-name descname">time_remaining</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_interceptor.html#InterceptedUnaryUnaryCall.time_remaining"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.InterceptedUnaryUnaryCall.time_remaining" title="Permalink to this definition">¶</a></dt>
|
||||
<code class="sig-name descname">time_remaining</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_interceptor.html#InterceptedUnaryUnaryCall.time_remaining"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.InterceptedUnaryUnaryCall.time_remaining" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Describes the length of allowed time remaining for the RPC.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
|
|
@ -1315,16 +1315,16 @@ timed out, or None if no deadline was specified for the RPC.</p>
|
|||
|
||||
<dl class="py class">
|
||||
<dt id="grpc.experimental.aio.UnaryUnaryClientInterceptor">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">UnaryUnaryClientInterceptor</code><a class="reference internal" href="_modules/grpc/experimental/aio/_interceptor.html#UnaryUnaryClientInterceptor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.UnaryUnaryClientInterceptor" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">UnaryUnaryClientInterceptor</code><a class="reference internal" href="_modules/grpc/aio/_interceptor.html#UnaryUnaryClientInterceptor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.UnaryUnaryClientInterceptor" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Affords intercepting unary-unary invocations.</p>
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.UnaryUnaryClientInterceptor.intercept_unary_unary">
|
||||
<em class="property">abstract async </em><code class="sig-name descname">intercept_unary_unary</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">continuation</span></em>, <em class="sig-param"><span class="n">client_call_details</span></em>, <em class="sig-param"><span class="n">request</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_interceptor.html#UnaryUnaryClientInterceptor.intercept_unary_unary"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.UnaryUnaryClientInterceptor.intercept_unary_unary" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract async </em><code class="sig-name descname">intercept_unary_unary</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">continuation</span></em>, <em class="sig-param"><span class="n">client_call_details</span></em>, <em class="sig-param"><span class="n">request</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_interceptor.html#UnaryUnaryClientInterceptor.intercept_unary_unary"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.UnaryUnaryClientInterceptor.intercept_unary_unary" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Intercepts a unary-unary invocation asynchronously.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>continuation</strong> (<em>Callable</em><em>[</em><em>[</em><em>grpc.experimental.aio._interceptor.ClientCallDetails</em><em>, </em><em>RequestType</em><em>]</em><em>, </em><em>grpc.experimental.aio._call.UnaryUnaryCall</em><em>]</em>) – A coroutine that proceeds with the invocation by
|
||||
<li><p><strong>continuation</strong> (<em>Callable</em><em>[</em><em>[</em><em>grpc.aio._interceptor.ClientCallDetails</em><em>, </em><em>RequestType</em><em>]</em><em>, </em><em>grpc.aio._call.UnaryUnaryCall</em><em>]</em>) – A coroutine that proceeds with the invocation by
|
||||
executing the next interceptor in the chain or invoking the
|
||||
actual RPC on the underlying Channel. It is the interceptor’s
|
||||
responsibility to call it if it decides to move the RPC forward.
|
||||
|
|
@ -1332,7 +1332,7 @@ The interceptor can use
|
|||
<cite>call = await continuation(client_call_details, request)</cite>
|
||||
to continue with the RPC. <cite>continuation</cite> returns the call to the
|
||||
RPC.</p></li>
|
||||
<li><p><strong>client_call_details</strong> (<em>grpc.experimental.aio._interceptor.ClientCallDetails</em>) – A ClientCallDetails object describing the
|
||||
<li><p><strong>client_call_details</strong> (<em>grpc.aio._interceptor.ClientCallDetails</em>) – A ClientCallDetails object describing the
|
||||
outgoing RPC.</p></li>
|
||||
<li><p><strong>request</strong> (<em>RequestType</em>) – The request value for the RPC.</p></li>
|
||||
</ul>
|
||||
|
|
@ -1347,7 +1347,7 @@ outgoing RPC.</p></li>
|
|||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p>Union[grpc.experimental.aio._call.UnaryUnaryCall, ResponseType]</p>
|
||||
<dd class="field-even"><p>Union[grpc.aio._call.UnaryUnaryCall, ResponseType]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
|
@ -1359,11 +1359,11 @@ outgoing RPC.</p></li>
|
|||
<h3>Multi-Callable Interfaces<a class="headerlink" href="#multi-callable-interfaces" title="Permalink to this headline">¶</a></h3>
|
||||
<dl class="py class">
|
||||
<dt id="grpc.experimental.aio.UnaryUnaryMultiCallable">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">UnaryUnaryMultiCallable</code><a class="reference internal" href="_modules/grpc/experimental/aio/_base_channel.html#UnaryUnaryMultiCallable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.UnaryUnaryMultiCallable" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">UnaryUnaryMultiCallable</code><a class="reference internal" href="_modules/grpc/aio/_base_channel.html#UnaryUnaryMultiCallable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.UnaryUnaryMultiCallable" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Enables asynchronous invocation of a unary-call RPC.</p>
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.UnaryUnaryMultiCallable.__call__">
|
||||
<em class="property">abstract </em><code class="sig-name descname">__call__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="o">*</span></em>, <em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">metadata</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">credentials</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">wait_for_ready</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">compression</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_channel.html#UnaryUnaryMultiCallable.__call__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.UnaryUnaryMultiCallable.__call__" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract </em><code class="sig-name descname">__call__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="o">*</span></em>, <em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">metadata</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">credentials</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">wait_for_ready</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">compression</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_channel.html#UnaryUnaryMultiCallable.__call__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.UnaryUnaryMultiCallable.__call__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Asynchronously invokes the underlying RPC.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -1371,7 +1371,7 @@ outgoing RPC.</p></li>
|
|||
<li><p><strong>request</strong> (<em>Any</em>) – The request value for the RPC.</p></li>
|
||||
<li><p><strong>timeout</strong> (<em>Optional</em><em>[</em><em>float</em><em>]</em>) – An optional duration of time in seconds to allow
|
||||
for the RPC.</p></li>
|
||||
<li><p><strong>metadata</strong> (<em>Optional</em><em>[</em><em>grpc.experimental.aio._metadata.Metadata</em><em>]</em>) – Optional <a class="reference internal" href="glossary.html#term-metadata"><span class="xref std std-term">metadata</span></a> to be transmitted to the
|
||||
<li><p><strong>metadata</strong> (<em>Optional</em><em>[</em><em>grpc.aio._metadata.Metadata</em><em>]</em>) – Optional <a class="reference internal" href="glossary.html#term-metadata"><span class="xref std std-term">metadata</span></a> to be transmitted to the
|
||||
service-side of the RPC.</p></li>
|
||||
<li><p><strong>credentials</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="grpc.html#grpc.CallCredentials" title="grpc.CallCredentials"><em>grpc.CallCredentials</em></a><em>]</em>) – An optional CallCredentials for the RPC. Only valid for
|
||||
secure Channel.</p></li>
|
||||
|
|
@ -1390,7 +1390,7 @@ grpc.compression.Gzip. This is an EXPERIMENTAL option.</p></li>
|
|||
metadata, status code, and details.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p>grpc.experimental.aio._base_call.UnaryUnaryCall</p>
|
||||
<dd class="field-even"><p>grpc.aio._base_call.UnaryUnaryCall</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
|
@ -1399,11 +1399,11 @@ grpc.compression.Gzip. This is an EXPERIMENTAL option.</p></li>
|
|||
|
||||
<dl class="py class">
|
||||
<dt id="grpc.experimental.aio.UnaryStreamMultiCallable">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">UnaryStreamMultiCallable</code><a class="reference internal" href="_modules/grpc/experimental/aio/_base_channel.html#UnaryStreamMultiCallable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.UnaryStreamMultiCallable" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">UnaryStreamMultiCallable</code><a class="reference internal" href="_modules/grpc/aio/_base_channel.html#UnaryStreamMultiCallable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.UnaryStreamMultiCallable" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Enables asynchronous invocation of a server-streaming RPC.</p>
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.UnaryStreamMultiCallable.__call__">
|
||||
<em class="property">abstract </em><code class="sig-name descname">__call__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="o">*</span></em>, <em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">metadata</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">credentials</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">wait_for_ready</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">compression</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_channel.html#UnaryStreamMultiCallable.__call__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.UnaryStreamMultiCallable.__call__" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract </em><code class="sig-name descname">__call__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="o">*</span></em>, <em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">metadata</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">credentials</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">wait_for_ready</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">compression</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_channel.html#UnaryStreamMultiCallable.__call__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.UnaryStreamMultiCallable.__call__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Asynchronously invokes the underlying RPC.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -1411,7 +1411,7 @@ grpc.compression.Gzip. This is an EXPERIMENTAL option.</p></li>
|
|||
<li><p><strong>request</strong> (<em>Any</em>) – The request value for the RPC.</p></li>
|
||||
<li><p><strong>timeout</strong> (<em>Optional</em><em>[</em><em>float</em><em>]</em>) – An optional duration of time in seconds to allow
|
||||
for the RPC.</p></li>
|
||||
<li><p><strong>metadata</strong> (<em>Optional</em><em>[</em><em>grpc.experimental.aio._metadata.Metadata</em><em>]</em>) – Optional <a class="reference internal" href="glossary.html#term-metadata"><span class="xref std std-term">metadata</span></a> to be transmitted to the
|
||||
<li><p><strong>metadata</strong> (<em>Optional</em><em>[</em><em>grpc.aio._metadata.Metadata</em><em>]</em>) – Optional <a class="reference internal" href="glossary.html#term-metadata"><span class="xref std std-term">metadata</span></a> to be transmitted to the
|
||||
service-side of the RPC.</p></li>
|
||||
<li><p><strong>credentials</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="grpc.html#grpc.CallCredentials" title="grpc.CallCredentials"><em>grpc.CallCredentials</em></a><em>]</em>) – An optional CallCredentials for the RPC. Only valid for
|
||||
secure Channel.</p></li>
|
||||
|
|
@ -1430,7 +1430,7 @@ grpc.compression.Gzip. This is an EXPERIMENTAL option.</p></li>
|
|||
metadata, status code, and details.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p>grpc.experimental.aio._base_call.UnaryStreamCall</p>
|
||||
<dd class="field-even"><p>grpc.aio._base_call.UnaryStreamCall</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
|
@ -1439,11 +1439,11 @@ grpc.compression.Gzip. This is an EXPERIMENTAL option.</p></li>
|
|||
|
||||
<dl class="py class">
|
||||
<dt id="grpc.experimental.aio.StreamUnaryMultiCallable">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">StreamUnaryMultiCallable</code><a class="reference internal" href="_modules/grpc/experimental/aio/_base_channel.html#StreamUnaryMultiCallable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.StreamUnaryMultiCallable" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">StreamUnaryMultiCallable</code><a class="reference internal" href="_modules/grpc/aio/_base_channel.html#StreamUnaryMultiCallable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.StreamUnaryMultiCallable" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Enables asynchronous invocation of a client-streaming RPC.</p>
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.StreamUnaryMultiCallable.__call__">
|
||||
<em class="property">abstract </em><code class="sig-name descname">__call__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request_iterator</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">metadata</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">credentials</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">wait_for_ready</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">compression</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_channel.html#StreamUnaryMultiCallable.__call__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.StreamUnaryMultiCallable.__call__" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract </em><code class="sig-name descname">__call__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request_iterator</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">metadata</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">credentials</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">wait_for_ready</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">compression</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_channel.html#StreamUnaryMultiCallable.__call__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.StreamUnaryMultiCallable.__call__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Asynchronously invokes the underlying RPC.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -1452,7 +1452,7 @@ grpc.compression.Gzip. This is an EXPERIMENTAL option.</p></li>
|
|||
messages for the RPC.</p></li>
|
||||
<li><p><strong>timeout</strong> (<em>Optional</em><em>[</em><em>float</em><em>]</em>) – An optional duration of time in seconds to allow
|
||||
for the RPC.</p></li>
|
||||
<li><p><strong>metadata</strong> (<em>Optional</em><em>[</em><em>grpc.experimental.aio._metadata.Metadata</em><em>]</em>) – Optional <a class="reference internal" href="glossary.html#term-metadata"><span class="xref std std-term">metadata</span></a> to be transmitted to the
|
||||
<li><p><strong>metadata</strong> (<em>Optional</em><em>[</em><em>grpc.aio._metadata.Metadata</em><em>]</em>) – Optional <a class="reference internal" href="glossary.html#term-metadata"><span class="xref std std-term">metadata</span></a> to be transmitted to the
|
||||
service-side of the RPC.</p></li>
|
||||
<li><p><strong>credentials</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="grpc.html#grpc.CallCredentials" title="grpc.CallCredentials"><em>grpc.CallCredentials</em></a><em>]</em>) – An optional CallCredentials for the RPC. Only valid for
|
||||
secure Channel.</p></li>
|
||||
|
|
@ -1471,7 +1471,7 @@ grpc.compression.Gzip. This is an EXPERIMENTAL option.</p></li>
|
|||
metadata, status code, and details.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p>grpc.experimental.aio._base_call.StreamUnaryCall</p>
|
||||
<dd class="field-even"><p>grpc.aio._base_call.StreamUnaryCall</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
|
@ -1480,11 +1480,11 @@ grpc.compression.Gzip. This is an EXPERIMENTAL option.</p></li>
|
|||
|
||||
<dl class="py class">
|
||||
<dt id="grpc.experimental.aio.StreamStreamMultiCallable">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">StreamStreamMultiCallable</code><a class="reference internal" href="_modules/grpc/experimental/aio/_base_channel.html#StreamStreamMultiCallable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.StreamStreamMultiCallable" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">class </em><code class="sig-prename descclassname">grpc.experimental.aio.</code><code class="sig-name descname">StreamStreamMultiCallable</code><a class="reference internal" href="_modules/grpc/aio/_base_channel.html#StreamStreamMultiCallable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.StreamStreamMultiCallable" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Enables asynchronous invocation of a bidirectional-streaming RPC.</p>
|
||||
<dl class="py method">
|
||||
<dt id="grpc.experimental.aio.StreamStreamMultiCallable.__call__">
|
||||
<em class="property">abstract </em><code class="sig-name descname">__call__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request_iterator</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">metadata</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">credentials</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">wait_for_ready</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">compression</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/experimental/aio/_base_channel.html#StreamStreamMultiCallable.__call__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.StreamStreamMultiCallable.__call__" title="Permalink to this definition">¶</a></dt>
|
||||
<em class="property">abstract </em><code class="sig-name descname">__call__</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request_iterator</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">timeout</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">metadata</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">credentials</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">wait_for_ready</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">compression</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/aio/_base_channel.html#StreamStreamMultiCallable.__call__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.experimental.aio.StreamStreamMultiCallable.__call__" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Asynchronously invokes the underlying RPC.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
|
|
@ -1493,7 +1493,7 @@ grpc.compression.Gzip. This is an EXPERIMENTAL option.</p></li>
|
|||
messages for the RPC.</p></li>
|
||||
<li><p><strong>timeout</strong> (<em>Optional</em><em>[</em><em>float</em><em>]</em>) – An optional duration of time in seconds to allow
|
||||
for the RPC.</p></li>
|
||||
<li><p><strong>metadata</strong> (<em>Optional</em><em>[</em><em>grpc.experimental.aio._metadata.Metadata</em><em>]</em>) – Optional <a class="reference internal" href="glossary.html#term-metadata"><span class="xref std std-term">metadata</span></a> to be transmitted to the
|
||||
<li><p><strong>metadata</strong> (<em>Optional</em><em>[</em><em>grpc.aio._metadata.Metadata</em><em>]</em>) – Optional <a class="reference internal" href="glossary.html#term-metadata"><span class="xref std std-term">metadata</span></a> to be transmitted to the
|
||||
service-side of the RPC.</p></li>
|
||||
<li><p><strong>credentials</strong> (<em>Optional</em><em>[</em><a class="reference internal" href="grpc.html#grpc.CallCredentials" title="grpc.CallCredentials"><em>grpc.CallCredentials</em></a><em>]</em>) – An optional CallCredentials for the RPC. Only valid for
|
||||
secure Channel.</p></li>
|
||||
|
|
@ -1512,7 +1512,7 @@ grpc.compression.Gzip. This is an EXPERIMENTAL option.</p></li>
|
|||
metadata, status code, and details.</p>
|
||||
</dd>
|
||||
<dt class="field-even">Return type</dt>
|
||||
<dd class="field-even"><p>grpc.experimental.aio._base_call.StreamStreamCall</p>
|
||||
<dd class="field-even"><p>grpc.aio._base_call.StreamStreamCall</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
|
|
|||
|
|
@ -4,8 +4,8 @@
|
|||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>gRPC Channelz — gRPC Python 1.31.0 documentation</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>gRPC Channelz — gRPC Python 1.32.0 documentation</title>
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
|
|
@ -32,7 +32,7 @@
|
|||
|
||||
|
||||
|
||||
<p class="blurb">1.31.0</p>
|
||||
<p class="blurb">1.32.0</p>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -4,8 +4,8 @@
|
|||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>gRPC Health Checking — gRPC Python 1.31.0 documentation</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>gRPC Health Checking — gRPC Python 1.32.0 documentation</title>
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
|
|
@ -32,7 +32,7 @@
|
|||
|
||||
|
||||
|
||||
<p class="blurb">1.31.0</p>
|
||||
<p class="blurb">1.32.0</p>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -4,8 +4,8 @@
|
|||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>gRPC Reflection — gRPC Python 1.31.0 documentation</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>gRPC Reflection — gRPC Python 1.32.0 documentation</title>
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
|
|
@ -32,7 +32,7 @@
|
|||
|
||||
|
||||
|
||||
<p class="blurb">1.31.0</p>
|
||||
<p class="blurb">1.32.0</p>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -4,8 +4,8 @@
|
|||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>gRPC Status — gRPC Python 1.31.0 documentation</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>gRPC Status — gRPC Python 1.32.0 documentation</title>
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
|
|
@ -32,7 +32,7 @@
|
|||
|
||||
|
||||
|
||||
<p class="blurb">1.31.0</p>
|
||||
<p class="blurb">1.32.0</p>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -4,8 +4,8 @@
|
|||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>gRPC Testing — gRPC Python 1.31.0 documentation</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>gRPC Testing — gRPC Python 1.32.0 documentation</title>
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
|
|
@ -32,7 +32,7 @@
|
|||
|
||||
|
||||
|
||||
<p class="blurb">1.31.0</p>
|
||||
<p class="blurb">1.32.0</p>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -4,8 +4,8 @@
|
|||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>Welcome to gRPC Python’s documentation! — gRPC Python 1.31.0 documentation</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Welcome to gRPC Python’s documentation! — gRPC Python 1.32.0 documentation</title>
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
|
|
@ -31,7 +31,7 @@
|
|||
|
||||
|
||||
|
||||
<p class="blurb">1.31.0</p>
|
||||
<p class="blurb">1.32.0</p>
|
||||
|
||||
|
||||
|
||||
|
|
@ -87,7 +87,7 @@
|
|||
|
||||
<div class="section" id="welcome-to-grpc-python-s-documentation">
|
||||
<h1>Welcome to gRPC Python’s documentation!<a class="headerlink" href="#welcome-to-grpc-python-s-documentation" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Version: 1.31.0 Release: 1.31.0</p>
|
||||
<p>Version: 1.32.0 Release: 1.32.0</p>
|
||||
</div>
|
||||
<div class="section" id="api-reference">
|
||||
<h1>API Reference<a class="headerlink" href="#api-reference" title="Permalink to this headline">¶</a></h1>
|
||||
|
|
@ -121,6 +121,7 @@
|
|||
<li class="toctree-l3"><a class="reference internal" href="grpc.html#multi-callable-interfaces">Multi-Callable Interfaces</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="grpc.html#future-interfaces">Future Interfaces</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="grpc.html#compression">Compression</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="grpc.html#runtime-protobuf-parsing">Runtime Protobuf Parsing</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
|
|
|||
Binary file not shown.
|
|
@ -4,8 +4,8 @@
|
|||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>Python Module Index — gRPC Python 1.31.0 documentation</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Python Module Index — gRPC Python 1.32.0 documentation</title>
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
|
|
@ -33,7 +33,7 @@
|
|||
|
||||
|
||||
|
||||
<p class="blurb">1.31.0</p>
|
||||
<p class="blurb">1.32.0</p>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -4,8 +4,8 @@
|
|||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>Search — gRPC Python 1.31.0 documentation</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>Search — gRPC Python 1.32.0 documentation</title>
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
|
||||
|
|
@ -35,7 +35,7 @@
|
|||
|
||||
|
||||
|
||||
<p class="blurb">1.31.0</p>
|
||||
<p class="blurb">1.32.0</p>
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
Loading…
Reference in New Issue