carto
/
grpc


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523
							

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>grpc.beta.implementations &mdash; grpcio 1.6.0 documentation</title>
  

    <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
  

        <link rel="index" title="Index"
              href="../../../genindex.html"/>
        <link rel="search" title="Search" href="../../../search.html"/>
    <link rel="top" title="grpcio 1.6.0 documentation" href="../../../index.html"/>
        <link rel="up" title="grpc" href="../../grpc.html"/> 

  
  <script src="../../../_static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

   
  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search">
          

            <a href="../../../index.html" class="icon icon-home"> grpcio
          

          </a>

          
              <div class="version">
                1.6.0
              </div>
            
          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
              <p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../grpc.html">grpc package</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../grpc.html#glossary">Glossary</a></li>
</ul>

            
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../../../index.html">grpcio</a>
        
      </nav>


      <div class="wy-nav-content">
        <div class="rst-content">
          

<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="../../../index.html">Docs</a> &raquo;</li>
        
          <li><a href="../../index.html">Module code</a> &raquo;</li>
        
          <li><a href="../../grpc.html">grpc</a> &raquo;</li>
        
      <li>grpc.beta.implementations</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <h1>Source code for grpc.beta.implementations</h1><div class="highlight"><pre>
<span></span><span class="c1"># Copyright 2015-2016 gRPC authors.</span>
<span class="c1">#</span>
<span class="c1"># Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</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 &quot;AS IS&quot; 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="sd">&quot;&quot;&quot;Entry points into the Beta API of gRPC Python.&quot;&quot;&quot;</span>

<span class="c1"># threading is referenced from specification in this module.</span>
<span class="kn">import</span> <span class="nn">threading</span>  <span class="c1"># pylint: disable=unused-import</span>

<span class="c1"># interfaces, cardinality, and face are referenced from specification in this</span>
<span class="c1"># module.</span>
<span class="kn">import</span> <span class="nn">grpc</span>
<span class="kn">from</span> <span class="nn">grpc</span> <span class="k">import</span> <span class="n">_auth</span>
<span class="kn">from</span> <span class="nn">grpc.beta</span> <span class="k">import</span> <span class="n">_client_adaptations</span>
<span class="kn">from</span> <span class="nn">grpc.beta</span> <span class="k">import</span> <span class="n">_server_adaptations</span>
<span class="kn">from</span> <span class="nn">grpc.beta</span> <span class="k">import</span> <span class="n">interfaces</span>  <span class="c1"># pylint: disable=unused-import</span>
<span class="kn">from</span> <span class="nn">grpc.framework.common</span> <span class="k">import</span> <span class="n">cardinality</span>  <span class="c1"># pylint: disable=unused-import</span>
<span class="kn">from</span> <span class="nn">grpc.framework.interfaces.face</span> <span class="k">import</span> <span class="n">face</span>  <span class="c1"># pylint: disable=unused-import</span>

<span class="c1"># pylint: disable=too-many-arguments</span>

<span class="n">ChannelCredentials</span> <span class="o">=</span> <span class="n">grpc</span><span class="o">.</span><span class="n">ChannelCredentials</span>
<span class="n">ssl_channel_credentials</span> <span class="o">=</span> <span class="n">grpc</span><span class="o">.</span><span class="n">ssl_channel_credentials</span>
<span class="n">CallCredentials</span> <span class="o">=</span> <span class="n">grpc</span><span class="o">.</span><span class="n">CallCredentials</span>
<span class="n">metadata_call_credentials</span> <span class="o">=</span> <span class="n">grpc</span><span class="o">.</span><span class="n">metadata_call_credentials</span>


