carto
/
grpc


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571
							

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>grpc.framework.interfaces.base.base &mdash; grpcio 1.2.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.2.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.2.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.framework.interfaces.base.base</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.framework.interfaces.base.base</h1><div class="highlight"><pre>
<span></span><span class="c1"># Copyright 2015, Google Inc.</span>
<span class="c1"># All rights reserved.</span>
<span class="c1">#</span>
<span class="c1"># Redistribution and use in source and binary forms, with or without</span>
<span class="c1"># modification, are permitted provided that the following conditions are</span>
<span class="c1"># met:</span>
<span class="c1">#</span>
<span class="c1">#     * Redistributions of source code must retain the above copyright</span>
<span class="c1"># notice, this list of conditions and the following disclaimer.</span>
<span class="c1">#     * Redistributions in binary form must reproduce the above</span>
<span class="c1"># copyright notice, this list of conditions and the following disclaimer</span>
<span class="c1"># in the documentation and/or other materials provided with the</span>
<span class="c1"># distribution.</span>
<span class="c1">#     * Neither the name of Google Inc. nor the names of its</span>
<span class="c1"># contributors may be used to endorse or promote products derived from</span>
<span class="c1"># this software without specific prior written permission.</span>
<span class="c1">#</span>
<span class="c1"># THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS</span>
<span class="c1"># &quot;AS IS&quot; AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT</span>
<span class="c1"># LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR</span>
<span class="c1"># A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT</span>
<span class="c1"># OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,</span>
<span class="c1"># SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT</span>
<span class="c1"># LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,</span>
<span class="c1"># DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY</span>
<span class="c1"># THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT</span>
<span class="c1"># (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE</span>
<span class="c1"># OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span>
<span class="sd">&quot;&quot;&quot;The base interface of RPC Framework.</span>

<span class="sd">Implementations of this interface support the conduct of &quot;operations&quot;:</span>
<span class="sd">exchanges between two distinct ends of an arbitrary number of data payloads</span>
<span class="sd">and metadata such as a name for the operation, initial and terminal metadata</span>
<span class="sd">in each direction, and flow control. These operations may be used for transfers</span>
<span class="sd">of data, remote procedure calls, status indication, or anything else</span>
<span class="sd">applications choose.</span>
<span class="sd">&quot;&quot;&quot;</span>

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

<span class="kn">import</span> <span class="nn">six</span>

<span class="c1"># abandonment is referenced from specification in this module.</span>
<span class="kn">from</span> <span class="nn">grpc.framework.foundation</span> <span class="k">import</span> <span class="n">abandonment</span>  <span class="c1"># pylint: disable=unused-import</span>

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


<div class="viewcode-block" id="NoSuchMethodError"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.base.html#grpc.framework.interfaces.base.base.NoSuchMethodError">[docs]</a><span class="k">class</span> <span class="nc">NoSuchMethodError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;Indicates that an unrecognized operation has been called.</span>

<span class="sd">    Attributes:</span>
<span class="sd">      code: A code value to communicate to the other side of the operation</span>
<span class="sd">        along with indication of operation termination. May be None.</span>
<span class="sd">      details: A details value to communicate to the other side of the</span>
<span class="sd">        operation along with indication of operation termination. May be None.</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">code</span><span class="p">,</span> <span class="n">details</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Constructor.</span>

