carto
/
grpc


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167
							
<!DOCTYPE html>

<html lang="en">
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Glossary &#8212; gRPC Python 1.36.1 documentation</title>
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <link rel="stylesheet" href="_static/alabaster.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>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="prev" title="gRPC Testing" href="grpc_testing.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.36.1</p>


<h3>Navigation</h3>
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<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 current"><a class="current reference internal" href="#">Glossary</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="index.html">Documentation overview</a><ul>
      <li>Previous: <a href="grpc_testing.html" title="previous chapter">gRPC Testing</a></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">
            
  <div class="section" id="glossary">
<h1>Glossary<a class="headerlink" href="#glossary" title="Permalink to this headline">¶</a></h1>
<dl class="glossary">
<dt id="term-metadatum">metadatum<a class="headerlink" href="#term-metadatum" title="Permalink to this term">¶</a></dt><dd><p>A key-value pair included in the HTTP header.  It is a
2-tuple where the first entry is the key and the
second is the value, i.e. (key, value).  The metadata key is an ASCII str,
and must be a valid HTTP header name.  The metadata value can be
either a valid HTTP ASCII str, or bytes.  If bytes are provided,
the key must end with ‘-bin’, i.e.
<code class="docutils literal notranslate"><span class="pre">('binary-metadata-bin',</span> <span class="pre">b'\\x00\\xFF')</span></code></p>
</dd>
<dt id="term-metadata">metadata<a class="headerlink" href="#term-metadata" title="Permalink to this term">¶</a></dt><dd><p>A sequence of metadatum.</p>
</dd>
<dt id="term-serializer">serializer<a class="headerlink" href="#term-serializer" title="Permalink to this term">¶</a></dt><dd><p>A callable function that encodes an object into bytes. Applications are
allowed to provide any customized serializer, so there isn’t a restriction
for the input object (i.e. even <code class="docutils literal notranslate"><span class="pre">None</span></code>). On the server-side, the
serializer is invoked with server handler’s return value; on the
client-side, the serializer is invoked with outbound message objects.</p>
</dd>
<dt id="term-deserializer">deserializer<a class="headerlink" href="#term-deserializer" title="Permalink to this term">¶</a></dt><dd><p>A callable function that decodes bytes into an object. Same as serializer,
the returned object doesn’t have restrictions (i.e. <code class="docutils literal notranslate"><span class="pre">None</span></code> allowed). The
deserializer is invoked with inbound message bytes on both the server side
and the client-side.</p>
</dd>
<dt id="term-wait_for_ready">wait_for_ready<a class="headerlink" href="#term-wait_for_ready" title="Permalink to this term">¶</a></dt><dd><p>If an RPC is issued but the channel is in the TRANSIENT_FAILURE or SHUTDOWN
states, the library cannot transmit the RPC at the moment. By default, the
gRPC library will fail such RPCs immediately. This is known as “fail fast.”
RPCs will not fail as a result of the channel being in other states
(CONNECTING, READY, or IDLE).</p>
<p>When the wait_for_ready option is specified, the library will queue RPCs
until the channel is READY. Any submitted RPCs may still fail before the
READY state is reached for other reasons, e.g., the client channel has been
shut down or the RPC’s deadline has been reached.</p>
</dd>
<dt id="term-channel_arguments">channel_arguments<a class="headerlink" href="#term-channel_arguments" title="Permalink to this term">¶</a></dt><dd><p>A list of key-value pairs to configure the underlying gRPC Core channel or
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.36.x/include/grpc/impl/codegen/grpc_types.h">https://github.com/grpc/grpc/blob/v1.36.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>
</dl>
</div>


          </div>
          
        </div>
      </div>
    <div class="clearer"></div>
  </div>
    <div class="footer">
      &copy;2020, The gRPC Authors.
      
      |
      <a href="_sources/glossary.rst.txt"
          rel="nofollow">Page source</a>
    </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>