carto
/
grpc


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815
							

<!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.face package &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.framework.interfaces package" href="grpc.framework.interfaces.html"/>
        <link rel="prev" title="grpc.framework.interfaces.base package" href="grpc.framework.interfaces.base.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 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 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>
<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="grpc.html">grpc package</a> &raquo;</li>
        
          <li><a href="grpc.framework.html">grpc.framework package</a> &raquo;</li>
        
          <li><a href="grpc.framework.interfaces.html">grpc.framework.interfaces package</a> &raquo;</li>
        
      <li>grpc.framework.interfaces.face package</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            <a href="_sources/grpc.framework.interfaces.face.rst.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-interfaces-face-package">
<h1>grpc.framework.interfaces.face package<a class="headerlink" href="#grpc-framework-interfaces-face-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.interfaces.face.face">
<span id="grpc-framework-interfaces-face-face-module"></span><h2>grpc.framework.interfaces.face.face module<a class="headerlink" href="#module-grpc.framework.interfaces.face.face" title="Permalink to this headline">¶</a></h2>
<p>Interfaces defining the Face layer of RPC Framework.</p>
<dl class="class">
<dt id="grpc.framework.interfaces.face.face.Abortion">
<em class="property">class </em><code class="descclassname">grpc.framework.interfaces.face.face.</code><code class="descname">Abortion</code><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#Abortion"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.Abortion" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#grpc.framework.interfaces.face.face.Abortion" title="grpc.framework.interfaces.face.face.Abortion"><code class="xref py py-class docutils literal"><span class="pre">grpc.framework.interfaces.face.face.Abortion</span></code></a></p>
<p>A value describing RPC abortion.</p>
<dl class="attribute">
<dt id="grpc.framework.interfaces.face.face.Abortion.kind">
<code class="descname">kind</code><a class="headerlink" href="#grpc.framework.interfaces.face.face.Abortion.kind" title="Permalink to this definition">¶</a></dt>
<dd><p>A Kind value identifying how the RPC failed.</p>
</dd></dl>

<dl class="attribute">
<dt id="grpc.framework.interfaces.face.face.Abortion.initial_metadata">
<code class="descname">initial_metadata</code><a class="headerlink" href="#grpc.framework.interfaces.face.face.Abortion.initial_metadata" title="Permalink to this definition">¶</a></dt>
<dd><p>The initial metadata from the other side of the RPC or
None if no initial metadata value was received.</p>
</dd></dl>

<dl class="attribute">
<dt id="grpc.framework.interfaces.face.face.Abortion.terminal_metadata">
<code class="descname">terminal_metadata</code><a class="headerlink" href="#grpc.framework.interfaces.face.face.Abortion.terminal_metadata" title="Permalink to this definition">¶</a></dt>
<dd><p>The terminal metadata from the other side of the RPC or
None if no terminal metadata value was received.</p>
</dd></dl>

<dl class="attribute">
<dt id="grpc.framework.interfaces.face.face.Abortion.code">
<code class="descname">code</code><a class="headerlink" href="#grpc.framework.interfaces.face.face.Abortion.code" title="Permalink to this definition">¶</a></dt>
<dd><p>The code value from the other side of the RPC or None if no code value
was received.</p>
</dd></dl>

<dl class="attribute">
<dt id="grpc.framework.interfaces.face.face.Abortion.details">
<code class="descname">details</code><a class="headerlink" href="#grpc.framework.interfaces.face.face.Abortion.details" title="Permalink to this definition">¶</a></dt>
<dd><p>The details value from the other side of the RPC or None if no
details value was received.</p>
</dd></dl>

<dl class="class">
<dt id="grpc.framework.interfaces.face.face.Abortion.Kind">
<em class="property">class </em><code class="descname">Kind</code><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#Abortion.Kind"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.Abortion.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>Types of RPC abortion.</p>
<dl class="attribute">
<dt id="grpc.framework.interfaces.face.face.Abortion.Kind.CANCELLED">
<code class="descname">CANCELLED</code><em class="property"> = 'cancelled'</em><a class="headerlink" href="#grpc.framework.interfaces.face.face.Abortion.Kind.CANCELLED" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="grpc.framework.interfaces.face.face.Abortion.Kind.EXPIRED">
<code class="descname">EXPIRED</code><em class="property"> = 'expired'</em><a class="headerlink" href="#grpc.framework.interfaces.face.face.Abortion.Kind.EXPIRED" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="grpc.framework.interfaces.face.face.Abortion.Kind.LOCAL_FAILURE">
<code class="descname">LOCAL_FAILURE</code><em class="property"> = 'local failure'</em><a class="headerlink" href="#grpc.framework.interfaces.face.face.Abortion.Kind.LOCAL_FAILURE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="grpc.framework.interfaces.face.face.Abortion.Kind.LOCAL_SHUTDOWN">
<code class="descname">LOCAL_SHUTDOWN</code><em class="property"> = 'local shutdown'</em><a class="headerlink" href="#grpc.framework.interfaces.face.face.Abortion.Kind.LOCAL_SHUTDOWN" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="grpc.framework.interfaces.face.face.Abortion.Kind.NETWORK_FAILURE">
<code class="descname">NETWORK_FAILURE</code><em class="property"> = 'network failure'</em><a class="headerlink" href="#grpc.framework.interfaces.face.face.Abortion.Kind.NETWORK_FAILURE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="grpc.framework.interfaces.face.face.Abortion.Kind.REMOTE_FAILURE">
<code class="descname">REMOTE_FAILURE</code><em class="property"> = 'remote failure'</em><a class="headerlink" href="#grpc.framework.interfaces.face.face.Abortion.Kind.REMOTE_FAILURE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="grpc.framework.interfaces.face.face.Abortion.Kind.REMOTE_SHUTDOWN">
<code class="descname">REMOTE_SHUTDOWN</code><em class="property"> = 'remote shutdown'</em><a class="headerlink" href="#grpc.framework.interfaces.face.face.Abortion.Kind.REMOTE_SHUTDOWN" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

</dd></dl>

