carto
/
grpc


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023
							

<!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.base package &mdash; grpcio 0.13.1rc1 documentation</title>
  

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

    <link rel="top" title="grpcio 0.13.1rc1 documentation" href="index.html"/>
        <link rel="up" title="grpc.framework package" href="grpc.framework.html"/>
        <link rel="next" title="grpc.framework.common package" href="grpc.framework.common.html"/>
        <link rel="prev" title="grpc.framework.alpha package" href="grpc.framework.alpha.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">
                0.13.1rc1
              </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">
          
            
                <ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="grpc.html">grpc package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="grpc.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="grpc.beta.html">grpc.beta package</a></li>
<li class="toctree-l3"><a class="reference internal" href="grpc.early_adopter.html">grpc.early_adopter package</a></li>
<li class="toctree-l3 current"><a class="reference internal" href="grpc.framework.html">grpc.framework package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="grpc.framework.html#subpackages">Subpackages</a></li>
<li class="toctree-l4"><a class="reference internal" href="grpc.framework.html#module-grpc.framework">Module contents</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="grpc.html#module-grpc">Module contents</a></li>
</ul>
</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="grpc.html">grpc package</a> &raquo;</li>
      
          <li><a href="grpc.framework.html">grpc.framework package</a> &raquo;</li>
      
    <li>grpc.framework.base package</li>
      <li class="wy-breadcrumbs-aside">
        
          
            <a href="_sources/grpc.framework.base.txt" rel="nofollow"> View page source</a>
          
        
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="grpc-framework-base-package">
<h1>grpc.framework.base package<a class="headerlink" href="#grpc-framework-base-package" title="Permalink to this headline">¶</a></h1>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
</div>
<div class="section" id="module-grpc.framework.base.exceptions">
<span id="grpc-framework-base-exceptions-module"></span><h2>grpc.framework.base.exceptions module<a class="headerlink" href="#module-grpc.framework.base.exceptions" title="Permalink to this headline">¶</a></h2>
<p>Exceptions defined and used by the base layer of RPC Framework.</p>
<dl class="exception">
<dt id="grpc.framework.base.exceptions.NoSuchMethodError">
<em class="property">exception </em><code class="descclassname">grpc.framework.base.exceptions.</code><code class="descname">NoSuchMethodError</code><a class="reference internal" href="_modules/grpc/framework/base/exceptions.html#NoSuchMethodError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.exceptions.NoSuchMethodError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">exceptions.Exception</span></code></p>
<p>Indicates that an operation with an unrecognized name has been called.</p>
</dd></dl>