<span class="sd">        Args:</span>
<span class="sd">          code: A code value to communicate to the other side of the operation</span>
<span class="sd">            along with indication of operation termination. May be None.</span>
<span class="sd">          details: A details value to communicate to the other side of the</span>
<span class="sd">            operation along with indication of operation termination. May be None.</span>
<span class="sd">        &quot;&quot;&quot;</span>
        <span class="nb">super</span><span class="p">(</span><span class="n">NoSuchMethodError</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">code</span> <span class="o">=</span> <span class="n">code</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">details</span> <span class="o">=</span> <span class="n">details</span></div>


<div class="viewcode-block" id="Outcome"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.base.html#grpc.framework.interfaces.base.base.Outcome">[docs]</a><span class="k">class</span> <span class="nc">Outcome</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
    <span class="sd">&quot;&quot;&quot;The outcome of an operation.</span>

<span class="sd">  Attributes:</span>
<span class="sd">    kind: A Kind value coarsely identifying how the operation terminated.</span>
<span class="sd">    code: An application-specific code value or None if no such value was</span>
<span class="sd">      provided.</span>
<span class="sd">    details: An application-specific details value or None if no such value was</span>
<span class="sd">      provided.</span>
<span class="sd">  &quot;&quot;&quot;</span>

    <span class="nd">@enum</span><span class="o">.</span><span class="n">unique</span>
<div class="viewcode-block" id="Outcome.Kind"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.base.html#grpc.framework.interfaces.base.base.Outcome.Kind">[docs]</a>    <span class="k">class</span> <span class="nc">Kind</span><span class="p">(</span><span class="n">enum</span><span class="o">.</span><span class="n">Enum</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Ways in which an operation can terminate.&quot;&quot;&quot;</span>

        <span class="n">COMPLETED</span> <span class="o">=</span> <span class="s1">&#39;completed&#39;</span>
        <span class="n">CANCELLED</span> <span class="o">=</span> <span class="s1">&#39;cancelled&#39;</span>
        <span class="n">EXPIRED</span> <span class="o">=</span> <span class="s1">&#39;expired&#39;</span>
        <span class="n">LOCAL_SHUTDOWN</span> <span class="o">=</span> <span class="s1">&#39;local shutdown&#39;</span>
        <span class="n">REMOTE_SHUTDOWN</span> <span class="o">=</span> <span class="s1">&#39;remote shutdown&#39;</span>
        <span class="n">RECEPTION_FAILURE</span> <span class="o">=</span> <span class="s1">&#39;reception failure&#39;</span>
        <span class="n">TRANSMISSION_FAILURE</span> <span class="o">=</span> <span class="s1">&#39;transmission failure&#39;</span>
        <span class="n">LOCAL_FAILURE</span> <span class="o">=</span> <span class="s1">&#39;local failure&#39;</span>
        <span class="n">REMOTE_FAILURE</span> <span class="o">=</span> <span class="s1">&#39;remote failure&#39;</span></div></div>


<div class="viewcode-block" id="Completion"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.base.html#grpc.framework.interfaces.base.base.Completion">[docs]</a><span class="k">class</span> <span class="nc">Completion</span><span class="p">(</span><span class="n">six</span><span class="o">.</span><span class="n">with_metaclass</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span><span class="p">)):</span>
    <span class="sd">&quot;&quot;&quot;An aggregate of the values exchanged upon operation completion.</span>

<span class="sd">  Attributes:</span>
<span class="sd">    terminal_metadata: A terminal metadata value for the operaton.</span>
<span class="sd">    code: A code value for the operation.</span>
<span class="sd">    message: A message value for the operation.</span>
<span class="sd">  &quot;&quot;&quot;</span></div>


<div class="viewcode-block" id="OperationContext"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.base.html#grpc.framework.interfaces.base.base.OperationContext">[docs]</a><span class="k">class</span> <span class="nc">OperationContext</span><span class="p">(</span><span class="n">six</span><span class="o">.</span><span class="n">with_metaclass</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span><span class="p">)):</span>
    <span class="sd">&quot;&quot;&quot;Provides operation-related information and action.&quot;&quot;&quot;</span>

    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<div class="viewcode-block" id="OperationContext.outcome"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.base.html#grpc.framework.interfaces.base.base.OperationContext.outcome">[docs]</a>    <span class="k">def</span> <span class="nf">outcome</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Indicates the operation&#39;s outcome (or that the operation is ongoing).</span>

<span class="sd">    Returns:</span>
<span class="sd">      None if the operation is still active or the Outcome value for the</span>
<span class="sd">        operation if it has terminated.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<div class="viewcode-block" id="OperationContext.add_termination_callback"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.base.html#grpc.framework.interfaces.base.base.OperationContext.add_termination_callback">[docs]</a>    <span class="k">def</span> <span class="nf">add_termination_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="sd">&quot;&quot;&quot;Adds a function to be called upon operation termination.</span>

<span class="sd">    Args:</span>
<span class="sd">      callback: A callable to be passed an Outcome value on operation</span>
<span class="sd">        termination.</span>

<span class="sd">    Returns:</span>
<span class="sd">      None if the operation has not yet terminated and the passed callback will</span>
<span class="sd">        later be called when it does terminate, or if the operation has already</span>
<span class="sd">        terminated an Outcome value describing the operation termination and the</span>
<span class="sd">        passed callback will not be called as a result of this method call.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<div class="viewcode-block" id="OperationContext.time_remaining"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.base.html#grpc.framework.interfaces.base.base.OperationContext.time_remaining">[docs]</a>    <span class="k">def</span> <span class="nf">time_remaining</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Describes the length of allowed time remaining for the operation.</span>

<span class="sd">    Returns:</span>
<span class="sd">      A nonnegative float indicating the length of allowed time in seconds</span>
<span class="sd">      remaining for the operation to complete before it is considered to have</span>
<span class="sd">      timed out. Zero is returned if the operation has terminated.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<div class="viewcode-block" id="OperationContext.cancel"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.base.html#grpc.framework.interfaces.base.base.OperationContext.cancel">[docs]</a>    <span class="k">def</span> <span class="nf">cancel</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Cancels the operation if the operation has not yet terminated.&quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<div class="viewcode-block" id="OperationContext.fail"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.base.html#grpc.framework.interfaces.base.base.OperationContext.fail">[docs]</a>    <span class="k">def</span> <span class="nf">fail</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">exception</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Indicates that the operation has failed.</span>

<span class="sd">    Args:</span>
<span class="sd">      exception: An exception germane to the operation failure. May be None.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>


<div class="viewcode-block" id="Operator"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.base.html#grpc.framework.interfaces.base.base.Operator">[docs]</a><span class="k">class</span> <span class="nc">Operator</span><span class="p">(</span><span class="n">six</span><span class="o">.</span><span class="n">with_metaclass</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span><span class="p">)):</span>
    <span class="sd">&quot;&quot;&quot;An interface through which to participate in an operation.&quot;&quot;&quot;</span>

    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<div class="viewcode-block" id="Operator.advance"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.base.html#grpc.framework.interfaces.base.base.Operator.advance">[docs]</a>    <span class="k">def</span> <span class="nf">advance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
                <span class="n">initial_metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                <span class="n">payload</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                <span class="n">completion</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                <span class="n">allowance</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Progresses the operation.</span>

<span class="sd">    Args:</span>
<span class="sd">      initial_metadata: An initial metadata value. Only one may ever be</span>
<span class="sd">        communicated in each direction for an operation, and they must be</span>
<span class="sd">        communicated no later than either the first payload or the completion.</span>
<span class="sd">      payload: A payload value.</span>
<span class="sd">      completion: A Completion value. May only ever be non-None once in either</span>
<span class="sd">        direction, and no payloads may be passed after it has been communicated.</span>
<span class="sd">      allowance: A positive integer communicating the number of additional</span>
<span class="sd">        payloads allowed to be passed by the remote side of the operation.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>


<div class="viewcode-block" id="ProtocolReceiver"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.base.html#grpc.framework.interfaces.base.base.ProtocolReceiver">[docs]</a><span class="k">class</span> <span class="nc">ProtocolReceiver</span><span class="p">(</span><span class="n">six</span><span class="o">.</span><span class="n">with_metaclass</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span><span class="p">)):</span>
    <span class="sd">&quot;&quot;&quot;A means of receiving protocol values during an operation.&quot;&quot;&quot;</span>

    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<div class="viewcode-block" id="ProtocolReceiver.context"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.base.html#grpc.framework.interfaces.base.base.ProtocolReceiver.context">[docs]</a>    <span class="k">def</span> <span class="nf">context</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">protocol_context</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Accepts the protocol context object for the operation.</span>

<span class="sd">    Args:</span>
<span class="sd">      protocol_context: The protocol context object for the operation.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>


<div class="viewcode-block" id="Subscription"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.base.html#grpc.framework.interfaces.base.base.Subscription">[docs]</a><span class="k">class</span> <span class="nc">Subscription</span><span class="p">(</span><span class="n">six</span><span class="o">.</span><span class="n">with_metaclass</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span><span class="p">)):</span>
    <span class="sd">&quot;&quot;&quot;Describes customer code&#39;s interest in values from the other side.</span>

<span class="sd">  Attributes:</span>
<span class="sd">    kind: A Kind value describing the overall kind of this value.</span>
<span class="sd">    termination_callback: A callable to be passed the Outcome associated with</span>
<span class="sd">      the operation after it has terminated. Must be non-None if kind is</span>
<span class="sd">      Kind.TERMINATION_ONLY. Must be None otherwise.</span>
<span class="sd">    allowance: A callable behavior that accepts positive integers representing</span>
<span class="sd">      the number of additional payloads allowed to be passed to the other side</span>
<span class="sd">      of the operation. Must be None if kind is Kind.FULL. Must not be None</span>
<span class="sd">      otherwise.</span>
<span class="sd">    operator: An Operator to be passed values from the other side of the</span>
<span class="sd">      operation. Must be non-None if kind is Kind.FULL. Must be None otherwise.</span>
<span class="sd">    protocol_receiver: A ProtocolReceiver to be passed protocol objects as they</span>
<span class="sd">      become available during the operation. Must be non-None if kind is</span>
<span class="sd">      Kind.FULL.</span>
<span class="sd">  &quot;&quot;&quot;</span>

    <span class="nd">@enum</span><span class="o">.</span><span class="n">unique</span>
<div class="viewcode-block" id="Subscription.Kind"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.base.html#grpc.framework.interfaces.base.base.Subscription.Kind">[docs]</a>    <span class="k">class</span> <span class="nc">Kind</span><span class="p">(</span><span class="n">enum</span><span class="o">.</span><span class="n">Enum</span><span class="p">):</span>

        <span class="n">NONE</span> <span class="o">=</span> <span class="s1">&#39;none&#39;</span>
        <span class="n">TERMINATION_ONLY</span> <span class="o">=</span> <span class="s1">&#39;termination only&#39;</span>
        <span class="n">FULL</span> <span class="o">=</span> <span class="s1">&#39;full&#39;</span></div></div>


<div class="viewcode-block" id="Servicer"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.base.html#grpc.framework.interfaces.base.base.Servicer">[docs]</a><span class="k">class</span> <span class="nc">Servicer</span><span class="p">(</span><span class="n">six</span><span class="o">.</span><span class="n">with_metaclass</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span><span class="p">)):</span>
    <span class="sd">&quot;&quot;&quot;Interface for service implementations.&quot;&quot;&quot;</span>

    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<div class="viewcode-block" id="Servicer.service"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.base.html#grpc.framework.interfaces.base.base.Servicer.service">[docs]</a>    <span class="k">def</span> <span class="nf">service</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">group</span><span class="p">,</span> <span class="n">method</span><span class="p">,</span> <span class="n">context</span><span class="p">,</span> <span class="n">output_operator</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Services an operation.</span>

<span class="sd">    Args:</span>
<span class="sd">      group: The group identifier of the operation to be serviced.</span>
<span class="sd">      method: The method identifier of the operation to be serviced.</span>
<span class="sd">      context: An OperationContext object affording contextual information and</span>
<span class="sd">        actions.</span>
<span class="sd">      output_operator: An Operator that will accept output values of the</span>
<span class="sd">        operation.</span>

<span class="sd">    Returns:</span>
<span class="sd">      A Subscription via which this object may or may not accept more values of</span>
<span class="sd">        the operation.</span>

<span class="sd">    Raises:</span>
<span class="sd">      NoSuchMethodError: If this Servicer does not handle operations with the</span>
<span class="sd">        given group and method.</span>
<span class="sd">      abandonment.Abandoned: If the operation has been aborted and there no</span>
<span class="sd">        longer is any reason to service the operation.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></div>


<div class="viewcode-block" id="End"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.base.html#grpc.framework.interfaces.base.base.End">[docs]</a><span class="k">class</span> <span class="nc">End</span><span class="p">(</span><span class="n">six</span><span class="o">.</span><span class="n">with_metaclass</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABCMeta</span><span class="p">)):</span>
    <span class="sd">&quot;&quot;&quot;Common type for entry-point objects on both sides of an operation.&quot;&quot;&quot;</span>

    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<div class="viewcode-block" id="End.start"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.base.html#grpc.framework.interfaces.base.base.End.start">[docs]</a>    <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="sd">&quot;&quot;&quot;Starts this object&#39;s service of operations.&quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<div class="viewcode-block" id="End.stop"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.base.html#grpc.framework.interfaces.base.base.End.stop">[docs]</a>    <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="sd">&quot;&quot;&quot;Stops this object&#39;s service of operations.</span>

<span class="sd">    This object will refuse service of new operations as soon as this method is</span>
<span class="sd">    called but operations under way at the time of the call may be given a</span>
<span class="sd">    grace period during which they are allowed to finish.</span>

<span class="sd">    Args:</span>
<span class="sd">      grace: A duration of time in seconds to allow ongoing operations to</span>
<span class="sd">        terminate before being forcefully terminated by the stopping of this</span>
<span class="sd">        End. May be zero to terminate all ongoing operations and immediately</span>
<span class="sd">        stop.</span>

<span class="sd">    Returns:</span>
<span class="sd">      A threading.Event that will be set to indicate all operations having</span>
<span class="sd">        terminated and this End having completely stopped. The returned event</span>
<span class="sd">        may not be set until after the full grace period (if some ongoing</span>
<span class="sd">        operation continues for the full length of the period) or it may be set</span>
<span class="sd">        much sooner (if for example this End had no operations in progress at</span>
<span class="sd">        the time its stop method was called).</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<div class="viewcode-block" id="End.operate"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.base.html#grpc.framework.interfaces.base.base.End.operate">[docs]</a>    <span class="k">def</span> <span class="nf">operate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
                <span class="n">group</span><span class="p">,</span>
                <span class="n">method</span><span class="p">,</span>
                <span class="n">subscription</span><span class="p">,</span>
                <span class="n">timeout</span><span class="p">,</span>
                <span class="n">initial_metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                <span class="n">payload</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                <span class="n">completion</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
                <span class="n">protocol_options</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Commences an operation.</span>

<span class="sd">    Args:</span>
<span class="sd">      group: The group identifier of the invoked operation.</span>
<span class="sd">      method: The method identifier of the invoked operation.</span>
<span class="sd">      subscription: A Subscription to which the results of the operation will be</span>
<span class="sd">        passed.</span>
<span class="sd">      timeout: A length of time in seconds to allow for the operation.</span>
<span class="sd">      initial_metadata: An initial metadata value to be sent to the other side</span>
<span class="sd">        of the operation. May be None if the initial metadata will be later</span>
<span class="sd">        passed via the returned operator or if there will be no initial metadata</span>
<span class="sd">        passed at all.</span>
<span class="sd">      payload: An initial payload for the operation.</span>
<span class="sd">      completion: A Completion value indicating the end of transmission to the</span>
<span class="sd">        other side of the operation.</span>
<span class="sd">      protocol_options: A value specified by the provider of a Base interface</span>
<span class="sd">        implementation affording custom state and behavior.</span>

<span class="sd">    Returns:</span>
<span class="sd">      A pair of objects affording information about the operation and action</span>
<span class="sd">        continuing the operation. The first element of the returned pair is an</span>
<span class="sd">        OperationContext for the operation and the second element of the</span>
<span class="sd">        returned pair is an Operator to which operation values not passed in</span>
<span class="sd">        this call should later be passed.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<div class="viewcode-block" id="End.operation_stats"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.base.html#grpc.framework.interfaces.base.base.End.operation_stats">[docs]</a>    <span class="k">def</span> <span class="nf">operation_stats</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Reports the number of terminated operations broken down by outcome.</span>

<span class="sd">    Returns:</span>
<span class="sd">      A dictionary from Outcome.Kind value to an integer identifying the number</span>
<span class="sd">        of operations that terminated with that outcome kind.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div>

    <span class="nd">@abc</span><span class="o">.</span><span class="n">abstractmethod</span>
<div class="viewcode-block" id="End.add_idle_action"><a class="viewcode-back" href="../../../../../grpc.framework.interfaces.base.html#grpc.framework.interfaces.base.base.End.add_idle_action">[docs]</a>    <span class="k">def</span> <span class="nf">add_idle_action</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">action</span><span class="p">):</span>
        <span class="sd">&quot;&quot;&quot;Adds an action to be called when this End has no ongoing operations.</span>

<span class="sd">    Args:</span>
<span class="sd">      action: A callable that accepts no arguments.</span>
<span class="sd">    &quot;&quot;&quot;</span>
        <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">()</span></div></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.2.0',
            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>