<dl class="exception">
<dt id="grpc.framework.interfaces.face.face.AbortionError">
<em class="property">exception </em><code class="descclassname">grpc.framework.interfaces.face.face.</code><code class="descname">AbortionError</code><span class="sig-paren">(</span><em>initial_metadata</em>, <em>terminal_metadata</em>, <em>code</em>, <em>details</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#AbortionError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.AbortionError" 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>Common super type for exceptions indicating RPC abortion.</p>
<dl class="docutils">
<dt>initial_metadata: The initial metadata from the other side of the RPC or</dt>
<dd>None if no initial metadata value was received.</dd>
<dt>terminal_metadata: The terminal metadata from the other side of the RPC or</dt>
<dd>None if no terminal metadata value was received.</dd>
<dt>code: The code value from the other side of the RPC or None if no code value</dt>
<dd>was received.</dd>
<dt>details: The details value from the other side of the RPC or None if no</dt>
<dd>details value was received.</dd>
</dl>
</dd></dl>

<dl class="class">
<dt id="grpc.framework.interfaces.face.face.Call">
<em class="property">class </em><code class="descclassname">grpc.framework.interfaces.face.face.</code><code class="descname">Call</code><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#Call"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.Call" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#grpc.framework.interfaces.face.face.RpcContext" title="grpc.framework.interfaces.face.face.RpcContext"><code class="xref py py-class docutils literal"><span class="pre">grpc.framework.interfaces.face.face.RpcContext</span></code></a></p>
<p>Invocation-side utility object for an RPC.</p>
<dl class="method">
<dt id="grpc.framework.interfaces.face.face.Call.code">
<code class="descname">code</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#Call.code"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.Call.code" title="Permalink to this definition">¶</a></dt>
<dd><p>Accesses the code emitted by the service-side of the RPC.</p>
<p>This method blocks until the value is available or is known not to have been
emitted from the service-side of the RPC.</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>The code object emitted by the service-side of the RPC, or None if there</dt>
<dd>was no such value.</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.interfaces.face.face.Call.details">
<code class="descname">details</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#Call.details"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.Call.details" title="Permalink to this definition">¶</a></dt>
<dd><p>Accesses the details value emitted by the service-side of the RPC.</p>
<p>This method blocks until the value is available or is known not to have been
emitted from the service-side of the RPC.</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>The details value emitted by the service-side of the RPC, or None if there</dt>
<dd>was no such value.</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.interfaces.face.face.Call.initial_metadata">
<code class="descname">initial_metadata</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#Call.initial_metadata"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.Call.initial_metadata" title="Permalink to this definition">¶</a></dt>
<dd><p>Accesses the initial metadata from the service-side of the RPC.</p>
<p>This method blocks until the value is available or is known not to have been
emitted from the service-side of the RPC.</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>The initial metadata object emitted by the service-side of the RPC, or</dt>
<dd>None if there was no such value.</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.interfaces.face.face.Call.terminal_metadata">
<code class="descname">terminal_metadata</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#Call.terminal_metadata"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.Call.terminal_metadata" title="Permalink to this definition">¶</a></dt>
<dd><p>Accesses the terminal metadata from the service-side of the RPC.</p>
<p>This method blocks until the value is available or is known not to have been
emitted from the service-side of the RPC.</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>The terminal metadata object emitted by the service-side of the RPC, or</dt>
<dd>None if there was no such value.</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

<dl class="exception">
<dt id="grpc.framework.interfaces.face.face.CancellationError">
<em class="property">exception </em><code class="descclassname">grpc.framework.interfaces.face.face.</code><code class="descname">CancellationError</code><span class="sig-paren">(</span><em>initial_metadata</em>, <em>terminal_metadata</em>, <em>code</em>, <em>details</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#CancellationError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.CancellationError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#grpc.framework.interfaces.face.face.AbortionError" title="grpc.framework.interfaces.face.face.AbortionError"><code class="xref py py-class docutils literal"><span class="pre">grpc.framework.interfaces.face.face.AbortionError</span></code></a></p>
<p>Indicates that an RPC has been cancelled.</p>
</dd></dl>

<dl class="class">
<dt id="grpc.framework.interfaces.face.face.DynamicStub">
<em class="property">class </em><code class="descclassname">grpc.framework.interfaces.face.face.</code><code class="descname">DynamicStub</code><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#DynamicStub"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.DynamicStub" 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>Affords RPC invocation via attributes corresponding to afforded methods.</p>
<p>Instances of this type may be scoped to a single group so that attribute
access is unambiguous.</p>
<p>Instances of this type respond to attribute access as follows: if the
requested attribute is the name of a unary-unary method, the value of the
attribute will be a UnaryUnaryMultiCallable with which to invoke an RPC; if
the requested attribute is the name of a unary-stream method, the value of the
attribute will be a UnaryStreamMultiCallable with which to invoke an RPC; if
the requested attribute is the name of a stream-unary method, the value of the
attribute will be a StreamUnaryMultiCallable with which to invoke an RPC; and
if the requested attribute is the name of a stream-stream method, the value of
the attribute will be a StreamStreamMultiCallable with which to invoke an RPC.</p>
</dd></dl>

<dl class="exception">
<dt id="grpc.framework.interfaces.face.face.ExpirationError">
<em class="property">exception </em><code class="descclassname">grpc.framework.interfaces.face.face.</code><code class="descname">ExpirationError</code><span class="sig-paren">(</span><em>initial_metadata</em>, <em>terminal_metadata</em>, <em>code</em>, <em>details</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#ExpirationError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.ExpirationError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#grpc.framework.interfaces.face.face.AbortionError" title="grpc.framework.interfaces.face.face.AbortionError"><code class="xref py py-class docutils literal"><span class="pre">grpc.framework.interfaces.face.face.AbortionError</span></code></a></p>
<p>Indicates that an RPC has expired (&#8220;timed out&#8221;).</p>
</dd></dl>

<dl class="class">
<dt id="grpc.framework.interfaces.face.face.GenericStub">
<em class="property">class </em><code class="descclassname">grpc.framework.interfaces.face.face.</code><code class="descname">GenericStub</code><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#GenericStub"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.GenericStub" 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>Affords RPC invocation via generic methods.</p>
<dl class="method">
<dt id="grpc.framework.interfaces.face.face.GenericStub.blocking_stream_unary">
<code class="descname">blocking_stream_unary</code><span class="sig-paren">(</span><em>group</em>, <em>method</em>, <em>request_iterator</em>, <em>timeout</em>, <em>metadata=None</em>, <em>with_call=False</em>, <em>protocol_options=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#GenericStub.blocking_stream_unary"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.GenericStub.blocking_stream_unary" title="Permalink to this definition">¶</a></dt>
<dd><p>Invokes a stream-request-unary-response method.</p>
<p>This method blocks until either returning the response value of the RPC
(in the event of RPC completion) or raising an exception (in the event of
RPC abortion).</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>group</strong> &#8211; The group identifier of the RPC.</li>
<li><strong>method</strong> &#8211; The method identifier of the RPC.</li>
<li><strong>request_iterator</strong> &#8211; An iterator that yields request values for the RPC.</li>
<li><strong>timeout</strong> &#8211; A duration of time in seconds to allow for the RPC.</li>
<li><strong>metadata</strong> &#8211; A metadata value to be passed to the service-side of the RPC.</li>
<li><strong>with_call</strong> &#8211; Whether or not to include return a Call for the RPC in addition
to the response.</li>
<li><strong>protocol_options</strong> &#8211; A value specified by the provider of a Face interface
implementation affording custom state and behavior.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><dl class="docutils">
<dt>The response value for the RPC, and a Call for the RPC if with_call was</dt>
<dd><p class="first last">set to True at invocation.</p>
</dd>
</dl>
</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#grpc.framework.interfaces.face.face.AbortionError" title="grpc.framework.interfaces.face.face.AbortionError"><code class="xref py py-exc docutils literal"><span class="pre">AbortionError</span></code></a> &#8211; Indicating that the RPC was aborted.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.interfaces.face.face.GenericStub.blocking_unary_unary">
<code class="descname">blocking_unary_unary</code><span class="sig-paren">(</span><em>group</em>, <em>method</em>, <em>request</em>, <em>timeout</em>, <em>metadata=None</em>, <em>with_call=False</em>, <em>protocol_options=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#GenericStub.blocking_unary_unary"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.GenericStub.blocking_unary_unary" title="Permalink to this definition">¶</a></dt>
<dd><p>Invokes a unary-request-unary-response method.</p>
<p>This method blocks until either returning the response value of the RPC
(in the event of RPC completion) or raising an exception (in the event of
RPC abortion).</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>group</strong> &#8211; The group identifier of the RPC.</li>
<li><strong>method</strong> &#8211; The method identifier of the RPC.</li>
<li><strong>request</strong> &#8211; The request value for the RPC.</li>
<li><strong>timeout</strong> &#8211; A duration of time in seconds to allow for the RPC.</li>
<li><strong>metadata</strong> &#8211; A metadata value to be passed to the service-side of the RPC.</li>
<li><strong>with_call</strong> &#8211; Whether or not to include return a Call for the RPC in addition
to the response.</li>
<li><strong>protocol_options</strong> &#8211; A value specified by the provider of a Face interface
implementation affording custom state and behavior.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><dl class="docutils">
<dt>The response value for the RPC, and a Call for the RPC if with_call was</dt>
<dd><p class="first last">set to True at invocation.</p>
</dd>
</dl>
</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#grpc.framework.interfaces.face.face.AbortionError" title="grpc.framework.interfaces.face.face.AbortionError"><code class="xref py py-exc docutils literal"><span class="pre">AbortionError</span></code></a> &#8211; Indicating that the RPC was aborted.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.interfaces.face.face.GenericStub.event_stream_stream">
<code class="descname">event_stream_stream</code><span class="sig-paren">(</span><em>group</em>, <em>method</em>, <em>receiver</em>, <em>abortion_callback</em>, <em>timeout</em>, <em>metadata=None</em>, <em>protocol_options=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#GenericStub.event_stream_stream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.GenericStub.event_stream_stream" title="Permalink to this definition">¶</a></dt>
<dd><p>Event-driven invocation of a unary-request-stream-response method.</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>group</strong> &#8211; The group identifier of the RPC.</li>
<li><strong>method</strong> &#8211; The method identifier of the RPC.</li>
<li><strong>receiver</strong> &#8211; A ResponseReceiver to be passed the response data of the RPC.</li>
<li><strong>abortion_callback</strong> &#8211; A callback to be called and passed an Abortion value
in the event of RPC abortion.</li>
<li><strong>timeout</strong> &#8211; A duration of time in seconds to allow for the RPC.</li>
<li><strong>metadata</strong> &#8211; A metadata value to be passed to the service-side of the RPC.</li>
<li><strong>protocol_options</strong> &#8211; A value specified by the provider of a Face interface
implementation affording custom state and behavior.</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>A pair of a Call object for the RPC and a stream.Consumer to which the</dt>
<dd><p class="first last">request values of the RPC should be passed.</p>
</dd>
</dl>
</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.interfaces.face.face.GenericStub.event_stream_unary">
<code class="descname">event_stream_unary</code><span class="sig-paren">(</span><em>group</em>, <em>method</em>, <em>receiver</em>, <em>abortion_callback</em>, <em>timeout</em>, <em>metadata=None</em>, <em>protocol_options=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#GenericStub.event_stream_unary"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.GenericStub.event_stream_unary" title="Permalink to this definition">¶</a></dt>
<dd><p>Event-driven invocation of a unary-request-unary-response method.</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>group</strong> &#8211; The group identifier of the RPC.</li>
<li><strong>method</strong> &#8211; The method identifier of the RPC.</li>
<li><strong>receiver</strong> &#8211; A ResponseReceiver to be passed the response data of the RPC.</li>
<li><strong>abortion_callback</strong> &#8211; A callback to be called and passed an Abortion value
in the event of RPC abortion.</li>
<li><strong>timeout</strong> &#8211; A duration of time in seconds to allow for the RPC.</li>
<li><strong>metadata</strong> &#8211; A metadata value to be passed to the service-side of the RPC.</li>
<li><strong>protocol_options</strong> &#8211; A value specified by the provider of a Face interface
implementation affording custom state and behavior.</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>A pair of a Call object for the RPC and a stream.Consumer to which the</dt>
<dd><p class="first last">request values of the RPC should be passed.</p>
</dd>
</dl>
</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.interfaces.face.face.GenericStub.event_unary_stream">
<code class="descname">event_unary_stream</code><span class="sig-paren">(</span><em>group</em>, <em>method</em>, <em>request</em>, <em>receiver</em>, <em>abortion_callback</em>, <em>timeout</em>, <em>metadata=None</em>, <em>protocol_options=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#GenericStub.event_unary_stream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.GenericStub.event_unary_stream" title="Permalink to this definition">¶</a></dt>
<dd><p>Event-driven invocation of a unary-request-stream-response method.</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>group</strong> &#8211; The group identifier of the RPC.</li>
<li><strong>method</strong> &#8211; The method identifier of the RPC.</li>
<li><strong>request</strong> &#8211; The request value for the RPC.</li>
<li><strong>receiver</strong> &#8211; A ResponseReceiver to be passed the response data of the RPC.</li>
<li><strong>abortion_callback</strong> &#8211; A callback to be called and passed an Abortion value
in the event of RPC abortion.</li>
<li><strong>timeout</strong> &#8211; A duration of time in seconds to allow for the RPC.</li>
<li><strong>metadata</strong> &#8211; A metadata value to be passed to the service-side of the RPC.</li>
<li><strong>protocol_options</strong> &#8211; A value specified by the provider of a Face interface
implementation affording custom state and behavior.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A Call for the RPC.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.interfaces.face.face.GenericStub.event_unary_unary">
<code class="descname">event_unary_unary</code><span class="sig-paren">(</span><em>group</em>, <em>method</em>, <em>request</em>, <em>receiver</em>, <em>abortion_callback</em>, <em>timeout</em>, <em>metadata=None</em>, <em>protocol_options=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#GenericStub.event_unary_unary"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.GenericStub.event_unary_unary" title="Permalink to this definition">¶</a></dt>
<dd><p>Event-driven invocation of a unary-request-unary-response method.</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>group</strong> &#8211; The group identifier of the RPC.</li>
<li><strong>method</strong> &#8211; The method identifier of the RPC.</li>
<li><strong>request</strong> &#8211; The request value for the RPC.</li>
<li><strong>receiver</strong> &#8211; A ResponseReceiver to be passed the response data of the RPC.</li>
<li><strong>abortion_callback</strong> &#8211; A callback to be called and passed an Abortion value
in the event of RPC abortion.</li>
<li><strong>timeout</strong> &#8211; A duration of time in seconds to allow for the RPC.</li>
<li><strong>metadata</strong> &#8211; A metadata value to be passed to the service-side of the RPC.</li>
<li><strong>protocol_options</strong> &#8211; A value specified by the provider of a Face interface
implementation affording custom state and behavior.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A Call for the RPC.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.interfaces.face.face.GenericStub.future_stream_unary">
<code class="descname">future_stream_unary</code><span class="sig-paren">(</span><em>group</em>, <em>method</em>, <em>request_iterator</em>, <em>timeout</em>, <em>metadata=None</em>, <em>protocol_options=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#GenericStub.future_stream_unary"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.GenericStub.future_stream_unary" title="Permalink to this definition">¶</a></dt>
<dd><p>Invokes a stream-request-unary-response method.</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>group</strong> &#8211; The group identifier of the RPC.</li>
<li><strong>method</strong> &#8211; The method identifier of the RPC.</li>
<li><strong>request_iterator</strong> &#8211; An iterator that yields request values for the RPC.</li>
<li><strong>timeout</strong> &#8211; A duration of time in seconds to allow for the RPC.</li>
<li><strong>metadata</strong> &#8211; A metadata value to be passed to the service-side of the RPC.</li>
<li><strong>protocol_options</strong> &#8211; A value specified by the provider of a Face interface
implementation affording custom state and behavior.</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 object that is both a Call for the RPC and a future.Future. In the</dt>
<dd><p class="first last">event of RPC completion, the return Future&#8217;s result value will be the
response value of the RPC. In the event of RPC abortion, the returned
Future&#8217;s exception value will be an AbortionError.</p>
</dd>
</dl>
</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.interfaces.face.face.GenericStub.future_unary_unary">
<code class="descname">future_unary_unary</code><span class="sig-paren">(</span><em>group</em>, <em>method</em>, <em>request</em>, <em>timeout</em>, <em>metadata=None</em>, <em>protocol_options=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#GenericStub.future_unary_unary"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.GenericStub.future_unary_unary" title="Permalink to this definition">¶</a></dt>
<dd><p>Invokes a unary-request-unary-response method.</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>group</strong> &#8211; The group identifier of the RPC.</li>
<li><strong>method</strong> &#8211; The method identifier of the RPC.</li>
<li><strong>request</strong> &#8211; The request value for the RPC.</li>
<li><strong>timeout</strong> &#8211; A duration of time in seconds to allow for the RPC.</li>
<li><strong>metadata</strong> &#8211; A metadata value to be passed to the service-side of the RPC.</li>
<li><strong>protocol_options</strong> &#8211; A value specified by the provider of a Face interface
implementation affording custom state and behavior.</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 object that is both a Call for the RPC and a future.Future. In the</dt>
<dd><p class="first last">event of RPC completion, the return Future&#8217;s result value will be the
response value of the RPC. In the event of RPC abortion, the returned
Future&#8217;s exception value will be an AbortionError.</p>
</dd>
</dl>
</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.interfaces.face.face.GenericStub.inline_stream_stream">
<code class="descname">inline_stream_stream</code><span class="sig-paren">(</span><em>group</em>, <em>method</em>, <em>request_iterator</em>, <em>timeout</em>, <em>metadata=None</em>, <em>protocol_options=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#GenericStub.inline_stream_stream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.GenericStub.inline_stream_stream" title="Permalink to this definition">¶</a></dt>
<dd><p>Invokes a stream-request-stream-response method.</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>group</strong> &#8211; The group identifier of the RPC.</li>
<li><strong>method</strong> &#8211; The method identifier of the RPC.</li>
<li><strong>request_iterator</strong> &#8211; An iterator that yields request values for the RPC.</li>
<li><strong>timeout</strong> &#8211; A duration of time in seconds to allow for the RPC.</li>
<li><strong>metadata</strong> &#8211; A metadata value to be passed to the service-side of the RPC.</li>
<li><strong>protocol_options</strong> &#8211; A value specified by the provider of a Face interface
implementation affording custom state and behavior.</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 object that is both a Call for the RPC and an iterator of response</dt>
<dd><p class="first last">values. Drawing response values from the returned iterator may raise
AbortionError indicating abortion of the RPC.</p>
</dd>
</dl>
</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.interfaces.face.face.GenericStub.inline_unary_stream">
<code class="descname">inline_unary_stream</code><span class="sig-paren">(</span><em>group</em>, <em>method</em>, <em>request</em>, <em>timeout</em>, <em>metadata=None</em>, <em>protocol_options=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#GenericStub.inline_unary_stream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.GenericStub.inline_unary_stream" title="Permalink to this definition">¶</a></dt>
<dd><p>Invokes a unary-request-stream-response method.</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>group</strong> &#8211; The group identifier of the RPC.</li>
<li><strong>method</strong> &#8211; The method identifier of the RPC.</li>
<li><strong>request</strong> &#8211; The request value for the RPC.</li>
<li><strong>timeout</strong> &#8211; A duration of time in seconds to allow for the RPC.</li>
<li><strong>metadata</strong> &#8211; A metadata value to be passed to the service-side of the RPC.</li>
<li><strong>protocol_options</strong> &#8211; A value specified by the provider of a Face interface
implementation affording custom state and behavior.</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 object that is both a Call for the RPC and an iterator of response</dt>
<dd><p class="first last">values. Drawing response values from the returned iterator may raise
AbortionError indicating abortion of the RPC.</p>
</dd>
</dl>
</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.interfaces.face.face.GenericStub.stream_stream">
<code class="descname">stream_stream</code><span class="sig-paren">(</span><em>group</em>, <em>method</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#GenericStub.stream_stream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.GenericStub.stream_stream" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a StreamStreamMultiCallable for a stream-stream method.</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>group</strong> &#8211; The group identifier of the RPC.</li>
<li><strong>method</strong> &#8211; The method identifier of the RPC.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A StreamStreamMultiCallable value for the named stream-stream method.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.interfaces.face.face.GenericStub.stream_unary">
<code class="descname">stream_unary</code><span class="sig-paren">(</span><em>group</em>, <em>method</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#GenericStub.stream_unary"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.GenericStub.stream_unary" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a StreamUnaryMultiCallable for a stream-unary method.</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>group</strong> &#8211; The group identifier of the RPC.</li>
<li><strong>method</strong> &#8211; The method identifier of the RPC.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A StreamUnaryMultiCallable value for the named stream-unary method.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.interfaces.face.face.GenericStub.unary_stream">
<code class="descname">unary_stream</code><span class="sig-paren">(</span><em>group</em>, <em>method</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#GenericStub.unary_stream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.GenericStub.unary_stream" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a UnaryStreamMultiCallable for a unary-stream method.</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>group</strong> &#8211; The group identifier of the RPC.</li>
<li><strong>method</strong> &#8211; The method identifier of the RPC.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A UnaryStreamMultiCallable value for the name unary-stream method.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.interfaces.face.face.GenericStub.unary_unary">
<code class="descname">unary_unary</code><span class="sig-paren">(</span><em>group</em>, <em>method</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#GenericStub.unary_unary"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.GenericStub.unary_unary" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a UnaryUnaryMultiCallable for a unary-unary method.</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>group</strong> &#8211; The group identifier of the RPC.</li>
<li><strong>method</strong> &#8211; The method identifier of the RPC.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A UnaryUnaryMultiCallable value for the named unary-unary method.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

<dl class="exception">
<dt id="grpc.framework.interfaces.face.face.LocalError">
<em class="property">exception </em><code class="descclassname">grpc.framework.interfaces.face.face.</code><code class="descname">LocalError</code><span class="sig-paren">(</span><em>initial_metadata</em>, <em>terminal_metadata</em>, <em>code</em>, <em>details</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#LocalError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.LocalError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#grpc.framework.interfaces.face.face.AbortionError" title="grpc.framework.interfaces.face.face.AbortionError"><code class="xref py py-class docutils literal"><span class="pre">grpc.framework.interfaces.face.face.AbortionError</span></code></a></p>
<p>Indicates that an RPC has terminated due to a local defect.</p>
</dd></dl>

<dl class="exception">
<dt id="grpc.framework.interfaces.face.face.LocalShutdownError">
<em class="property">exception </em><code class="descclassname">grpc.framework.interfaces.face.face.</code><code class="descname">LocalShutdownError</code><span class="sig-paren">(</span><em>initial_metadata</em>, <em>terminal_metadata</em>, <em>code</em>, <em>details</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#LocalShutdownError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.LocalShutdownError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#grpc.framework.interfaces.face.face.AbortionError" title="grpc.framework.interfaces.face.face.AbortionError"><code class="xref py py-class docutils literal"><span class="pre">grpc.framework.interfaces.face.face.AbortionError</span></code></a></p>
<p>Indicates that an RPC has terminated due to local shutdown of RPCs.</p>
</dd></dl>

<dl class="class">
<dt id="grpc.framework.interfaces.face.face.MethodImplementation">
<em class="property">class </em><code class="descclassname">grpc.framework.interfaces.face.face.</code><code class="descname">MethodImplementation</code><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#MethodImplementation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.MethodImplementation" 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 that describes a method implementation.</p>
<dl class="attribute">
<dt id="grpc.framework.interfaces.face.face.MethodImplementation.cardinality">
<code class="descname">cardinality</code><a class="headerlink" href="#grpc.framework.interfaces.face.face.MethodImplementation.cardinality" title="Permalink to this definition">¶</a></dt>
<dd><p>A cardinality.Cardinality value.</p>
</dd></dl>

<dl class="attribute">
<dt id="grpc.framework.interfaces.face.face.MethodImplementation.style">
<code class="descname">style</code><a class="headerlink" href="#grpc.framework.interfaces.face.face.MethodImplementation.style" title="Permalink to this definition">¶</a></dt>
<dd><p>A style.Service value.</p>
</dd></dl>

<dl class="attribute">
<dt id="grpc.framework.interfaces.face.face.MethodImplementation.unary_unary_inline">
<code class="descname">unary_unary_inline</code><a class="headerlink" href="#grpc.framework.interfaces.face.face.MethodImplementation.unary_unary_inline" title="Permalink to this definition">¶</a></dt>
<dd><p>The implementation of the method as a callable value
that takes a request value and a ServicerContext object and returns a
response value. Only non-None if cardinality is
cardinality.Cardinality.UNARY_UNARY and style is style.Service.INLINE.</p>
</dd></dl>

<dl class="attribute">
<dt id="grpc.framework.interfaces.face.face.MethodImplementation.unary_stream_inline">
<code class="descname">unary_stream_inline</code><a class="headerlink" href="#grpc.framework.interfaces.face.face.MethodImplementation.unary_stream_inline" title="Permalink to this definition">¶</a></dt>
<dd><p>The implementation of the method as a callable value
that takes a request value and a ServicerContext object and returns an
iterator of response values. Only non-None if cardinality is
cardinality.Cardinality.UNARY_STREAM and style is style.Service.INLINE.</p>
</dd></dl>

<dl class="attribute">
<dt id="grpc.framework.interfaces.face.face.MethodImplementation.stream_unary_inline">
<code class="descname">stream_unary_inline</code><a class="headerlink" href="#grpc.framework.interfaces.face.face.MethodImplementation.stream_unary_inline" title="Permalink to this definition">¶</a></dt>
<dd><p>The implementation of the method as a callable value
that takes an iterator of request values and a ServicerContext object and
returns a response value. Only non-None if cardinality is
cardinality.Cardinality.STREAM_UNARY and style is style.Service.INLINE.</p>
</dd></dl>

<dl class="attribute">
<dt id="grpc.framework.interfaces.face.face.MethodImplementation.stream_stream_inline">
<code class="descname">stream_stream_inline</code><a class="headerlink" href="#grpc.framework.interfaces.face.face.MethodImplementation.stream_stream_inline" title="Permalink to this definition">¶</a></dt>
<dd><p>The implementation of the method as a callable value
that takes an iterator of request values and a ServicerContext object and
returns an iterator of response values. Only non-None if cardinality is
cardinality.Cardinality.STREAM_STREAM and style is style.Service.INLINE.</p>
</dd></dl>

<dl class="attribute">
<dt id="grpc.framework.interfaces.face.face.MethodImplementation.unary_unary_event">
<code class="descname">unary_unary_event</code><a class="headerlink" href="#grpc.framework.interfaces.face.face.MethodImplementation.unary_unary_event" title="Permalink to this definition">¶</a></dt>
<dd><p>The implementation of the method as a callable value that
takes a request value, a response callback to which to pass the response
value of the RPC, and a ServicerContext. Only non-None if cardinality is
cardinality.Cardinality.UNARY_UNARY and style is style.Service.EVENT.</p>
</dd></dl>

<dl class="attribute">
<dt id="grpc.framework.interfaces.face.face.MethodImplementation.unary_stream_event">
<code class="descname">unary_stream_event</code><a class="headerlink" href="#grpc.framework.interfaces.face.face.MethodImplementation.unary_stream_event" title="Permalink to this definition">¶</a></dt>
<dd><p>The implementation of the method as a callable value
that takes a request value, a stream.Consumer to which to pass the
response values of the RPC, and a ServicerContext. Only non-None if
cardinality is cardinality.Cardinality.UNARY_STREAM and style is
style.Service.EVENT.</p>
</dd></dl>

<dl class="attribute">
<dt id="grpc.framework.interfaces.face.face.MethodImplementation.stream_unary_event">
<code class="descname">stream_unary_event</code><a class="headerlink" href="#grpc.framework.interfaces.face.face.MethodImplementation.stream_unary_event" title="Permalink to this definition">¶</a></dt>
<dd><p>The implementation of the method as a callable value
that takes a response callback to which to pass the response value of the
RPC and a ServicerContext and returns a stream.Consumer to which the
request values of the RPC should be passed. Only non-None if cardinality
is cardinality.Cardinality.STREAM_UNARY and style is style.Service.EVENT.</p>
</dd></dl>

<dl class="attribute">
<dt id="grpc.framework.interfaces.face.face.MethodImplementation.stream_stream_event">
<code class="descname">stream_stream_event</code><a class="headerlink" href="#grpc.framework.interfaces.face.face.MethodImplementation.stream_stream_event" title="Permalink to this definition">¶</a></dt>
<dd><p>The implementation of the method as a callable value
that takes a stream.Consumer to which to pass the response values of the
RPC and a ServicerContext and returns a stream.Consumer to which the
request values of the RPC should be passed. Only non-None if cardinality
is cardinality.Cardinality.STREAM_STREAM and style is
style.Service.EVENT.</p>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="grpc.framework.interfaces.face.face.MultiMethodImplementation">
<em class="property">class </em><code class="descclassname">grpc.framework.interfaces.face.face.</code><code class="descname">MultiMethodImplementation</code><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#MultiMethodImplementation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.MultiMethodImplementation" 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 general type able to service many methods.</p>
<dl class="method">
<dt id="grpc.framework.interfaces.face.face.MultiMethodImplementation.service">
<code class="descname">service</code><span class="sig-paren">(</span><em>group</em>, <em>method</em>, <em>response_consumer</em>, <em>context</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#MultiMethodImplementation.service"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.MultiMethodImplementation.service" title="Permalink to this definition">¶</a></dt>
<dd><p>Services an RPC.</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>group</strong> &#8211; The group identifier of the RPC.</li>
<li><strong>method</strong> &#8211; The method identifier of the RPC.</li>
<li><strong>response_consumer</strong> &#8211; A stream.Consumer to be called to accept the response
values of the RPC.</li>
<li><strong>context</strong> &#8211; a ServicerContext object.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><dl class="docutils">
<dt>A stream.Consumer with which to accept the request values of the RPC. The</dt>
<dd><p class="first last">consumer returned from this method may or may not be invoked to
completion: in the case of RPC abortion, RPC Framework will simply stop
passing values to this object. Implementations must not assume that this
object will be called to completion of the request stream or even called
at all.</p>
</dd>
</dl>
</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">abandonment.Abandoned</span></code> &#8211; May or may not be raised when the RPC has been
aborted.</li>
<li><a class="reference internal" href="#grpc.framework.interfaces.face.face.NoSuchMethodError" title="grpc.framework.interfaces.face.face.NoSuchMethodError"><code class="xref py py-exc docutils literal"><span class="pre">NoSuchMethodError</span></code></a> &#8211; If this MultiMethod does not recognize the given group
and name for the RPC and is not able to service the RPC.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

<dl class="exception">
<dt id="grpc.framework.interfaces.face.face.NetworkError">
<em class="property">exception </em><code class="descclassname">grpc.framework.interfaces.face.face.</code><code class="descname">NetworkError</code><span class="sig-paren">(</span><em>initial_metadata</em>, <em>terminal_metadata</em>, <em>code</em>, <em>details</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#NetworkError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.NetworkError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#grpc.framework.interfaces.face.face.AbortionError" title="grpc.framework.interfaces.face.face.AbortionError"><code class="xref py py-class docutils literal"><span class="pre">grpc.framework.interfaces.face.face.AbortionError</span></code></a></p>
<p>Indicates that some error occurred on the network.</p>
</dd></dl>

<dl class="exception">
<dt id="grpc.framework.interfaces.face.face.NoSuchMethodError">
<em class="property">exception </em><code class="descclassname">grpc.framework.interfaces.face.face.</code><code class="descname">NoSuchMethodError</code><span class="sig-paren">(</span><em>group</em>, <em>method</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#NoSuchMethodError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.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>Raised by customer code to indicate an unrecognized method.</p>
<dl class="attribute">
<dt id="grpc.framework.interfaces.face.face.NoSuchMethodError.group">
<code class="descname">group</code><a class="headerlink" href="#grpc.framework.interfaces.face.face.NoSuchMethodError.group" title="Permalink to this definition">¶</a></dt>
<dd><p>The group of the unrecognized method.</p>
</dd></dl>

<dl class="attribute">
<dt id="grpc.framework.interfaces.face.face.NoSuchMethodError.name">
<code class="descname">name</code><a class="headerlink" href="#grpc.framework.interfaces.face.face.NoSuchMethodError.name" title="Permalink to this definition">¶</a></dt>
<dd><p>The name of the unrecognized method.</p>
</dd></dl>

</dd></dl>

<dl class="exception">
<dt id="grpc.framework.interfaces.face.face.RemoteError">
<em class="property">exception </em><code class="descclassname">grpc.framework.interfaces.face.face.</code><code class="descname">RemoteError</code><span class="sig-paren">(</span><em>initial_metadata</em>, <em>terminal_metadata</em>, <em>code</em>, <em>details</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#RemoteError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.RemoteError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#grpc.framework.interfaces.face.face.AbortionError" title="grpc.framework.interfaces.face.face.AbortionError"><code class="xref py py-class docutils literal"><span class="pre">grpc.framework.interfaces.face.face.AbortionError</span></code></a></p>
<p>Indicates that an RPC has terminated due to a remote defect.</p>
</dd></dl>

<dl class="exception">
<dt id="grpc.framework.interfaces.face.face.RemoteShutdownError">
<em class="property">exception </em><code class="descclassname">grpc.framework.interfaces.face.face.</code><code class="descname">RemoteShutdownError</code><span class="sig-paren">(</span><em>initial_metadata</em>, <em>terminal_metadata</em>, <em>code</em>, <em>details</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#RemoteShutdownError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.RemoteShutdownError" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#grpc.framework.interfaces.face.face.AbortionError" title="grpc.framework.interfaces.face.face.AbortionError"><code class="xref py py-class docutils literal"><span class="pre">grpc.framework.interfaces.face.face.AbortionError</span></code></a></p>
<p>Indicates that an RPC has terminated due to remote shutdown of RPCs.</p>
</dd></dl>

<dl class="class">
<dt id="grpc.framework.interfaces.face.face.ResponseReceiver">
<em class="property">class </em><code class="descclassname">grpc.framework.interfaces.face.face.</code><code class="descname">ResponseReceiver</code><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#ResponseReceiver"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.ResponseReceiver" 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>Invocation-side object used to accept the output of an RPC.</p>
<dl class="method">
<dt id="grpc.framework.interfaces.face.face.ResponseReceiver.complete">
<code class="descname">complete</code><span class="sig-paren">(</span><em>terminal_metadata</em>, <em>code</em>, <em>details</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#ResponseReceiver.complete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.ResponseReceiver.complete" title="Permalink to this definition">¶</a></dt>
<dd><p>Receives the completion values emitted from the service-side of the RPC.</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 last simple">
<li><strong>terminal_metadata</strong> &#8211; The terminal metadata object emitted from the
service-side of the RPC.</li>
<li><strong>code</strong> &#8211; The code object emitted from the service-side of the RPC.</li>
<li><strong>details</strong> &#8211; The details object emitted from the service-side of the RPC.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.interfaces.face.face.ResponseReceiver.initial_metadata">
<code class="descname">initial_metadata</code><span class="sig-paren">(</span><em>initial_metadata</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#ResponseReceiver.initial_metadata"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.ResponseReceiver.initial_metadata" title="Permalink to this definition">¶</a></dt>
<dd><p>Receives the initial metadata from the service-side of the RPC.</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>initial_metadata</strong> &#8211; The initial metadata object emitted from the
service-side of the RPC.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.interfaces.face.face.ResponseReceiver.response">
<code class="descname">response</code><span class="sig-paren">(</span><em>response</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#ResponseReceiver.response"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.ResponseReceiver.response" title="Permalink to this definition">¶</a></dt>
<dd><p>Receives a response from the service-side of the RPC.</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>response</strong> &#8211; A response object emitted from the service-side of the RPC.</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="grpc.framework.interfaces.face.face.RpcContext">
<em class="property">class </em><code class="descclassname">grpc.framework.interfaces.face.face.</code><code class="descname">RpcContext</code><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#RpcContext"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.RpcContext" 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 RPC-related information and action.</p>
<dl class="method">
<dt id="grpc.framework.interfaces.face.face.RpcContext.add_abortion_callback">
<code class="descname">add_abortion_callback</code><span class="sig-paren">(</span><em>abortion_callback</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#RpcContext.add_abortion_callback"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.RpcContext.add_abortion_callback" title="Permalink to this definition">¶</a></dt>
<dd><p>Registers a callback to be called if the RPC is aborted.</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>abortion_callback</strong> &#8211; A callable to be called and passed an Abortion value
in the event of RPC abortion.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.interfaces.face.face.RpcContext.cancel">
<code class="descname">cancel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#RpcContext.cancel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.RpcContext.cancel" title="Permalink to this definition">¶</a></dt>
<dd><p>Cancels the RPC.</p>
<p>Idempotent and has no effect if the RPC has already terminated.</p>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.interfaces.face.face.RpcContext.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/interfaces/face/face.html#RpcContext.is_active"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.RpcContext.is_active" title="Permalink to this definition">¶</a></dt>
<dd><p>Describes whether the RPC is active or has terminated.</p>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.interfaces.face.face.RpcContext.protocol_context">
<code class="descname">protocol_context</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#RpcContext.protocol_context"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.RpcContext.protocol_context" title="Permalink to this definition">¶</a></dt>
<dd><p>Accesses a custom object specified by an implementation provider.</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 value specified by the provider of a Face interface implementation</dt>
<dd>affording custom state and behavior.</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.interfaces.face.face.RpcContext.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/interfaces/face/face.html#RpcContext.time_remaining"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.RpcContext.time_remaining" title="Permalink to this definition">¶</a></dt>
<dd><p>Describes the length of allowed time remaining for the RPC.</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 RPC 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.interfaces.face.face.ServicerContext">
<em class="property">class </em><code class="descclassname">grpc.framework.interfaces.face.face.</code><code class="descname">ServicerContext</code><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#ServicerContext"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.ServicerContext" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#grpc.framework.interfaces.face.face.RpcContext" title="grpc.framework.interfaces.face.face.RpcContext"><code class="xref py py-class docutils literal"><span class="pre">grpc.framework.interfaces.face.face.RpcContext</span></code></a></p>
<p>A context object passed to method implementations.</p>
<dl class="method">
<dt id="grpc.framework.interfaces.face.face.ServicerContext.code">
<code class="descname">code</code><span class="sig-paren">(</span><em>code</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#ServicerContext.code"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.ServicerContext.code" title="Permalink to this definition">¶</a></dt>
<dd><p>Accepts the service-side code of the RPC.</p>
<p>This method need not be called by method implementations if they have no
code to transmit.</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>code</strong> &#8211; The code of the RPC to be transmitted to the invocation side of the
RPC.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.interfaces.face.face.ServicerContext.details">
<code class="descname">details</code><span class="sig-paren">(</span><em>details</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#ServicerContext.details"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.ServicerContext.details" title="Permalink to this definition">¶</a></dt>
<dd><p>Accepts the service-side details of the RPC.</p>
<p>This method need not be called by method implementations if they have no
service-side details to transmit.</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>details</strong> &#8211; The service-side details value of the RPC to be transmitted to
the invocation side of the RPC.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.interfaces.face.face.ServicerContext.initial_metadata">
<code class="descname">initial_metadata</code><span class="sig-paren">(</span><em>initial_metadata</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#ServicerContext.initial_metadata"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.ServicerContext.initial_metadata" title="Permalink to this definition">¶</a></dt>
<dd><p>Accepts the service-side initial metadata value of the RPC.</p>
<p>This method need not be called by method implementations if they have no
service-side initial metadata to transmit.</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>initial_metadata</strong> &#8211; The service-side initial metadata value of the RPC to
be transmitted to the invocation side of the RPC.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.interfaces.face.face.ServicerContext.invocation_metadata">
<code class="descname">invocation_metadata</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#ServicerContext.invocation_metadata"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.ServicerContext.invocation_metadata" title="Permalink to this definition">¶</a></dt>
<dd><p>Accesses the metadata from the invocation-side of the RPC.</p>
<p>This method blocks until the value is available or is known not to have been
emitted from the invocation-side of the RPC.</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>The metadata object emitted by the invocation-side of the RPC, or None if</dt>
<dd>there was no such value.</dd>
</dl>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.interfaces.face.face.ServicerContext.terminal_metadata">
<code class="descname">terminal_metadata</code><span class="sig-paren">(</span><em>terminal_metadata</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#ServicerContext.terminal_metadata"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.ServicerContext.terminal_metadata" title="Permalink to this definition">¶</a></dt>
<dd><p>Accepts the service-side terminal metadata value of the RPC.</p>
<p>This method need not be called by method implementations if they have no
service-side terminal metadata to transmit.</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>terminal_metadata</strong> &#8211; The service-side terminal metadata value of the RPC to
be transmitted to the invocation side of the RPC.</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="grpc.framework.interfaces.face.face.StreamStreamMultiCallable">
<em class="property">class </em><code class="descclassname">grpc.framework.interfaces.face.face.</code><code class="descname">StreamStreamMultiCallable</code><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#StreamStreamMultiCallable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.StreamStreamMultiCallable" 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>Affords invoking a stream-stream RPC in any call style.</p>
<dl class="method">
<dt id="grpc.framework.interfaces.face.face.StreamStreamMultiCallable.__call__">
<code class="descname">__call__</code><span class="sig-paren">(</span><em>request_iterator</em>, <em>timeout</em>, <em>metadata=None</em>, <em>protocol_options=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#StreamStreamMultiCallable.__call__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.StreamStreamMultiCallable.__call__" title="Permalink to this definition">¶</a></dt>
<dd><p>Invokes the underlying RPC.</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>request_iterator</strong> &#8211; An iterator that yields request values for the RPC.</li>
<li><strong>timeout</strong> &#8211; A duration of time in seconds to allow for the RPC.</li>
<li><strong>metadata</strong> &#8211; A metadata value to be passed to the service-side of
the RPC.</li>
<li><strong>protocol_options</strong> &#8211; A value specified by the provider of a Face interface
implementation affording custom state and behavior.</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 object that is both a Call for the RPC and an iterator of response</dt>
<dd><p class="first last">values. Drawing response values from the returned iterator may raise
AbortionError indicating abortion of the RPC.</p>
</dd>
</dl>
</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.interfaces.face.face.StreamStreamMultiCallable.event">
<code class="descname">event</code><span class="sig-paren">(</span><em>receiver</em>, <em>abortion_callback</em>, <em>timeout</em>, <em>metadata=None</em>, <em>protocol_options=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#StreamStreamMultiCallable.event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.StreamStreamMultiCallable.event" title="Permalink to this definition">¶</a></dt>
<dd><p>Asynchronously invokes the underlying RPC.</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>receiver</strong> &#8211; A ResponseReceiver to be passed the response data of the RPC.</li>
<li><strong>abortion_callback</strong> &#8211; A callback to be called and passed an Abortion value
in the event of RPC abortion.</li>
<li><strong>timeout</strong> &#8211; A duration of time in seconds to allow for the RPC.</li>
<li><strong>metadata</strong> &#8211; A metadata value to be passed to the service-side of
the RPC.</li>
<li><strong>protocol_options</strong> &#8211; A value specified by the provider of a Face interface
implementation affording custom state and behavior.</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>A single object that is both a Call object for the RPC and a</dt>
<dd><p class="first last">stream.Consumer to which the request values of the RPC should be passed.</p>
</dd>
</dl>
</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="grpc.framework.interfaces.face.face.StreamUnaryMultiCallable">
<em class="property">class </em><code class="descclassname">grpc.framework.interfaces.face.face.</code><code class="descname">StreamUnaryMultiCallable</code><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#StreamUnaryMultiCallable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.StreamUnaryMultiCallable" 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>Affords invoking a stream-unary RPC in any call style.</p>
<dl class="method">
<dt id="grpc.framework.interfaces.face.face.StreamUnaryMultiCallable.__call__">
<code class="descname">__call__</code><span class="sig-paren">(</span><em>request_iterator</em>, <em>timeout</em>, <em>metadata=None</em>, <em>with_call=False</em>, <em>protocol_options=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#StreamUnaryMultiCallable.__call__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.StreamUnaryMultiCallable.__call__" title="Permalink to this definition">¶</a></dt>
<dd><p>Synchronously invokes the underlying RPC.</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>request_iterator</strong> &#8211; An iterator that yields request values for the RPC.</li>
<li><strong>timeout</strong> &#8211; A duration of time in seconds to allow for the RPC.</li>
<li><strong>metadata</strong> &#8211; A metadata value to be passed to the service-side of
the RPC.</li>
<li><strong>with_call</strong> &#8211; Whether or not to include return a Call for the RPC in addition
to the response.</li>
<li><strong>protocol_options</strong> &#8211; A value specified by the provider of a Face interface
implementation affording custom state and behavior.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><dl class="docutils">
<dt>The response value for the RPC, and a Call for the RPC if with_call was</dt>
<dd><p class="first last">set to True at invocation.</p>
</dd>
</dl>
</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#grpc.framework.interfaces.face.face.AbortionError" title="grpc.framework.interfaces.face.face.AbortionError"><code class="xref py py-exc docutils literal"><span class="pre">AbortionError</span></code></a> &#8211; Indicating that the RPC was aborted.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.interfaces.face.face.StreamUnaryMultiCallable.event">
<code class="descname">event</code><span class="sig-paren">(</span><em>receiver</em>, <em>abortion_callback</em>, <em>timeout</em>, <em>metadata=None</em>, <em>protocol_options=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#StreamUnaryMultiCallable.event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.StreamUnaryMultiCallable.event" title="Permalink to this definition">¶</a></dt>
<dd><p>Asynchronously invokes the underlying RPC.</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>receiver</strong> &#8211; A ResponseReceiver to be passed the response data of the RPC.</li>
<li><strong>abortion_callback</strong> &#8211; A callback to be called and passed an Abortion value
in the event of RPC abortion.</li>
<li><strong>timeout</strong> &#8211; A duration of time in seconds to allow for the RPC.</li>
<li><strong>metadata</strong> &#8211; A metadata value to be passed to the service-side of
the RPC.</li>
<li><strong>protocol_options</strong> &#8211; A value specified by the provider of a Face interface
implementation affording custom state and behavior.</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>A single object that is both a Call object for the RPC and a</dt>
<dd><p class="first last">stream.Consumer to which the request values of the RPC should be passed.</p>
</dd>
</dl>
</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.interfaces.face.face.StreamUnaryMultiCallable.future">
<code class="descname">future</code><span class="sig-paren">(</span><em>request_iterator</em>, <em>timeout</em>, <em>metadata=None</em>, <em>protocol_options=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#StreamUnaryMultiCallable.future"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.StreamUnaryMultiCallable.future" title="Permalink to this definition">¶</a></dt>
<dd><p>Asynchronously invokes the underlying RPC.</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>request_iterator</strong> &#8211; An iterator that yields request values for the RPC.</li>
<li><strong>timeout</strong> &#8211; A duration of time in seconds to allow for the RPC.</li>
<li><strong>metadata</strong> &#8211; A metadata value to be passed to the service-side of
the RPC.</li>
<li><strong>protocol_options</strong> &#8211; A value specified by the provider of a Face interface
implementation affording custom state and behavior.</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 object that is both a Call for the RPC and a future.Future. In the</dt>
<dd><p class="first last">event of RPC completion, the return Future&#8217;s result value will be the
response value of the RPC. In the event of RPC abortion, the returned
Future&#8217;s exception value will be an AbortionError.</p>
</dd>
</dl>
</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="grpc.framework.interfaces.face.face.UnaryStreamMultiCallable">
<em class="property">class </em><code class="descclassname">grpc.framework.interfaces.face.face.</code><code class="descname">UnaryStreamMultiCallable</code><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#UnaryStreamMultiCallable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.UnaryStreamMultiCallable" 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>Affords invoking a unary-stream RPC in any call style.</p>
<dl class="method">
<dt id="grpc.framework.interfaces.face.face.UnaryStreamMultiCallable.__call__">
<code class="descname">__call__</code><span class="sig-paren">(</span><em>request</em>, <em>timeout</em>, <em>metadata=None</em>, <em>protocol_options=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#UnaryStreamMultiCallable.__call__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.UnaryStreamMultiCallable.__call__" title="Permalink to this definition">¶</a></dt>
<dd><p>Invokes the underlying RPC.</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>request</strong> &#8211; The request value for the RPC.</li>
<li><strong>timeout</strong> &#8211; A duration of time in seconds to allow for the RPC.</li>
<li><strong>metadata</strong> &#8211; A metadata value to be passed to the service-side of
the RPC.</li>
<li><strong>protocol_options</strong> &#8211; A value specified by the provider of a Face interface
implementation affording custom state and behavior.</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 object that is both a Call for the RPC and an iterator of response</dt>
<dd><p class="first last">values. Drawing response values from the returned iterator may raise
AbortionError indicating abortion of the RPC.</p>
</dd>
</dl>
</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.interfaces.face.face.UnaryStreamMultiCallable.event">
<code class="descname">event</code><span class="sig-paren">(</span><em>request</em>, <em>receiver</em>, <em>abortion_callback</em>, <em>timeout</em>, <em>metadata=None</em>, <em>protocol_options=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#UnaryStreamMultiCallable.event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.UnaryStreamMultiCallable.event" title="Permalink to this definition">¶</a></dt>
<dd><p>Asynchronously invokes the underlying RPC.</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>request</strong> &#8211; The request value for the RPC.</li>
<li><strong>receiver</strong> &#8211; A ResponseReceiver to be passed the response data of the RPC.</li>
<li><strong>abortion_callback</strong> &#8211; A callback to be called and passed an Abortion value
in the event of RPC abortion.</li>
<li><strong>timeout</strong> &#8211; A duration of time in seconds to allow for the RPC.</li>
<li><strong>metadata</strong> &#8211; A metadata value to be passed to the service-side of
the RPC.</li>
<li><strong>protocol_options</strong> &#8211; A value specified by the provider of a Face interface
implementation affording custom state and behavior.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A Call object for the RPC.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="grpc.framework.interfaces.face.face.UnaryUnaryMultiCallable">
<em class="property">class </em><code class="descclassname">grpc.framework.interfaces.face.face.</code><code class="descname">UnaryUnaryMultiCallable</code><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#UnaryUnaryMultiCallable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.UnaryUnaryMultiCallable" 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>Affords invoking a unary-unary RPC in any call style.</p>
<dl class="method">
<dt id="grpc.framework.interfaces.face.face.UnaryUnaryMultiCallable.__call__">
<code class="descname">__call__</code><span class="sig-paren">(</span><em>request</em>, <em>timeout</em>, <em>metadata=None</em>, <em>with_call=False</em>, <em>protocol_options=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#UnaryUnaryMultiCallable.__call__"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.UnaryUnaryMultiCallable.__call__" title="Permalink to this definition">¶</a></dt>
<dd><p>Synchronously invokes the underlying RPC.</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>request</strong> &#8211; The request value for the RPC.</li>
<li><strong>timeout</strong> &#8211; A duration of time in seconds to allow for the RPC.</li>
<li><strong>metadata</strong> &#8211; A metadata value to be passed to the service-side of
the RPC.</li>
<li><strong>with_call</strong> &#8211; Whether or not to include return a Call for the RPC in addition
to the response.</li>
<li><strong>protocol_options</strong> &#8211; A value specified by the provider of a Face interface
implementation affording custom state and behavior.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><dl class="docutils">
<dt>The response value for the RPC, and a Call for the RPC if with_call was</dt>
<dd><p class="first last">set to True at invocation.</p>
</dd>
</dl>
</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><a class="reference internal" href="#grpc.framework.interfaces.face.face.AbortionError" title="grpc.framework.interfaces.face.face.AbortionError"><code class="xref py py-exc docutils literal"><span class="pre">AbortionError</span></code></a> &#8211; Indicating that the RPC was aborted.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.interfaces.face.face.UnaryUnaryMultiCallable.event">
<code class="descname">event</code><span class="sig-paren">(</span><em>request</em>, <em>receiver</em>, <em>abortion_callback</em>, <em>timeout</em>, <em>metadata=None</em>, <em>protocol_options=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#UnaryUnaryMultiCallable.event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.UnaryUnaryMultiCallable.event" title="Permalink to this definition">¶</a></dt>
<dd><p>Asynchronously invokes the underlying RPC.</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>request</strong> &#8211; The request value for the RPC.</li>
<li><strong>receiver</strong> &#8211; A ResponseReceiver to be passed the response data of the RPC.</li>
<li><strong>abortion_callback</strong> &#8211; A callback to be called and passed an Abortion value
in the event of RPC abortion.</li>
<li><strong>timeout</strong> &#8211; A duration of time in seconds to allow for the RPC.</li>
<li><strong>metadata</strong> &#8211; A metadata value to be passed to the service-side of
the RPC.</li>
<li><strong>protocol_options</strong> &#8211; A value specified by the provider of a Face interface
implementation affording custom state and behavior.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">A Call for the RPC.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="grpc.framework.interfaces.face.face.UnaryUnaryMultiCallable.future">
<code class="descname">future</code><span class="sig-paren">(</span><em>request</em>, <em>timeout</em>, <em>metadata=None</em>, <em>protocol_options=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/face.html#UnaryUnaryMultiCallable.future"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.face.UnaryUnaryMultiCallable.future" title="Permalink to this definition">¶</a></dt>
<dd><p>Asynchronously invokes the underlying RPC.</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>request</strong> &#8211; The request value for the RPC.</li>
<li><strong>timeout</strong> &#8211; A duration of time in seconds to allow for the RPC.</li>
<li><strong>metadata</strong> &#8211; A metadata value to be passed to the service-side of
the RPC.</li>
<li><strong>protocol_options</strong> &#8211; A value specified by the provider of a Face interface
implementation affording custom state and behavior.</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 object that is both a Call for the RPC and a future.Future. In the</dt>
<dd><p class="first last">event of RPC completion, the return Future&#8217;s result value will be the
response value of the RPC. In the event of RPC abortion, the returned
Future&#8217;s exception value will be an AbortionError.</p>
</dd>
</dl>
</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

</dd></dl>

</div>
<div class="section" id="module-grpc.framework.interfaces.face.utilities">
<span id="grpc-framework-interfaces-face-utilities-module"></span><h2>grpc.framework.interfaces.face.utilities module<a class="headerlink" href="#module-grpc.framework.interfaces.face.utilities" title="Permalink to this headline">¶</a></h2>
<p>Utilities for RPC Framework&#8217;s Face interface.</p>
<dl class="function">
<dt id="grpc.framework.interfaces.face.utilities.stream_stream_event">
<code class="descclassname">grpc.framework.interfaces.face.utilities.</code><code class="descname">stream_stream_event</code><span class="sig-paren">(</span><em>behavior</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/utilities.html#stream_stream_event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.utilities.stream_stream_event" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates an face.MethodImplementation for the given behavior.</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>behavior</strong> &#8211; The implementation of a stream-stream RPC method as a callable
value that takes a stream.Consumer to which to pass the response values
of the RPC and an face.ServicerContext and returns a stream.Consumer to
which the request values of the RPC should be passed.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">An face.MethodImplementation derived from the given behavior.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="grpc.framework.interfaces.face.utilities.stream_stream_inline">
<code class="descclassname">grpc.framework.interfaces.face.utilities.</code><code class="descname">stream_stream_inline</code><span class="sig-paren">(</span><em>behavior</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/utilities.html#stream_stream_inline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.utilities.stream_stream_inline" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates an face.MethodImplementation for the given behavior.</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>behavior</strong> &#8211; The implementation of a stream-stream RPC method as a callable
value that takes an iterator of request values and an
face.ServicerContext object and returns an iterator of response values.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">An face.MethodImplementation derived from the given behavior.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="grpc.framework.interfaces.face.utilities.stream_unary_event">
<code class="descclassname">grpc.framework.interfaces.face.utilities.</code><code class="descname">stream_unary_event</code><span class="sig-paren">(</span><em>behavior</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/utilities.html#stream_unary_event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.utilities.stream_unary_event" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates an face.MethodImplementation for the given behavior.</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>behavior</strong> &#8211; The implementation of a stream-unary RPC method as a callable
value that takes a response callback to which to pass the response value
of the RPC and an face.ServicerContext and returns a stream.Consumer to
which the request values of the RPC should be passed.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">An face.MethodImplementation derived from the given behavior.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="grpc.framework.interfaces.face.utilities.stream_unary_inline">
<code class="descclassname">grpc.framework.interfaces.face.utilities.</code><code class="descname">stream_unary_inline</code><span class="sig-paren">(</span><em>behavior</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/utilities.html#stream_unary_inline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.utilities.stream_unary_inline" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates an face.MethodImplementation for the given behavior.</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>behavior</strong> &#8211; The implementation of a stream-unary RPC method as a callable
value that takes an iterator of request values and an
face.ServicerContext object and returns a response value.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">An face.MethodImplementation derived from the given behavior.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="grpc.framework.interfaces.face.utilities.unary_stream_event">
<code class="descclassname">grpc.framework.interfaces.face.utilities.</code><code class="descname">unary_stream_event</code><span class="sig-paren">(</span><em>behavior</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/utilities.html#unary_stream_event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.utilities.unary_stream_event" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates an face.MethodImplementation for the given behavior.</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>behavior</strong> &#8211; The implementation of a unary-stream RPC method as a callable
value that takes a request value, a stream.Consumer to which to pass the
the response values of the RPC, and an face.ServicerContext.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">An face.MethodImplementation derived from the given behavior.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="grpc.framework.interfaces.face.utilities.unary_stream_inline">
<code class="descclassname">grpc.framework.interfaces.face.utilities.</code><code class="descname">unary_stream_inline</code><span class="sig-paren">(</span><em>behavior</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/utilities.html#unary_stream_inline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.utilities.unary_stream_inline" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates an face.MethodImplementation for the given behavior.</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>behavior</strong> &#8211; The implementation of a unary-stream RPC method as a callable
value that takes a request value and an face.ServicerContext object and
returns an iterator of response values.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">An face.MethodImplementation derived from the given behavior.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="grpc.framework.interfaces.face.utilities.unary_unary_event">
<code class="descclassname">grpc.framework.interfaces.face.utilities.</code><code class="descname">unary_unary_event</code><span class="sig-paren">(</span><em>behavior</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/utilities.html#unary_unary_event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.utilities.unary_unary_event" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates an face.MethodImplementation for the given behavior.</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>behavior</strong> &#8211; The implementation of a unary-unary RPC method as a callable
value that takes a request value, a response callback to which to pass
the response value of the RPC, and an face.ServicerContext.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">An face.MethodImplementation derived from the given behavior.</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="grpc.framework.interfaces.face.utilities.unary_unary_inline">
<code class="descclassname">grpc.framework.interfaces.face.utilities.</code><code class="descname">unary_unary_inline</code><span class="sig-paren">(</span><em>behavior</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/grpc/framework/interfaces/face/utilities.html#unary_unary_inline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#grpc.framework.interfaces.face.utilities.unary_unary_inline" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates an face.MethodImplementation for the given behavior.</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>behavior</strong> &#8211; The implementation of a unary-unary RPC method as a callable value
that takes a request value and an face.ServicerContext object and
returns a response value.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">An face.MethodImplementation derived from the given behavior.</td>
</tr>
</tbody>
</table>
</dd></dl>

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


           </div>
           <div class="articleComments">
            
           </div>
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
      
        <a href="grpc.framework.interfaces.base.html" class="btn btn-neutral" title="grpc.framework.interfaces.base package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <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>