<div class="viewcode-block" id="google_call_credentials"><a class="viewcode-back" href="../../../grpc.beta.html#grpc.beta.implementations.google_call_credentials">[docs]</a><span class="k">def</span> <span class="nf">google_call_credentials</span><span class="p">(</span><span class="n">credentials</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Construct CallCredentials from GoogleCredentials.</span>

<span class="sd">  Args:</span>
<span class="sd">    credentials: A GoogleCredentials object from the oauth2client library.</span>

<span class="sd">  Returns:</span>
<span class="sd">    A CallCredentials object for use in a GRPCCallOptions object.</span>
<span class="sd">  &quot;&quot;&quot;</span>
    <span class="k">return</span> <span class="n">metadata_call_credentials</span><span class="p">(</span><span class="n">_auth</span><span class="o">.</span><span class="n">GoogleCallCredentials</span><span class="p">(</span><span class="n">credentials</span><span class="p">))</span></div>


<span class="n">access_token_call_credentials</span> <span class="o">=</span> <span class="n">grpc</span><span class="o">.</span><span class="n">access_token_call_credentials</span>
<span class="n">composite_call_credentials</span> <span class="o">=</span> <span class="n">grpc</span><span class="o">.</span><span class="n">composite_call_credentials</span>
<span class="n">composite_channel_credentials</span> <span class="o">=</span> <span class="n">grpc</span><span class="o">.</span><span class="n">composite_channel_credentials</span>


<div class="viewcode-block" id="Channel"><a class="viewcode-back" href="../../../grpc.beta.html#grpc.beta.implementations.Channel">[docs]</a><span class="k">class</span> <span class="nc">Channel</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;A channel to a remote host through which RPCs may be conducted.</span>

<span class="sd">  Only the &quot;subscribe&quot; and &quot;unsubscribe&quot; methods are supported for application</span>
<span class="sd">  use. This class&#39; instance constructor and all other attributes are</span>
<span class="sd">  unsupported.</span>
<span class="sd">  &quot;&quot;&quot;</span>

    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">channel</span><span class="p">):</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">_channel</span> <span class="o">=</span> <span class="n">channel</span>

<div class="viewcode-block" id="Channel.subscribe"><a class="viewcode-back" href="../../../grpc.beta.html#grpc.beta.implementations.Channel.subscribe">[docs]</a>    <span class="k">def</span> <span class="nf">subscribe</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">try_to_connect</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Subscribes to this Channel&#39;s connectivity.</span>

<span class="sd">    Args:</span>
<span class="sd">      callback: A callable to be invoked and passed an</span>
<span class="sd">        interfaces.ChannelConnectivity identifying this Channel&#39;s connectivity.</span>
<span class="sd">        The callable will be invoked immediately upon subscription and again for</span>
<span class="sd">        every change to this Channel&#39;s connectivity thereafter until it is</span>
<span class="sd">        unsubscribed.</span>
<span class="sd">      try_to_connect: A boolean indicating whether or not this Channel should</span>
<span class="sd">        attempt to connect if it is not already connected and ready to conduct</span>
<span class="sd">        RPCs.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">_channel</span><span class="o">.</span><span class="n">subscribe</span><span class="p">(</span><span class="n">callback</span><span class="p">,</span> <span class="n">try_to_connect</span><span class="o">=</span><span class="n">try_to_connect</span><span class="p">)</span></div>

<div class="viewcode-block" id="Channel.unsubscribe"><a class="viewcode-back" href="../../../grpc.beta.html#grpc.beta.implementations.Channel.unsubscribe">[docs]</a>    <span class="k">def</span> <span class="nf">unsubscribe</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="sd">&quot;&quot;&quot;Unsubscribes a callback from this Channel&#39;s connectivity.</span>

<span class="sd">    Args:</span>
<span class="sd">      callback: A callable previously registered with this Channel from having</span>
<span class="sd">        been passed to its &quot;subscribe&quot; method.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">_channel</span><span class="o">.</span><span class="n">unsubscribe</span><span class="p">(</span><span class="n">callback</span><span class="p">)</span></div></div>


<div class="viewcode-block" id="insecure_channel"><a class="viewcode-back" href="../../../grpc.beta.html#grpc.beta.implementations.insecure_channel">[docs]</a><span class="k">def</span> <span class="nf">insecure_channel</span><span class="p">(</span><span class="n">host</span><span class="p">,</span> <span class="n">port</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Creates an insecure Channel to a remote host.</span>

<span class="sd">  Args:</span>
<span class="sd">    host: The name of the remote host to which to connect.</span>
<span class="sd">    port: The port of the remote host to which to connect.</span>
<span class="sd">      If None only the &#39;host&#39; part will be used.</span>

<span class="sd">  Returns:</span>
<span class="sd">    A Channel to the remote host through which RPCs may be conducted.</span>
<span class="sd">  &quot;&quot;&quot;</span>
    <span class="n">channel</span> <span class="o">=</span> <span class="n">grpc</span><span class="o">.</span><span class="n">insecure_channel</span><span class="p">(</span><span class="n">host</span>
                                    <span class="k">if</span> <span class="n">port</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="s1">&#39;</span><span class="si">%s</span><span class="s1">:</span><span class="si">%d</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">host</span><span class="p">,</span> <span class="n">port</span><span class="p">))</span>
    <span class="k">return</span> <span class="n">Channel</span><span class="p">(</span><span class="n">channel</span><span class="p">)</span></div>


<div class="viewcode-block" id="secure_channel"><a class="viewcode-back" href="../../../grpc.beta.html#grpc.beta.implementations.secure_channel">[docs]</a><span class="k">def</span> <span class="nf">secure_channel</span><span class="p">(</span><span class="n">host</span><span class="p">,</span> <span class="n">port</span><span class="p">,</span> <span class="n">channel_credentials</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Creates a secure Channel to a remote host.</span>

<span class="sd">  Args:</span>
<span class="sd">    host: The name of the remote host to which to connect.</span>
<span class="sd">    port: The port of the remote host to which to connect.</span>
<span class="sd">      If None only the &#39;host&#39; part will be used.</span>
<span class="sd">    channel_credentials: A ChannelCredentials.</span>

<span class="sd">  Returns:</span>
<span class="sd">    A secure Channel to the remote host through which RPCs may be conducted.</span>
<span class="sd">  &quot;&quot;&quot;</span>
    <span class="n">channel</span> <span class="o">=</span> <span class="n">grpc</span><span class="o">.</span><span class="n">secure_channel</span><span class="p">(</span><span class="n">host</span> <span class="k">if</span> <span class="n">port</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span>
                                  <span class="s1">&#39;</span><span class="si">%s</span><span class="s1">:</span><span class="si">%d</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="n">host</span><span class="p">,</span> <span class="n">port</span><span class="p">),</span> <span class="n">channel_credentials</span><span class="p">)</span>
    <span class="k">return</span> <span class="n">Channel</span><span class="p">(</span><span class="n">channel</span><span class="p">)</span></div>


<div class="viewcode-block" id="StubOptions"><a class="viewcode-back" href="../../../grpc.beta.html#grpc.beta.implementations.StubOptions">[docs]</a><span class="k">class</span> <span class="nc">StubOptions</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;A value encapsulating the various options for creation of a Stub.</span>

<span class="sd">  This class and its instances have no supported interface - it exists to define</span>
<span class="sd">  the type of its instances and its instances exist to be passed to other</span>
<span class="sd">  functions.</span>
<span class="sd">  &quot;&quot;&quot;</span>

    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">host</span><span class="p">,</span> <span class="n">request_serializers</span><span class="p">,</span> <span class="n">response_deserializers</span><span class="p">,</span>
                 <span class="n">metadata_transformer</span><span class="p">,</span> <span class="n">thread_pool</span><span class="p">,</span> <span class="n">thread_pool_size</span><span class="p">):</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">host</span> <span class="o">=</span> <span class="n">host</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">request_serializers</span> <span class="o">=</span> <span class="n">request_serializers</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">response_deserializers</span> <span class="o">=</span> <span class="n">response_deserializers</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">metadata_transformer</span> <span class="o">=</span> <span class="n">metadata_transformer</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">thread_pool</span> <span class="o">=</span> <span class="n">thread_pool</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">thread_pool_size</span> <span class="o">=</span> <span class="n">thread_pool_size</span></div>


<span class="n">_EMPTY_STUB_OPTIONS</span> <span class="o">=</span> <span class="n">StubOptions</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>


<div class="viewcode-block" id="stub_options"><a class="viewcode-back" href="../../../grpc.beta.html#grpc.beta.implementations.stub_options">[docs]</a><span class="k">def</span> <span class="nf">stub_options</span><span class="p">(</span><span class="n">host</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                 <span class="n">request_serializers</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                 <span class="n">response_deserializers</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                 <span class="n">metadata_transformer</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                 <span class="n">thread_pool</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                 <span class="n">thread_pool_size</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Creates a StubOptions value to be passed at stub creation.</span>

<span class="sd">  All parameters are optional and should always be passed by keyword.</span>

<span class="sd">  Args:</span>
<span class="sd">    host: A host string to set on RPC calls.</span>
<span class="sd">    request_serializers: A dictionary from service name-method name pair to</span>
<span class="sd">      request serialization behavior.</span>
<span class="sd">    response_deserializers: A dictionary from service name-method name pair to</span>
<span class="sd">      response deserialization behavior.</span>
<span class="sd">    metadata_transformer: A callable that given a metadata object produces</span>
<span class="sd">      another metadata object to be used in the underlying communication on the</span>
<span class="sd">      wire.</span>
<span class="sd">    thread_pool: A thread pool to use in stubs.</span>
<span class="sd">    thread_pool_size: The size of thread pool to create for use in stubs;</span>
<span class="sd">      ignored if thread_pool has been passed.</span>

<span class="sd">  Returns:</span>
<span class="sd">    A StubOptions value created from the passed parameters.</span>
<span class="sd">  &quot;&quot;&quot;</span>
    <span class="k">return</span> <span class="n">StubOptions</span><span class="p">(</span><span class="n">host</span><span class="p">,</span> <span class="n">request_serializers</span><span class="p">,</span> <span class="n">response_deserializers</span><span class="p">,</span>
                       <span class="n">metadata_transformer</span><span class="p">,</span> <span class="n">thread_pool</span><span class="p">,</span> <span class="n">thread_pool_size</span><span class="p">)</span></div>


<div class="viewcode-block" id="generic_stub"><a class="viewcode-back" href="../../../grpc.beta.html#grpc.beta.implementations.generic_stub">[docs]</a><span class="k">def</span> <span class="nf">generic_stub</span><span class="p">(</span><span class="n">channel</span><span class="p">,</span> <span class="n">options</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Creates a face.GenericStub on which RPCs can be made.</span>

<span class="sd">  Args:</span>
<span class="sd">    channel: A Channel for use by the created stub.</span>
<span class="sd">    options: A StubOptions customizing the created stub.</span>

<span class="sd">  Returns:</span>
<span class="sd">    A face.GenericStub on which RPCs can be made.</span>
<span class="sd">  &quot;&quot;&quot;</span>
    <span class="n">effective_options</span> <span class="o">=</span> <span class="n">_EMPTY_STUB_OPTIONS</span> <span class="k">if</span> <span class="n">options</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">options</span>
    <span class="k">return</span> <span class="n">_client_adaptations</span><span class="o">.</span><span class="n">generic_stub</span><span class="p">(</span>
        <span class="n">channel</span><span class="o">.</span><span class="n">_channel</span><span class="p">,</span>  <span class="c1"># pylint: disable=protected-access</span>
        <span class="n">effective_options</span><span class="o">.</span><span class="n">host</span><span class="p">,</span>
        <span class="n">effective_options</span><span class="o">.</span><span class="n">metadata_transformer</span><span class="p">,</span>
        <span class="n">effective_options</span><span class="o">.</span><span class="n">request_serializers</span><span class="p">,</span>
        <span class="n">effective_options</span><span class="o">.</span><span class="n">response_deserializers</span><span class="p">)</span></div>


<div class="viewcode-block" id="dynamic_stub"><a class="viewcode-back" href="../../../grpc.beta.html#grpc.beta.implementations.dynamic_stub">[docs]</a><span class="k">def</span> <span class="nf">dynamic_stub</span><span class="p">(</span><span class="n">channel</span><span class="p">,</span> <span class="n">service</span><span class="p">,</span> <span class="n">cardinalities</span><span class="p">,</span> <span class="n">options</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Creates a face.DynamicStub with which RPCs can be invoked.</span>

<span class="sd">  Args:</span>
<span class="sd">    channel: A Channel for the returned face.DynamicStub to use.</span>
<span class="sd">    service: The package-qualified full name of the service.</span>
<span class="sd">    cardinalities: A dictionary from RPC method name to cardinality.Cardinality</span>
<span class="sd">      value identifying the cardinality of the RPC method.</span>
<span class="sd">    options: An optional StubOptions value further customizing the functionality</span>
<span class="sd">      of the returned face.DynamicStub.</span>

<span class="sd">  Returns:</span>
<span class="sd">    A face.DynamicStub with which RPCs can be invoked.</span>
<span class="sd">  &quot;&quot;&quot;</span>
    <span class="n">effective_options</span> <span class="o">=</span> <span class="n">_EMPTY_STUB_OPTIONS</span> <span class="k">if</span> <span class="n">options</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">options</span>
    <span class="k">return</span> <span class="n">_client_adaptations</span><span class="o">.</span><span class="n">dynamic_stub</span><span class="p">(</span>
        <span class="n">channel</span><span class="o">.</span><span class="n">_channel</span><span class="p">,</span>  <span class="c1"># pylint: disable=protected-access</span>
        <span class="n">service</span><span class="p">,</span>
        <span class="n">cardinalities</span><span class="p">,</span>
        <span class="n">effective_options</span><span class="o">.</span><span class="n">host</span><span class="p">,</span>
        <span class="n">effective_options</span><span class="o">.</span><span class="n">metadata_transformer</span><span class="p">,</span>
        <span class="n">effective_options</span><span class="o">.</span><span class="n">request_serializers</span><span class="p">,</span>
        <span class="n">effective_options</span><span class="o">.</span><span class="n">response_deserializers</span><span class="p">)</span></div>


<span class="n">ServerCredentials</span> <span class="o">=</span> <span class="n">grpc</span><span class="o">.</span><span class="n">ServerCredentials</span>
<span class="n">ssl_server_credentials</span> <span class="o">=</span> <span class="n">grpc</span><span class="o">.</span><span class="n">ssl_server_credentials</span>


<div class="viewcode-block" id="ServerOptions"><a class="viewcode-back" href="../../../grpc.beta.html#grpc.beta.implementations.ServerOptions">[docs]</a><span class="k">class</span> <span class="nc">ServerOptions</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;A value encapsulating the various options for creation of a Server.</span>

<span class="sd">  This class and its instances have no supported interface - it exists to define</span>
<span class="sd">  the type of its instances and its instances exist to be passed to other</span>
<span class="sd">  functions.</span>
<span class="sd">  &quot;&quot;&quot;</span>

    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">multi_method_implementation</span><span class="p">,</span> <span class="n">request_deserializers</span><span class="p">,</span>
                 <span class="n">response_serializers</span><span class="p">,</span> <span class="n">thread_pool</span><span class="p">,</span> <span class="n">thread_pool_size</span><span class="p">,</span>
                 <span class="n">default_timeout</span><span class="p">,</span> <span class="n">maximum_timeout</span><span class="p">):</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">multi_method_implementation</span> <span class="o">=</span> <span class="n">multi_method_implementation</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">request_deserializers</span> <span class="o">=</span> <span class="n">request_deserializers</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">response_serializers</span> <span class="o">=</span> <span class="n">response_serializers</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">thread_pool</span> <span class="o">=</span> <span class="n">thread_pool</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">thread_pool_size</span> <span class="o">=</span> <span class="n">thread_pool_size</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">default_timeout</span> <span class="o">=</span> <span class="n">default_timeout</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">maximum_timeout</span> <span class="o">=</span> <span class="n">maximum_timeout</span></div>


<span class="n">_EMPTY_SERVER_OPTIONS</span> <span class="o">=</span> <span class="n">ServerOptions</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>


<div class="viewcode-block" id="server_options"><a class="viewcode-back" href="../../../grpc.beta.html#grpc.beta.implementations.server_options">[docs]</a><span class="k">def</span> <span class="nf">server_options</span><span class="p">(</span><span class="n">multi_method_implementation</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                   <span class="n">request_deserializers</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                   <span class="n">response_serializers</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                   <span class="n">thread_pool</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                   <span class="n">thread_pool_size</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                   <span class="n">default_timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                   <span class="n">maximum_timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Creates a ServerOptions value to be passed at server creation.</span>

<span class="sd">  All parameters are optional and should always be passed by keyword.</span>

<span class="sd">  Args:</span>
<span class="sd">    multi_method_implementation: A face.MultiMethodImplementation to be called</span>
<span class="sd">      to service an RPC if the server has no specific method implementation for</span>
<span class="sd">      the name of the RPC for which service was requested.</span>
<span class="sd">    request_deserializers: A dictionary from service name-method name pair to</span>
<span class="sd">      request deserialization behavior.</span>
<span class="sd">    response_serializers: A dictionary from service name-method name pair to</span>
<span class="sd">      response serialization behavior.</span>
<span class="sd">    thread_pool: A thread pool to use in stubs.</span>
<span class="sd">    thread_pool_size: The size of thread pool to create for use in stubs;</span>
<span class="sd">      ignored if thread_pool has been passed.</span>
<span class="sd">    default_timeout: A duration in seconds to allow for RPC service when</span>
<span class="sd">      servicing RPCs that did not include a timeout value when invoked.</span>
<span class="sd">    maximum_timeout: A duration in seconds to allow for RPC service when</span>
<span class="sd">      servicing RPCs no matter what timeout value was passed when the RPC was</span>
<span class="sd">      invoked.</span>

<span class="sd">  Returns:</span>
<span class="sd">    A StubOptions value created from the passed parameters.</span>
<span class="sd">  &quot;&quot;&quot;</span>
    <span class="k">return</span> <span class="n">ServerOptions</span><span class="p">(</span><span class="n">multi_method_implementation</span><span class="p">,</span> <span class="n">request_deserializers</span><span class="p">,</span>
                         <span class="n">response_serializers</span><span class="p">,</span> <span class="n">thread_pool</span><span class="p">,</span> <span class="n">thread_pool_size</span><span class="p">,</span>
                         <span class="n">default_timeout</span><span class="p">,</span> <span class="n">maximum_timeout</span><span class="p">)</span></div>


<div class="viewcode-block" id="server"><a class="viewcode-back" href="../../../grpc.beta.html#grpc.beta.implementations.server">[docs]</a><span class="k">def</span> <span class="nf">server</span><span class="p">(</span><span class="n">service_implementations</span><span class="p">,</span> <span class="n">options</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Creates an interfaces.Server with which RPCs can be serviced.</span>

<span class="sd">  Args:</span>
<span class="sd">    service_implementations: A dictionary from service name-method name pair to</span>
<span class="sd">      face.MethodImplementation.</span>
<span class="sd">    options: An optional ServerOptions value further customizing the</span>
<span class="sd">      functionality of the returned Server.</span>

<span class="sd">  Returns:</span>
<span class="sd">    An interfaces.Server with which RPCs can be serviced.</span>
<span class="sd">  &quot;&quot;&quot;</span>
    <span class="n">effective_options</span> <span class="o">=</span> <span class="n">_EMPTY_SERVER_OPTIONS</span> <span class="k">if</span> <span class="n">options</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">options</span>
    <span class="k">return</span> <span class="n">_server_adaptations</span><span class="o">.</span><span class="n">server</span><span class="p">(</span>
        <span class="n">service_implementations</span><span class="p">,</span> <span class="n">effective_options</span><span class="o">.</span><span class="n">multi_method_implementation</span><span class="p">,</span>
        <span class="n">effective_options</span><span class="o">.</span><span class="n">request_deserializers</span><span class="p">,</span>
        <span class="n">effective_options</span><span class="o">.</span><span class="n">response_serializers</span><span class="p">,</span> <span class="n">effective_options</span><span class="o">.</span><span class="n">thread_pool</span><span class="p">,</span>
        <span class="n">effective_options</span><span class="o">.</span><span class="n">thread_pool_size</span><span class="p">)</span></div>
</pre></div>

           </div>
           <div class="articleComments">
            
           </div>
          </div>
          <footer>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2016, The gRPC Authors.

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'../../../',
            VERSION:'1.6.0',
            LANGUAGE:'en',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true,
            SOURCELINK_SUFFIX: '.txt'
        };
    </script>
      <script type="text/javascript" src="../../../_static/jquery.js"></script>
      <script type="text/javascript" src="../../../_static/underscore.js"></script>
      <script type="text/javascript" src="../../../_static/doctools.js"></script>

  
    <script type="text/javascript" src="../../../_static/js/theme.js"></script>
  

  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>
   

</body>
</html>