</div>
<div class="section" id="module-grpc.framework.base.implementations">
<span id="grpc-framework-base-implementations-module"></span><h2>grpc.framework.base.implementations module<a class="headerlink" href="#module-grpc.framework.base.implementations" title="Permalink to this headline">¶</a></h2>
<p>Entry points into the ticket-exchange-based base layer implementation.</p>
<dl class="function">
<dt id="grpc.framework.base.implementations.back_link">
<code class="descclassname">grpc.framework.base.implementations.</code><code class="descname">back_link</code><span class="sig-paren">(</span><em>servicer</em>, <em>work_pool</em>, <em>transmission_pool</em>, <em>utility_pool</em>, <em>default_timeout</em>, <em>maximum_timeout</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/base/implementations.html#back_link"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.implementations.back_link" title="Permalink to this definition">¶</a></dt>
<dd><p>Factory function for creating interfaces.BackLinks.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>servicer</strong> &#8211; An interfaces.Servicer for servicing operations.</li>
<li><strong>work_pool</strong> &#8211; A thread pool to be used for doing work within the created
BackLink object.</li>
<li><strong>transmission_pool</strong> &#8211; A thread pool to be used within the created BackLink
object for transmitting values to a joined ForeLink object.</li>
<li><strong>utility_pool</strong> &#8211; A thread pool to be used within the created BackLink object
for utility tasks.</li>
<li><strong>default_timeout</strong> &#8211; A length of time in seconds to be used as the default
time alloted for a single operation.</li>
<li><strong>maximum_timeout</strong> &#8211; A length of time in seconds to be used as the maximum
time alloted for a single operation.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">An interfaces.BackLink.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="grpc.framework.base.implementations.front_link">
<code class="descclassname">grpc.framework.base.implementations.</code><code class="descname">front_link</code><span class="sig-paren">(</span><em>work_pool</em>, <em>transmission_pool</em>, <em>utility_pool</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/base/implementations.html#front_link"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.implementations.front_link" title="Permalink to this definition">¶</a></dt>
<dd><p>Factory function for creating interfaces.FrontLinks.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>work_pool</strong> &#8211; A thread pool to be used for doing work within the created
FrontLink object.</li>
<li><strong>transmission_pool</strong> &#8211; A thread pool to be used within the created FrontLink
object for transmitting values to a joined RearLink object.</li>
<li><strong>utility_pool</strong> &#8211; A thread pool to be used within the created FrontLink object
for utility tasks.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">An interfaces.FrontLink.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</div>
<div class="section" id="module-grpc.framework.base.in_memory">
<span id="grpc-framework-base-in-memory-module"></span><h2>grpc.framework.base.in_memory module<a class="headerlink" href="#module-grpc.framework.base.in_memory" title="Permalink to this headline">¶</a></h2>
<p>In-memory implementations of base layer interfaces.</p>
<dl class="class">
<dt id="grpc.framework.base.in_memory.Link">
<em class="property">class </em><code class="descclassname">grpc.framework.base.in_memory.</code><code class="descname">Link</code><span class="sig-paren">(</span><em>pool</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/base/in_memory.html#Link"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.in_memory.Link" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#grpc.framework.base.interfaces.ForeLink" title="grpc.framework.base.interfaces.ForeLink"><code class="xref py py-class docutils literal"><span class="pre">grpc.framework.base.interfaces.ForeLink</span></code></a>, <a class="reference internal" href="#grpc.framework.base.interfaces.RearLink" title="grpc.framework.base.interfaces.RearLink"><code class="xref py py-class docutils literal"><span class="pre">grpc.framework.base.interfaces.RearLink</span></code></a></p>
<p>A trivial implementation of interfaces.ForeLink and interfaces.RearLink.</p>
<dl class="method">
<dt id="grpc.framework.base.in_memory.Link.accept_back_to_front_ticket">
<code class="descname">accept_back_to_front_ticket</code><span class="sig-paren">(</span><em>ticket</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/base/in_memory.html#Link.accept_back_to_front_ticket"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.in_memory.Link.accept_back_to_front_ticket" title="Permalink to this definition">¶</a></dt>
<dd><p>See interfaces.RearLink.accept_back_to_front_ticket for specification.</p>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.base.in_memory.Link.accept_front_to_back_ticket">
<code class="descname">accept_front_to_back_ticket</code><span class="sig-paren">(</span><em>ticket</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/base/in_memory.html#Link.accept_front_to_back_ticket"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.in_memory.Link.accept_front_to_back_ticket" title="Permalink to this definition">¶</a></dt>
<dd><p>See interfaces.ForeLink.accept_front_to_back_ticket for specification.</p>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.base.in_memory.Link.join_fore_link">
<code class="descname">join_fore_link</code><span class="sig-paren">(</span><em>fore_link</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/base/in_memory.html#Link.join_fore_link"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.in_memory.Link.join_fore_link" title="Permalink to this definition">¶</a></dt>
<dd><p>See interfaces.RearLink.join_fore_link for specification.</p>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.base.in_memory.Link.join_rear_link">
<code class="descname">join_rear_link</code><span class="sig-paren">(</span><em>rear_link</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/base/in_memory.html#Link.join_rear_link"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.in_memory.Link.join_rear_link" title="Permalink to this definition">¶</a></dt>
<dd><p>See interfaces.ForeLink.join_rear_link for specification.</p>
</dd></dl>

</dd></dl>

</div>
<div class="section" id="module-grpc.framework.base.interfaces">
<span id="grpc-framework-base-interfaces-module"></span><h2>grpc.framework.base.interfaces module<a class="headerlink" href="#module-grpc.framework.base.interfaces" title="Permalink to this headline">¶</a></h2>
<p>Interfaces defined and used by the base layer of RPC Framework.</p>
<dl class="class">
<dt id="grpc.framework.base.interfaces.Back">
<em class="property">class </em><code class="descclassname">grpc.framework.base.interfaces.</code><code class="descname">Back</code><a class="reference internal" href="_modules/grpc/framework/base/interfaces.html#Back"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.interfaces.Back" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#grpc.framework.base.interfaces.End" title="grpc.framework.base.interfaces.End"><code class="xref py py-class docutils literal"><span class="pre">grpc.framework.base.interfaces.End</span></code></a></p>
<p>Serverish objects that perform the work of operations.</p>
</dd></dl>

<dl class="class">
<dt id="grpc.framework.base.interfaces.BackLink">
<em class="property">class </em><code class="descclassname">grpc.framework.base.interfaces.</code><code class="descname">BackLink</code><a class="reference internal" href="_modules/grpc/framework/base/interfaces.html#BackLink"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.interfaces.BackLink" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#grpc.framework.base.interfaces.Back" title="grpc.framework.base.interfaces.Back"><code class="xref py py-class docutils literal"><span class="pre">grpc.framework.base.interfaces.Back</span></code></a>, <a class="reference internal" href="#grpc.framework.base.interfaces.RearLink" title="grpc.framework.base.interfaces.RearLink"><code class="xref py py-class docutils literal"><span class="pre">grpc.framework.base.interfaces.RearLink</span></code></a></p>
<p>Serverish objects that operate by sending and receiving tickets.</p>
</dd></dl>

<dl class="class">
<dt id="grpc.framework.base.interfaces.BackToFrontTicket">
<em class="property">class </em><code class="descclassname">grpc.framework.base.interfaces.</code><code class="descname">BackToFrontTicket</code><a class="reference internal" href="_modules/grpc/framework/base/interfaces.html#BackToFrontTicket"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.interfaces.BackToFrontTicket" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#grpc.framework.base.interfaces.BackToFrontTicket" title="grpc.framework.base.interfaces.BackToFrontTicket"><code class="xref py py-class docutils literal"><span class="pre">grpc.framework.base.interfaces.BackToFrontTicket</span></code></a></p>
<p>A sum type for all values sent from a back to a front.</p>
<dl class="attribute">
<dt id="grpc.framework.base.interfaces.BackToFrontTicket.operation_id">
<code class="descname">operation_id</code><a class="headerlink" href="#grpc.framework.base.interfaces.BackToFrontTicket.operation_id" title="Permalink to this definition">¶</a></dt>
<dd><p>A unique-with-respect-to-equality hashable object identifying
a particular operation.</p>
</dd></dl>

<dl class="attribute">
<dt id="grpc.framework.base.interfaces.BackToFrontTicket.sequence_number">
<code class="descname">sequence_number</code><a class="headerlink" href="#grpc.framework.base.interfaces.BackToFrontTicket.sequence_number" title="Permalink to this definition">¶</a></dt>
<dd><p>A zero-indexed integer sequence number identifying the
ticket&#8217;s place among all the tickets sent from back to front for this
particular operation.</p>
</dd></dl>

<dl class="attribute">
<dt id="grpc.framework.base.interfaces.BackToFrontTicket.kind">
<code class="descname">kind</code><a class="headerlink" href="#grpc.framework.base.interfaces.BackToFrontTicket.kind" title="Permalink to this definition">¶</a></dt>
<dd><p>A Kind value describing the overall kind of ticket.</p>
</dd></dl>

<dl class="attribute">
<dt id="grpc.framework.base.interfaces.BackToFrontTicket.payload">
<code class="descname">payload</code><a class="headerlink" href="#grpc.framework.base.interfaces.BackToFrontTicket.payload" title="Permalink to this definition">¶</a></dt>
<dd><p>A customer payload object. Must be present if kind is
Kind.CONTINUATION. May be None if kind is Kind.COMPLETION. Must be None
otherwise.</p>
</dd></dl>

<dl class="class">
<dt id="grpc.framework.base.interfaces.BackToFrontTicket.Kind">
<em class="property">class </em><code class="descname">Kind</code><a class="reference internal" href="_modules/grpc/framework/base/interfaces.html#BackToFrontTicket.Kind"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.interfaces.BackToFrontTicket.Kind" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">enum.Enum</span></code></p>
<p>Identifies the overall kind of a BackToFrontTicket.</p>
<dl class="attribute">
<dt id="grpc.framework.base.interfaces.BackToFrontTicket.Kind.CANCELLATION">
<code class="descname">CANCELLATION</code><em class="property"> = &lt;Kind.CANCELLATION: 'cancellation'&gt;</em><a class="headerlink" href="#grpc.framework.base.interfaces.BackToFrontTicket.Kind.CANCELLATION" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="grpc.framework.base.interfaces.BackToFrontTicket.Kind.COMPLETION">
<code class="descname">COMPLETION</code><em class="property"> = &lt;Kind.COMPLETION: 'completion'&gt;</em><a class="headerlink" href="#grpc.framework.base.interfaces.BackToFrontTicket.Kind.COMPLETION" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="grpc.framework.base.interfaces.BackToFrontTicket.Kind.CONTINUATION">
<code class="descname">CONTINUATION</code><em class="property"> = &lt;Kind.CONTINUATION: 'continuation'&gt;</em><a class="headerlink" href="#grpc.framework.base.interfaces.BackToFrontTicket.Kind.CONTINUATION" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="grpc.framework.base.interfaces.BackToFrontTicket.Kind.EXPIRATION">
<code class="descname">EXPIRATION</code><em class="property"> = &lt;Kind.EXPIRATION: 'expiration'&gt;</em><a class="headerlink" href="#grpc.framework.base.interfaces.BackToFrontTicket.Kind.EXPIRATION" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="grpc.framework.base.interfaces.BackToFrontTicket.Kind.RECEPTION_FAILURE">
<code class="descname">RECEPTION_FAILURE</code><em class="property"> = &lt;Kind.RECEPTION_FAILURE: 'reception failure'&gt;</em><a class="headerlink" href="#grpc.framework.base.interfaces.BackToFrontTicket.Kind.RECEPTION_FAILURE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="grpc.framework.base.interfaces.BackToFrontTicket.Kind.SERVICED_FAILURE">
<code class="descname">SERVICED_FAILURE</code><em class="property"> = &lt;Kind.SERVICED_FAILURE: 'serviced failure'&gt;</em><a class="headerlink" href="#grpc.framework.base.interfaces.BackToFrontTicket.Kind.SERVICED_FAILURE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="grpc.framework.base.interfaces.BackToFrontTicket.Kind.SERVICER_FAILURE">
<code class="descname">SERVICER_FAILURE</code><em class="property"> = &lt;Kind.SERVICER_FAILURE: 'servicer failure'&gt;</em><a class="headerlink" href="#grpc.framework.base.interfaces.BackToFrontTicket.Kind.SERVICER_FAILURE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="grpc.framework.base.interfaces.BackToFrontTicket.Kind.TRANSMISSION_FAILURE">
<code class="descname">TRANSMISSION_FAILURE</code><em class="property"> = &lt;Kind.TRANSMISSION_FAILURE: 'transmission failure'&gt;</em><a class="headerlink" href="#grpc.framework.base.interfaces.BackToFrontTicket.Kind.TRANSMISSION_FAILURE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

</dd></dl>

<dl class="class">
<dt id="grpc.framework.base.interfaces.End">
<em class="property">class </em><code class="descclassname">grpc.framework.base.interfaces.</code><code class="descname">End</code><a class="reference internal" href="_modules/grpc/framework/base/interfaces.html#End"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.interfaces.End" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Common type for entry-point objects on both sides of an operation.</p>
<dl class="method">
<dt id="grpc.framework.base.interfaces.End.add_idle_action">
<code class="descname">add_idle_action</code><span class="sig-paren">(</span><em>action</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/base/interfaces.html#End.add_idle_action"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.interfaces.End.add_idle_action" title="Permalink to this definition">¶</a></dt>
<dd><p>Adds an action to be called when this End has no ongoing operations.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>action</strong> &#8211; A callable that accepts no arguments.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.base.interfaces.End.operation_stats">
<code class="descname">operation_stats</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/base/interfaces.html#End.operation_stats"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.interfaces.End.operation_stats" title="Permalink to this definition">¶</a></dt>
<dd><p>Reports the number of terminated operations broken down by outcome.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><dl class="docutils">
<dt>A dictionary from Outcome value to an integer identifying the number</dt>
<dd>of operations that terminated with that outcome.</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="grpc.framework.base.interfaces.ForeLink">
<em class="property">class </em><code class="descclassname">grpc.framework.base.interfaces.</code><code class="descname">ForeLink</code><a class="reference internal" href="_modules/grpc/framework/base/interfaces.html#ForeLink"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.interfaces.ForeLink" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Accepts back-to-front tickets and emits front-to-back tickets.</p>
<dl class="method">
<dt id="grpc.framework.base.interfaces.ForeLink.accept_back_to_front_ticket">
<code class="descname">accept_back_to_front_ticket</code><span class="sig-paren">(</span><em>ticket</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/base/interfaces.html#ForeLink.accept_back_to_front_ticket"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.interfaces.ForeLink.accept_back_to_front_ticket" title="Permalink to this definition">¶</a></dt>
<dd><p>Accept a BackToFrontTicket.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ticket</strong> &#8211; Any BackToFrontTicket.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.base.interfaces.ForeLink.join_rear_link">
<code class="descname">join_rear_link</code><span class="sig-paren">(</span><em>rear_link</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/base/interfaces.html#ForeLink.join_rear_link"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.interfaces.ForeLink.join_rear_link" title="Permalink to this definition">¶</a></dt>
<dd><p>Mates this object with a peer with which it will exchange tickets.</p>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="grpc.framework.base.interfaces.Front">
<em class="property">class </em><code class="descclassname">grpc.framework.base.interfaces.</code><code class="descname">Front</code><a class="reference internal" href="_modules/grpc/framework/base/interfaces.html#Front"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.interfaces.Front" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#grpc.framework.base.interfaces.End" title="grpc.framework.base.interfaces.End"><code class="xref py py-class docutils literal"><span class="pre">grpc.framework.base.interfaces.End</span></code></a></p>
<p>Clientish objects that afford the invocation of operations.</p>
<dl class="method">
<dt id="grpc.framework.base.interfaces.Front.operate">
<code class="descname">operate</code><span class="sig-paren">(</span><em>name</em>, <em>payload</em>, <em>complete</em>, <em>timeout</em>, <em>subscription</em>, <em>trace_id</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/base/interfaces.html#Front.operate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.interfaces.Front.operate" title="Permalink to this definition">¶</a></dt>
<dd><p>Commences an operation.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>name</strong> &#8211; The name of the method invoked for the operation.</li>
<li><strong>payload</strong> &#8211; An initial payload for the operation. May be None.</li>
<li><strong>complete</strong> &#8211; A boolean indicating whether or not additional payloads to be
sent to the servicer may be supplied after this call.</li>
<li><strong>timeout</strong> &#8211; A length of time in seconds to allow for the operation.</li>
<li><strong>subscription</strong> &#8211; A ServicedSubscription for the operation.</li>
<li><strong>trace_id</strong> &#8211; A uuid.UUID identifying a set of related operations to which
this operation belongs.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><dl class="docutils">
<dt>An Operation object affording information and action about the operation</dt>
<dd><p class="first last">in progress.</p>
</dd>
</dl>
</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="grpc.framework.base.interfaces.FrontLink">
<em class="property">class </em><code class="descclassname">grpc.framework.base.interfaces.</code><code class="descname">FrontLink</code><a class="reference internal" href="_modules/grpc/framework/base/interfaces.html#FrontLink"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.interfaces.FrontLink" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#grpc.framework.base.interfaces.Front" title="grpc.framework.base.interfaces.Front"><code class="xref py py-class docutils literal"><span class="pre">grpc.framework.base.interfaces.Front</span></code></a>, <a class="reference internal" href="#grpc.framework.base.interfaces.ForeLink" title="grpc.framework.base.interfaces.ForeLink"><code class="xref py py-class docutils literal"><span class="pre">grpc.framework.base.interfaces.ForeLink</span></code></a></p>
<p>Clientish objects that operate by sending and receiving tickets.</p>
</dd></dl>

<dl class="class">
<dt id="grpc.framework.base.interfaces.FrontToBackTicket">
<em class="property">class </em><code class="descclassname">grpc.framework.base.interfaces.</code><code class="descname">FrontToBackTicket</code><a class="reference internal" href="_modules/grpc/framework/base/interfaces.html#FrontToBackTicket"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.interfaces.FrontToBackTicket" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#grpc.framework.base.interfaces.FrontToBackTicket" title="grpc.framework.base.interfaces.FrontToBackTicket"><code class="xref py py-class docutils literal"><span class="pre">grpc.framework.base.interfaces.FrontToBackTicket</span></code></a></p>
<p>A sum type for all values sent from a front to a back.</p>
<dl class="attribute">
<dt id="grpc.framework.base.interfaces.FrontToBackTicket.operation_id">
<code class="descname">operation_id</code><a class="headerlink" href="#grpc.framework.base.interfaces.FrontToBackTicket.operation_id" title="Permalink to this definition">¶</a></dt>
<dd><p>A unique-with-respect-to-equality hashable object identifying
a particular operation.</p>
</dd></dl>

<dl class="attribute">
<dt id="grpc.framework.base.interfaces.FrontToBackTicket.sequence_number">
<code class="descname">sequence_number</code><a class="headerlink" href="#grpc.framework.base.interfaces.FrontToBackTicket.sequence_number" title="Permalink to this definition">¶</a></dt>
<dd><p>A zero-indexed integer sequence number identifying the
ticket&#8217;s place among all the tickets sent from front to back for this
particular operation. Must be zero if kind is Kind.COMMENCEMENT or
Kind.ENTIRE. Must be positive for any other kind.</p>
</dd></dl>

<dl class="attribute">
<dt id="grpc.framework.base.interfaces.FrontToBackTicket.kind">
<code class="descname">kind</code><a class="headerlink" href="#grpc.framework.base.interfaces.FrontToBackTicket.kind" title="Permalink to this definition">¶</a></dt>
<dd><p>A Kind value describing the overall kind of ticket.</p>
</dd></dl>

<dl class="attribute">
<dt id="grpc.framework.base.interfaces.FrontToBackTicket.name">
<code class="descname">name</code><a class="headerlink" href="#grpc.framework.base.interfaces.FrontToBackTicket.name" title="Permalink to this definition">¶</a></dt>
<dd><p>The name of an operation. Must be present if kind is Kind.COMMENCEMENT
or Kind.ENTIRE. Must be None for any other kind.</p>
</dd></dl>

<dl class="attribute">
<dt id="grpc.framework.base.interfaces.FrontToBackTicket.subscription">
<code class="descname">subscription</code><a class="headerlink" href="#grpc.framework.base.interfaces.FrontToBackTicket.subscription" title="Permalink to this definition">¶</a></dt>
<dd><p>An ServicedSubscription.Kind value describing the interest
the front has in tickets sent from the back. Must be present if
kind is Kind.COMMENCEMENT or Kind.ENTIRE. Must be None for any other kind.</p>
</dd></dl>

<dl class="attribute">
<dt id="grpc.framework.base.interfaces.FrontToBackTicket.trace_id">
<code class="descname">trace_id</code><a class="headerlink" href="#grpc.framework.base.interfaces.FrontToBackTicket.trace_id" title="Permalink to this definition">¶</a></dt>
<dd><p>A uuid.UUID identifying a set of related operations to which this
operation belongs. May be None.</p>
</dd></dl>

<dl class="attribute">
<dt id="grpc.framework.base.interfaces.FrontToBackTicket.payload">
<code class="descname">payload</code><a class="headerlink" href="#grpc.framework.base.interfaces.FrontToBackTicket.payload" title="Permalink to this definition">¶</a></dt>
<dd><p>A customer payload object. Must be present if kind is
Kind.CONTINUATION. Must be None if kind is Kind.CANCELLATION. May be None
for any other kind.</p>
</dd></dl>

<dl class="attribute">
<dt id="grpc.framework.base.interfaces.FrontToBackTicket.timeout">
<code class="descname">timeout</code><a class="headerlink" href="#grpc.framework.base.interfaces.FrontToBackTicket.timeout" title="Permalink to this definition">¶</a></dt>
<dd><p>An optional length of time (measured from the beginning of the
operation) to allow for the entire operation. If None, a default value on
the back will be used. If present and excessively large, the back may
limit the operation to a smaller duration of its choice. May be present
for any ticket kind; setting a value on a later ticket allows fronts
to request time extensions (or even time reductions!) on in-progress
operations.</p>
</dd></dl>

<dl class="class">
<dt id="grpc.framework.base.interfaces.FrontToBackTicket.Kind">
<em class="property">class </em><code class="descname">Kind</code><a class="reference internal" href="_modules/grpc/framework/base/interfaces.html#FrontToBackTicket.Kind"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.interfaces.FrontToBackTicket.Kind" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">enum.Enum</span></code></p>
<p>Identifies the overall kind of a FrontToBackTicket.</p>
<dl class="attribute">
<dt id="grpc.framework.base.interfaces.FrontToBackTicket.Kind.CANCELLATION">
<code class="descname">CANCELLATION</code><em class="property"> = &lt;Kind.CANCELLATION: 'cancellation'&gt;</em><a class="headerlink" href="#grpc.framework.base.interfaces.FrontToBackTicket.Kind.CANCELLATION" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="grpc.framework.base.interfaces.FrontToBackTicket.Kind.COMMENCEMENT">
<code class="descname">COMMENCEMENT</code><em class="property"> = &lt;Kind.COMMENCEMENT: 'commencement'&gt;</em><a class="headerlink" href="#grpc.framework.base.interfaces.FrontToBackTicket.Kind.COMMENCEMENT" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="grpc.framework.base.interfaces.FrontToBackTicket.Kind.COMPLETION">
<code class="descname">COMPLETION</code><em class="property"> = &lt;Kind.COMPLETION: 'completion'&gt;</em><a class="headerlink" href="#grpc.framework.base.interfaces.FrontToBackTicket.Kind.COMPLETION" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="grpc.framework.base.interfaces.FrontToBackTicket.Kind.CONTINUATION">
<code class="descname">CONTINUATION</code><em class="property"> = &lt;Kind.CONTINUATION: 'continuation'&gt;</em><a class="headerlink" href="#grpc.framework.base.interfaces.FrontToBackTicket.Kind.CONTINUATION" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="grpc.framework.base.interfaces.FrontToBackTicket.Kind.ENTIRE">
<code class="descname">ENTIRE</code><em class="property"> = &lt;Kind.ENTIRE: 'entire'&gt;</em><a class="headerlink" href="#grpc.framework.base.interfaces.FrontToBackTicket.Kind.ENTIRE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="grpc.framework.base.interfaces.FrontToBackTicket.Kind.EXPIRATION">
<code class="descname">EXPIRATION</code><em class="property"> = &lt;Kind.EXPIRATION: 'expiration'&gt;</em><a class="headerlink" href="#grpc.framework.base.interfaces.FrontToBackTicket.Kind.EXPIRATION" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="grpc.framework.base.interfaces.FrontToBackTicket.Kind.RECEPTION_FAILURE">
<code class="descname">RECEPTION_FAILURE</code><em class="property"> = &lt;Kind.RECEPTION_FAILURE: 'reception failure'&gt;</em><a class="headerlink" href="#grpc.framework.base.interfaces.FrontToBackTicket.Kind.RECEPTION_FAILURE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="grpc.framework.base.interfaces.FrontToBackTicket.Kind.SERVICED_FAILURE">
<code class="descname">SERVICED_FAILURE</code><em class="property"> = &lt;Kind.SERVICED_FAILURE: 'serviced failure'&gt;</em><a class="headerlink" href="#grpc.framework.base.interfaces.FrontToBackTicket.Kind.SERVICED_FAILURE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="grpc.framework.base.interfaces.FrontToBackTicket.Kind.SERVICER_FAILURE">
<code class="descname">SERVICER_FAILURE</code><em class="property"> = &lt;Kind.SERVICER_FAILURE: 'servicer failure'&gt;</em><a class="headerlink" href="#grpc.framework.base.interfaces.FrontToBackTicket.Kind.SERVICER_FAILURE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="grpc.framework.base.interfaces.FrontToBackTicket.Kind.TRANSMISSION_FAILURE">
<code class="descname">TRANSMISSION_FAILURE</code><em class="property"> = &lt;Kind.TRANSMISSION_FAILURE: 'transmission failure'&gt;</em><a class="headerlink" href="#grpc.framework.base.interfaces.FrontToBackTicket.Kind.TRANSMISSION_FAILURE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

</dd></dl>

<dl class="class">
<dt id="grpc.framework.base.interfaces.Operation">
<em class="property">class </em><code class="descclassname">grpc.framework.base.interfaces.</code><code class="descname">Operation</code><a class="reference internal" href="_modules/grpc/framework/base/interfaces.html#Operation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.interfaces.Operation" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Representation of an in-progress operation.</p>
<dl class="attribute">
<dt id="grpc.framework.base.interfaces.Operation.consumer">
<code class="descname">consumer</code><a class="headerlink" href="#grpc.framework.base.interfaces.Operation.consumer" title="Permalink to this definition">¶</a></dt>
<dd><p>A stream.Consumer into which payloads constituting the operation&#8217;s
input may be passed.</p>
</dd></dl>

<dl class="attribute">
<dt id="grpc.framework.base.interfaces.Operation.context">
<code class="descname">context</code><a class="headerlink" href="#grpc.framework.base.interfaces.Operation.context" title="Permalink to this definition">¶</a></dt>
<dd><p>An OperationContext affording information and action about the
operation.</p>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.base.interfaces.Operation.cancel">
<code class="descname">cancel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/base/interfaces.html#Operation.cancel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.interfaces.Operation.cancel" title="Permalink to this definition">¶</a></dt>
<dd><p>Cancels this operation.</p>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="grpc.framework.base.interfaces.OperationContext">
<em class="property">class </em><code class="descclassname">grpc.framework.base.interfaces.</code><code class="descname">OperationContext</code><a class="reference internal" href="_modules/grpc/framework/base/interfaces.html#OperationContext"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.interfaces.OperationContext" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Provides operation-related information and action.</p>
<dl class="attribute">
<dt id="grpc.framework.base.interfaces.OperationContext.trace_id">
<code class="descname">trace_id</code><a class="headerlink" href="#grpc.framework.base.interfaces.OperationContext.trace_id" title="Permalink to this definition">¶</a></dt>
<dd><p>A uuid.UUID identifying a particular set of related operations.</p>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.base.interfaces.OperationContext.add_termination_callback">
<code class="descname">add_termination_callback</code><span class="sig-paren">(</span><em>callback</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/base/interfaces.html#OperationContext.add_termination_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.interfaces.OperationContext.add_termination_callback" title="Permalink to this definition">¶</a></dt>
<dd><p>Adds a function to be called upon operation termination.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>callback</strong> &#8211; A callable that will be passed an Outcome value.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.base.interfaces.OperationContext.fail">
<code class="descname">fail</code><span class="sig-paren">(</span><em>exception</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/base/interfaces.html#OperationContext.fail"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.interfaces.OperationContext.fail" title="Permalink to this definition">¶</a></dt>
<dd><p>Indicates that the operation has failed.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>exception</strong> &#8211; An exception germane to the operation failure. May be None.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.base.interfaces.OperationContext.is_active">
<code class="descname">is_active</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/base/interfaces.html#OperationContext.is_active"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.interfaces.OperationContext.is_active" title="Permalink to this definition">¶</a></dt>
<dd><p>Describes whether the operation is active or has terminated.</p>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.base.interfaces.OperationContext.time_remaining">
<code class="descname">time_remaining</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/base/interfaces.html#OperationContext.time_remaining"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.interfaces.OperationContext.time_remaining" title="Permalink to this definition">¶</a></dt>
<dd><p>Describes the length of allowed time remaining for the operation.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">A nonnegative float indicating the length of allowed time in seconds
remaining for the operation to complete before it is considered to have
timed out.</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="grpc.framework.base.interfaces.Outcome">
<em class="property">class </em><code class="descclassname">grpc.framework.base.interfaces.</code><code class="descname">Outcome</code><a class="reference internal" href="_modules/grpc/framework/base/interfaces.html#Outcome"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.interfaces.Outcome" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">enum.Enum</span></code></p>
<p>Operation outcomes.</p>
<dl class="attribute">
<dt id="grpc.framework.base.interfaces.Outcome.CANCELLED">
<code class="descname">CANCELLED</code><em class="property"> = &lt;Outcome.CANCELLED: 'cancelled'&gt;</em><a class="headerlink" href="#grpc.framework.base.interfaces.Outcome.CANCELLED" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="grpc.framework.base.interfaces.Outcome.COMPLETED">
<code class="descname">COMPLETED</code><em class="property"> = &lt;Outcome.COMPLETED: 'completed'&gt;</em><a class="headerlink" href="#grpc.framework.base.interfaces.Outcome.COMPLETED" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="grpc.framework.base.interfaces.Outcome.EXPIRED">
<code class="descname">EXPIRED</code><em class="property"> = &lt;Outcome.EXPIRED: 'expired'&gt;</em><a class="headerlink" href="#grpc.framework.base.interfaces.Outcome.EXPIRED" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="grpc.framework.base.interfaces.Outcome.RECEPTION_FAILURE">
<code class="descname">RECEPTION_FAILURE</code><em class="property"> = &lt;Outcome.RECEPTION_FAILURE: 'reception failure'&gt;</em><a class="headerlink" href="#grpc.framework.base.interfaces.Outcome.RECEPTION_FAILURE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="grpc.framework.base.interfaces.Outcome.SERVICED_FAILURE">
<code class="descname">SERVICED_FAILURE</code><em class="property"> = &lt;Outcome.SERVICED_FAILURE: 'serviced failure'&gt;</em><a class="headerlink" href="#grpc.framework.base.interfaces.Outcome.SERVICED_FAILURE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="grpc.framework.base.interfaces.Outcome.SERVICER_FAILURE">
<code class="descname">SERVICER_FAILURE</code><em class="property"> = &lt;Outcome.SERVICER_FAILURE: 'servicer failure'&gt;</em><a class="headerlink" href="#grpc.framework.base.interfaces.Outcome.SERVICER_FAILURE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="grpc.framework.base.interfaces.Outcome.TRANSMISSION_FAILURE">
<code class="descname">TRANSMISSION_FAILURE</code><em class="property"> = &lt;Outcome.TRANSMISSION_FAILURE: 'transmission failure'&gt;</em><a class="headerlink" href="#grpc.framework.base.interfaces.Outcome.TRANSMISSION_FAILURE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="class">
<dt id="grpc.framework.base.interfaces.RearLink">
<em class="property">class </em><code class="descclassname">grpc.framework.base.interfaces.</code><code class="descname">RearLink</code><a class="reference internal" href="_modules/grpc/framework/base/interfaces.html#RearLink"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.interfaces.RearLink" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Accepts front-to-back tickets and emits back-to-front tickets.</p>
<dl class="method">
<dt id="grpc.framework.base.interfaces.RearLink.accept_front_to_back_ticket">
<code class="descname">accept_front_to_back_ticket</code><span class="sig-paren">(</span><em>ticket</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/base/interfaces.html#RearLink.accept_front_to_back_ticket"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.interfaces.RearLink.accept_front_to_back_ticket" title="Permalink to this definition">¶</a></dt>
<dd><p>Accepts a FrontToBackTicket.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ticket</strong> &#8211; Any FrontToBackTicket.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.base.interfaces.RearLink.join_fore_link">
<code class="descname">join_fore_link</code><span class="sig-paren">(</span><em>fore_link</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/base/interfaces.html#RearLink.join_fore_link"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.interfaces.RearLink.join_fore_link" title="Permalink to this definition">¶</a></dt>
<dd><p>Mates this object with a peer with which it will exchange tickets.</p>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="grpc.framework.base.interfaces.ServicedIngestor">
<em class="property">class </em><code class="descclassname">grpc.framework.base.interfaces.</code><code class="descname">ServicedIngestor</code><a class="reference internal" href="_modules/grpc/framework/base/interfaces.html#ServicedIngestor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.interfaces.ServicedIngestor" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Responsible for accepting the result of an operation.</p>
<dl class="method">
<dt id="grpc.framework.base.interfaces.ServicedIngestor.consumer">
<code class="descname">consumer</code><span class="sig-paren">(</span><em>operation_context</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/base/interfaces.html#ServicedIngestor.consumer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.interfaces.ServicedIngestor.consumer" title="Permalink to this definition">¶</a></dt>
<dd><p>Affords a consumer to which operation results will be passed.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>operation_context</strong> &#8211; An OperationContext object for the current operation.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="docutils">
<dt>A stream.Consumer to which the results of the current operation will be</dt>
<dd>passed.</dd>
</dl>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><code class="xref py py-exc docutils literal"><span class="pre">abandonment.Abandoned</span></code> &#8211; If the operation has been aborted and there no
longer is any reason to service the operation.</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="grpc.framework.base.interfaces.ServicedSubscription">
<em class="property">class </em><code class="descclassname">grpc.framework.base.interfaces.</code><code class="descname">ServicedSubscription</code><a class="reference internal" href="_modules/grpc/framework/base/interfaces.html#ServicedSubscription"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.interfaces.ServicedSubscription" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>A sum type representing a serviced&#8217;s interest in an operation.</p>
<dl class="attribute">
<dt id="grpc.framework.base.interfaces.ServicedSubscription.kind">
<code class="descname">kind</code><a class="headerlink" href="#grpc.framework.base.interfaces.ServicedSubscription.kind" title="Permalink to this definition">¶</a></dt>
<dd><p>A Kind value.</p>
</dd></dl>

<dl class="attribute">
<dt id="grpc.framework.base.interfaces.ServicedSubscription.ingestor">
<code class="descname">ingestor</code><a class="headerlink" href="#grpc.framework.base.interfaces.ServicedSubscription.ingestor" title="Permalink to this definition">¶</a></dt>
<dd><p>A ServicedIngestor. Must be present if kind is Kind.FULL. Must
be None if kind is Kind.TERMINATION_ONLY or Kind.NONE.</p>
</dd></dl>

<dl class="class">
<dt id="grpc.framework.base.interfaces.ServicedSubscription.Kind">
<em class="property">class </em><code class="descname">Kind</code><a class="reference internal" href="_modules/grpc/framework/base/interfaces.html#ServicedSubscription.Kind"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.interfaces.ServicedSubscription.Kind" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">enum.Enum</span></code></p>
<p>Kinds of subscription.</p>
<dl class="attribute">
<dt id="grpc.framework.base.interfaces.ServicedSubscription.Kind.FULL">
<code class="descname">FULL</code><em class="property"> = &lt;Kind.FULL: 'full'&gt;</em><a class="headerlink" href="#grpc.framework.base.interfaces.ServicedSubscription.Kind.FULL" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="grpc.framework.base.interfaces.ServicedSubscription.Kind.NONE">
<code class="descname">NONE</code><em class="property"> = &lt;Kind.NONE: 'none'&gt;</em><a class="headerlink" href="#grpc.framework.base.interfaces.ServicedSubscription.Kind.NONE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="grpc.framework.base.interfaces.ServicedSubscription.Kind.TERMINATION_ONLY">
<code class="descname">TERMINATION_ONLY</code><em class="property"> = &lt;Kind.TERMINATION_ONLY: 'termination only'&gt;</em><a class="headerlink" href="#grpc.framework.base.interfaces.ServicedSubscription.Kind.TERMINATION_ONLY" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

</dd></dl>

<dl class="class">
<dt id="grpc.framework.base.interfaces.Servicer">
<em class="property">class </em><code class="descclassname">grpc.framework.base.interfaces.</code><code class="descname">Servicer</code><a class="reference internal" href="_modules/grpc/framework/base/interfaces.html#Servicer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.interfaces.Servicer" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<p>Interface for service implementations.</p>
<dl class="method">
<dt id="grpc.framework.base.interfaces.Servicer.service">
<code class="descname">service</code><span class="sig-paren">(</span><em>name</em>, <em>context</em>, <em>output_consumer</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/base/interfaces.html#Servicer.service"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.interfaces.Servicer.service" title="Permalink to this definition">¶</a></dt>
<dd><p>Services an operation.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>name</strong> &#8211; The name of the operation.</li>
<li><strong>context</strong> &#8211; A ServicerContext object affording contextual information and
actions.</li>
<li><strong>output_consumer</strong> &#8211; A stream.Consumer that will accept output values of
the operation.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">A stream.Consumer that will accept input values for the operation.</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first last simple">
<li><code class="xref py py-exc docutils literal"><span class="pre">exceptions.NoSuchMethodError</span></code> &#8211; If this Servicer affords no method with the
given name.</li>
<li><code class="xref py py-exc docutils literal"><span class="pre">abandonment.Abandoned</span></code> &#8211; If the operation has been aborted and there no
longer is any reason to service the operation.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

</div>
<div class="section" id="module-grpc.framework.base.null">
<span id="grpc-framework-base-null-module"></span><h2>grpc.framework.base.null module<a class="headerlink" href="#module-grpc.framework.base.null" title="Permalink to this headline">¶</a></h2>
<p>Null links that ignore tickets passed to them.</p>
</div>
<div class="section" id="module-grpc.framework.base.util">
<span id="grpc-framework-base-util-module"></span><h2>grpc.framework.base.util module<a class="headerlink" href="#module-grpc.framework.base.util" title="Permalink to this headline">¶</a></h2>
<p>Utilities helpful for working with the base layer of RPC Framework.</p>
<dl class="function">
<dt id="grpc.framework.base.util.full_serviced_subscription">
<code class="descclassname">grpc.framework.base.util.</code><code class="descname">full_serviced_subscription</code><span class="sig-paren">(</span><em>ingestor</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/base/util.html#full_serviced_subscription"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.util.full_serviced_subscription" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a &#8220;full&#8221; interfaces.ServicedSubscription object.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ingestor</strong> &#8211; An interfaces.ServicedIngestor.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><dl class="docutils">
<dt>An interfaces.ServicedSubscription object indicating a full</dt>
<dd>subscription.</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="grpc.framework.base.util.none_serviced_subscription">
<code class="descclassname">grpc.framework.base.util.</code><code class="descname">none_serviced_subscription</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/base/util.html#none_serviced_subscription"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.util.none_serviced_subscription" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a &#8220;none&#8221; interfaces.ServicedSubscription object.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><dl class="docutils">
<dt>An interfaces.ServicedSubscription indicating no subscription to an</dt>
<dd>operation&#8217;s results (such as would be the case for a fire-and-forget
operation invocation).</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="grpc.framework.base.util.termination_only_serviced_subscription">
<code class="descclassname">grpc.framework.base.util.</code><code class="descname">termination_only_serviced_subscription</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/base/util.html#termination_only_serviced_subscription"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.util.termination_only_serviced_subscription" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a &#8220;termination only&#8221; interfaces.ServicedSubscription object.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><dl class="docutils">
<dt>An interfaces.ServicedSubscription indicating that the front-side customer</dt>
<dd>is interested only in the overall termination outcome of the operation
(such as completion or expiration) and would ignore the actual results of
the operation.</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="grpc.framework.base.util.wait_for_idle">
<code class="descclassname">grpc.framework.base.util.</code><code class="descname">wait_for_idle</code><span class="sig-paren">(</span><em>end</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/base/util.html#wait_for_idle"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.base.util.wait_for_idle" title="Permalink to this definition">¶</a></dt>
<dd><p>Waits for an interfaces.End to complete all operations.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>end</strong> &#8211; Any interfaces.End.</td>
</tr>
</tbody>
</table>
</dd></dl>

</div>
<div class="section" id="module-grpc.framework.base">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-grpc.framework.base" title="Permalink to this headline">¶</a></h2>
</div>
</div>


           </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="grpc.framework.common.html" class="btn btn-neutral float-right" title="grpc.framework.common package" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="grpc.framework.alpha.html" class="btn btn-neutral" title="grpc.framework.alpha package" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2016, Author.

    </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:'0.13.1rc1',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true
        };
    </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>