carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GRPC C++: grpc::ClientBidiReactor&lt; Request, Response &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">GRPC C++
   &#160;<span id="projectnumber">1.36.1</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespacegrpc.html">grpc</a></li><li class="navelem"><a class="el" href="classgrpc_1_1_client_bidi_reactor.html">ClientBidiReactor</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a>  </div>
  <div class="headertitle">
<div class="title">grpc::ClientBidiReactor&lt; Request, Response &gt; Class Template Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><em><a class="el" href="classgrpc_1_1_client_bidi_reactor.html" title="ClientBidiReactor is the interface for a bidirectional streaming RPC.">ClientBidiReactor</a></em> is the interface for a bidirectional streaming RPC.  
 <a href="classgrpc_1_1_client_bidi_reactor.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="impl_2codegen_2client__callback_8h_source.html">client_callback.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:afe6c450aa06e7b2f5484fc771126bed3"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_bidi_reactor.html#afe6c450aa06e7b2f5484fc771126bed3">~ClientBidiReactor</a> ()</td></tr>
<tr class="separator:afe6c450aa06e7b2f5484fc771126bed3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a56f0665e201a621d5bfa5b1bf3db4654"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_bidi_reactor.html#a56f0665e201a621d5bfa5b1bf3db4654">StartCall</a> ()</td></tr>
<tr class="memdesc:a56f0665e201a621d5bfa5b1bf3db4654"><td class="mdescLeft">&#160;</td><td class="mdescRight">Activate the RPC and initiate any reads or writes that have been Start'ed before this call.  <a href="classgrpc_1_1_client_bidi_reactor.html#a56f0665e201a621d5bfa5b1bf3db4654">More...</a><br /></td></tr>
<tr class="separator:a56f0665e201a621d5bfa5b1bf3db4654"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a511f4e83af63f9569f361a79e9586dce"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_bidi_reactor.html#a511f4e83af63f9569f361a79e9586dce">StartRead</a> (Response *resp)</td></tr>
<tr class="memdesc:a511f4e83af63f9569f361a79e9586dce"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initiate a read operation (or post it for later initiation if StartCall has not yet been invoked).  <a href="classgrpc_1_1_client_bidi_reactor.html#a511f4e83af63f9569f361a79e9586dce">More...</a><br /></td></tr>
<tr class="separator:a511f4e83af63f9569f361a79e9586dce"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3c14129661af38610185a006bbb7eca9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_bidi_reactor.html#a3c14129661af38610185a006bbb7eca9">StartWrite</a> (const Request *req)</td></tr>
<tr class="memdesc:a3c14129661af38610185a006bbb7eca9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initiate a write operation (or post it for later initiation if StartCall has not yet been invoked).  <a href="classgrpc_1_1_client_bidi_reactor.html#a3c14129661af38610185a006bbb7eca9">More...</a><br /></td></tr>
<tr class="separator:a3c14129661af38610185a006bbb7eca9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3aaca1812914a82e582446ba4e0a9f92"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_bidi_reactor.html#a3aaca1812914a82e582446ba4e0a9f92">StartWrite</a> (const Request *req, ::<a class="el" href="classgrpc_1_1_write_options.html">grpc::WriteOptions</a> options)</td></tr>
<tr class="memdesc:a3aaca1812914a82e582446ba4e0a9f92"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initiate/post a write operation with specified options.  <a href="classgrpc_1_1_client_bidi_reactor.html#a3aaca1812914a82e582446ba4e0a9f92">More...</a><br /></td></tr>
<tr class="separator:a3aaca1812914a82e582446ba4e0a9f92"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8709dc8bd207e577a6cffdce441612cb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_bidi_reactor.html#a8709dc8bd207e577a6cffdce441612cb">StartWriteLast</a> (const Request *req, ::<a class="el" href="classgrpc_1_1_write_options.html">grpc::WriteOptions</a> options)</td></tr>
<tr class="memdesc:a8709dc8bd207e577a6cffdce441612cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initiate/post a write operation with specified options and an indication that this is the last write (like StartWrite and StartWritesDone, merged).  <a href="classgrpc_1_1_client_bidi_reactor.html#a8709dc8bd207e577a6cffdce441612cb">More...</a><br /></td></tr>
<tr class="separator:a8709dc8bd207e577a6cffdce441612cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a43f605fb458e7545718e595868eba3c8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_bidi_reactor.html#a43f605fb458e7545718e595868eba3c8">StartWritesDone</a> ()</td></tr>
<tr class="memdesc:a43f605fb458e7545718e595868eba3c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicate that the RPC will have no more write operations.  <a href="classgrpc_1_1_client_bidi_reactor.html#a43f605fb458e7545718e595868eba3c8">More...</a><br /></td></tr>
<tr class="separator:a43f605fb458e7545718e595868eba3c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a88c169b6b8d9ea5579d152a86b74582c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_bidi_reactor.html#a88c169b6b8d9ea5579d152a86b74582c">AddHold</a> ()</td></tr>
<tr class="memdesc:a88c169b6b8d9ea5579d152a86b74582c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Holds are needed if (and only if) this stream has operations that take place on it after StartCall but from outside one of the reactions (OnReadDone, etc).  <a href="classgrpc_1_1_client_bidi_reactor.html#a88c169b6b8d9ea5579d152a86b74582c">More...</a><br /></td></tr>
<tr class="separator:a88c169b6b8d9ea5579d152a86b74582c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a890e44bcd297489ae49c77d0d6c8cc31"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_bidi_reactor.html#a890e44bcd297489ae49c77d0d6c8cc31">AddMultipleHolds</a> (int holds)</td></tr>
<tr class="separator:a890e44bcd297489ae49c77d0d6c8cc31"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6c5597375914b59db43aabef3c92ddb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_bidi_reactor.html#af6c5597375914b59db43aabef3c92ddb">RemoveHold</a> ()</td></tr>
<tr class="separator:af6c5597375914b59db43aabef3c92ddb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af38b5c2d3a3737a8ba5940624872e569"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_bidi_reactor.html#af38b5c2d3a3737a8ba5940624872e569">OnDone</a> (const ::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> &amp;) override</td></tr>
<tr class="memdesc:af38b5c2d3a3737a8ba5940624872e569"><td class="mdescLeft">&#160;</td><td class="mdescRight">Notifies the application that all operations associated with this RPC have completed and all Holds have been removed.  <a href="classgrpc_1_1_client_bidi_reactor.html#af38b5c2d3a3737a8ba5940624872e569">More...</a><br /></td></tr>
<tr class="separator:af38b5c2d3a3737a8ba5940624872e569"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad37f6df922b0bf95c789fa853d8cf265"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_bidi_reactor.html#ad37f6df922b0bf95c789fa853d8cf265">OnReadInitialMetadataDone</a> (bool)</td></tr>
<tr class="memdesc:ad37f6df922b0bf95c789fa853d8cf265"><td class="mdescLeft">&#160;</td><td class="mdescRight">Notifies the application that a read of initial metadata from the server is done.  <a href="classgrpc_1_1_client_bidi_reactor.html#ad37f6df922b0bf95c789fa853d8cf265">More...</a><br /></td></tr>
<tr class="separator:ad37f6df922b0bf95c789fa853d8cf265"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad77148d32093f38daeb755e820b70c61"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_bidi_reactor.html#ad77148d32093f38daeb755e820b70c61">OnReadDone</a> (bool)</td></tr>
<tr class="memdesc:ad77148d32093f38daeb755e820b70c61"><td class="mdescLeft">&#160;</td><td class="mdescRight">Notifies the application that a StartRead operation completed.  <a href="classgrpc_1_1_client_bidi_reactor.html#ad77148d32093f38daeb755e820b70c61">More...</a><br /></td></tr>
<tr class="separator:ad77148d32093f38daeb755e820b70c61"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad7673b2c6cfb2dbb77655ef6fee6ebc7"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_bidi_reactor.html#ad7673b2c6cfb2dbb77655ef6fee6ebc7">OnWriteDone</a> (bool)</td></tr>
<tr class="memdesc:ad7673b2c6cfb2dbb77655ef6fee6ebc7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Notifies the application that a StartWrite or StartWriteLast operation completed.  <a href="classgrpc_1_1_client_bidi_reactor.html#ad7673b2c6cfb2dbb77655ef6fee6ebc7">More...</a><br /></td></tr>
<tr class="separator:ad7673b2c6cfb2dbb77655ef6fee6ebc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af17ed4c88facea059373383897c2f120"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_bidi_reactor.html#af17ed4c88facea059373383897c2f120">OnWritesDoneDone</a> (bool)</td></tr>
<tr class="memdesc:af17ed4c88facea059373383897c2f120"><td class="mdescLeft">&#160;</td><td class="mdescRight">Notifies the application that a StartWritesDone operation completed.  <a href="classgrpc_1_1_client_bidi_reactor.html#af17ed4c88facea059373383897c2f120">More...</a><br /></td></tr>
<tr class="separator:af17ed4c88facea059373383897c2f120"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a9e889e5582a185bc4aee78b7abaf8108"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_bidi_reactor.html#a9e889e5582a185bc4aee78b7abaf8108">ClientCallbackReaderWriter&lt; Request, Response &gt;</a></td></tr>
<tr class="separator:a9e889e5582a185bc4aee78b7abaf8108"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class Request, class Response&gt;<br />
class grpc::ClientBidiReactor&lt; Request, Response &gt;</h3>

<p><em><a class="el" href="classgrpc_1_1_client_bidi_reactor.html" title="ClientBidiReactor is the interface for a bidirectional streaming RPC.">ClientBidiReactor</a></em> is the interface for a bidirectional streaming RPC. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="afe6c450aa06e7b2f5484fc771126bed3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe6c450aa06e7b2f5484fc771126bed3">&#9670;&nbsp;</a></span>~ClientBidiReactor()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Request , class Response &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classgrpc_1_1_client_bidi_reactor.html">grpc::ClientBidiReactor</a>&lt; Request, Response &gt;::~<a class="el" href="classgrpc_1_1_client_bidi_reactor.html">ClientBidiReactor</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a88c169b6b8d9ea5579d152a86b74582c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a88c169b6b8d9ea5579d152a86b74582c">&#9670;&nbsp;</a></span>AddHold()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Request , class Response &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classgrpc_1_1_client_bidi_reactor.html">grpc::ClientBidiReactor</a>&lt; Request, Response &gt;::AddHold </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Holds are needed if (and only if) this stream has operations that take place on it after StartCall but from outside one of the reactions (OnReadDone, etc). </p>
<p>This is <em>not</em> a common use of the streaming API.</p>
<p>Holds must be added before calling StartCall. If a stream still has a hold in place, its resources will not be destroyed even if the status has already come in from the wire and there are currently no active callbacks outstanding. Similarly, the stream will not call OnDone if there are still holds on it.</p>
<p>For example, if a StartRead or StartWrite operation is going to be initiated from elsewhere in the application, the application should call AddHold or AddMultipleHolds before StartCall. If there is going to be, for example, a read-flow and a write-flow taking place outside the reactions, then call AddMultipleHolds(2) before StartCall. When the application knows that it won't issue any more read operations (such as when a read comes back as not ok), it should issue a <a class="el" href="classgrpc_1_1_client_bidi_reactor.html#af6c5597375914b59db43aabef3c92ddb">RemoveHold()</a>. It should also call <a class="el" href="classgrpc_1_1_client_bidi_reactor.html#af6c5597375914b59db43aabef3c92ddb">RemoveHold()</a> again after it does StartWriteLast or StartWritesDone that indicates that there will be no more write ops. The number of RemoveHold calls must match the total number of AddHold calls plus the number of holds added by AddMultipleHolds. The argument to AddMultipleHolds must be positive. </p>

</div>
</div>
<a id="a890e44bcd297489ae49c77d0d6c8cc31"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a890e44bcd297489ae49c77d0d6c8cc31">&#9670;&nbsp;</a></span>AddMultipleHolds()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Request , class Response &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classgrpc_1_1_client_bidi_reactor.html">grpc::ClientBidiReactor</a>&lt; Request, Response &gt;::AddMultipleHolds </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>holds</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="af38b5c2d3a3737a8ba5940624872e569"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af38b5c2d3a3737a8ba5940624872e569">&#9670;&nbsp;</a></span>OnDone()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Request , class Response &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classgrpc_1_1_client_bidi_reactor.html">grpc::ClientBidiReactor</a>&lt; Request, Response &gt;::OnDone </td>
          <td>(</td>
          <td class="paramtype">const ::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> &amp;&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Notifies the application that all operations associated with this RPC have completed and all Holds have been removed. </p>
<p>OnDone provides the RPC status outcome for both successful and failed RPCs and will be called in all cases. If it is not called, it indicates an application-level problem (like failure to remove a hold).</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">s</td><td>The status outcome of this RPC </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ad77148d32093f38daeb755e820b70c61"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad77148d32093f38daeb755e820b70c61">&#9670;&nbsp;</a></span>OnReadDone()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Request , class Response &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void <a class="el" href="classgrpc_1_1_client_bidi_reactor.html">grpc::ClientBidiReactor</a>&lt; Request, Response &gt;::OnReadDone </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Notifies the application that a StartRead operation completed. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">ok</td><td>Was it successful? If false, no new read/write operation will succeed, and any further Start* should not be called. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ad37f6df922b0bf95c789fa853d8cf265"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad37f6df922b0bf95c789fa853d8cf265">&#9670;&nbsp;</a></span>OnReadInitialMetadataDone()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Request , class Response &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void <a class="el" href="classgrpc_1_1_client_bidi_reactor.html">grpc::ClientBidiReactor</a>&lt; Request, Response &gt;::OnReadInitialMetadataDone </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Notifies the application that a read of initial metadata from the server is done. </p>
<p>If the application chooses not to implement this method, it can assume that the initial metadata has been read before the first call of OnReadDone or OnDone.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">ok</td><td>Was the initial metadata read successfully? If false, no new read/write operation will succeed, and any further Start* operations should not be called. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ad7673b2c6cfb2dbb77655ef6fee6ebc7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad7673b2c6cfb2dbb77655ef6fee6ebc7">&#9670;&nbsp;</a></span>OnWriteDone()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Request , class Response &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void <a class="el" href="classgrpc_1_1_client_bidi_reactor.html">grpc::ClientBidiReactor</a>&lt; Request, Response &gt;::OnWriteDone </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Notifies the application that a StartWrite or StartWriteLast operation completed. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">ok</td><td>Was it successful? If false, no new read/write operation will succeed, and any further Start* should not be called. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="af17ed4c88facea059373383897c2f120"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af17ed4c88facea059373383897c2f120">&#9670;&nbsp;</a></span>OnWritesDoneDone()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Request , class Response &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void <a class="el" href="classgrpc_1_1_client_bidi_reactor.html">grpc::ClientBidiReactor</a>&lt; Request, Response &gt;::OnWritesDoneDone </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Notifies the application that a StartWritesDone operation completed. </p>
<p>Note that this is only used on explicit StartWritesDone operations and not for those that are implicitly invoked as part of a StartWriteLast.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">ok</td><td>Was it successful? If false, the application will later see the failure reflected as a bad status in OnDone and no further Start* should be called. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="af6c5597375914b59db43aabef3c92ddb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af6c5597375914b59db43aabef3c92ddb">&#9670;&nbsp;</a></span>RemoveHold()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Request , class Response &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classgrpc_1_1_client_bidi_reactor.html">grpc::ClientBidiReactor</a>&lt; Request, Response &gt;::RemoveHold </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a56f0665e201a621d5bfa5b1bf3db4654"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a56f0665e201a621d5bfa5b1bf3db4654">&#9670;&nbsp;</a></span>StartCall()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Request , class Response &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classgrpc_1_1_client_bidi_reactor.html">grpc::ClientBidiReactor</a>&lt; Request, Response &gt;::StartCall </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Activate the RPC and initiate any reads or writes that have been Start'ed before this call. </p>
<p>All streaming RPCs issued by the client MUST have StartCall invoked on them (even if they are canceled) as this call is the activation of their lifecycle. </p>

</div>
</div>
<a id="a511f4e83af63f9569f361a79e9586dce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a511f4e83af63f9569f361a79e9586dce">&#9670;&nbsp;</a></span>StartRead()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Request , class Response &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classgrpc_1_1_client_bidi_reactor.html">grpc::ClientBidiReactor</a>&lt; Request, Response &gt;::StartRead </td>
          <td>(</td>
          <td class="paramtype">Response *&#160;</td>
          <td class="paramname"><em>resp</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Initiate a read operation (or post it for later initiation if StartCall has not yet been invoked). </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[out]</td><td class="paramname">resp</td><td>Where to eventually store the read message. Valid when the library calls OnReadDone </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a3c14129661af38610185a006bbb7eca9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3c14129661af38610185a006bbb7eca9">&#9670;&nbsp;</a></span>StartWrite() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Request , class Response &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classgrpc_1_1_client_bidi_reactor.html">grpc::ClientBidiReactor</a>&lt; Request, Response &gt;::StartWrite </td>
          <td>(</td>
          <td class="paramtype">const Request *&#160;</td>
          <td class="paramname"><em>req</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Initiate a write operation (or post it for later initiation if StartCall has not yet been invoked). </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">req</td><td>The message to be written. The library does not take ownership but the caller must ensure that the message is not deleted or modified until OnWriteDone is called. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a3aaca1812914a82e582446ba4e0a9f92"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3aaca1812914a82e582446ba4e0a9f92">&#9670;&nbsp;</a></span>StartWrite() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Request , class Response &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classgrpc_1_1_client_bidi_reactor.html">grpc::ClientBidiReactor</a>&lt; Request, Response &gt;::StartWrite </td>
          <td>(</td>
          <td class="paramtype">const Request *&#160;</td>
          <td class="paramname"><em>req</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">::<a class="el" href="classgrpc_1_1_write_options.html">grpc::WriteOptions</a>&#160;</td>
          <td class="paramname"><em>options</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Initiate/post a write operation with specified options. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">req</td><td>The message to be written. The library does not take ownership but the caller must ensure that the message is not deleted or modified until OnWriteDone is called. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">options</td><td>The <a class="el" href="classgrpc_1_1_write_options.html" title="Per-message write options.">WriteOptions</a> to use for writing this message </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a8709dc8bd207e577a6cffdce441612cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8709dc8bd207e577a6cffdce441612cb">&#9670;&nbsp;</a></span>StartWriteLast()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Request , class Response &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classgrpc_1_1_client_bidi_reactor.html">grpc::ClientBidiReactor</a>&lt; Request, Response &gt;::StartWriteLast </td>
          <td>(</td>
          <td class="paramtype">const Request *&#160;</td>
          <td class="paramname"><em>req</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">::<a class="el" href="classgrpc_1_1_write_options.html">grpc::WriteOptions</a>&#160;</td>
          <td class="paramname"><em>options</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Initiate/post a write operation with specified options and an indication that this is the last write (like StartWrite and StartWritesDone, merged). </p>
<p>Note that calling this means that no more calls to StartWrite, StartWriteLast, or StartWritesDone are allowed.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">req</td><td>The message to be written. The library does not take ownership but the caller must ensure that the message is not deleted or modified until OnWriteDone is called. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">options</td><td>The <a class="el" href="classgrpc_1_1_write_options.html" title="Per-message write options.">WriteOptions</a> to use for writing this message </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a43f605fb458e7545718e595868eba3c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a43f605fb458e7545718e595868eba3c8">&#9670;&nbsp;</a></span>StartWritesDone()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Request , class Response &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classgrpc_1_1_client_bidi_reactor.html">grpc::ClientBidiReactor</a>&lt; Request, Response &gt;::StartWritesDone </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Indicate that the RPC will have no more write operations. </p>
<p>This can only be issued once for a given RPC. This is not required or allowed if StartWriteLast is used since that already has the same implication. Note that calling this means that no more calls to StartWrite, StartWriteLast, or StartWritesDone are allowed. </p>

</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="a9e889e5582a185bc4aee78b7abaf8108"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9e889e5582a185bc4aee78b7abaf8108">&#9670;&nbsp;</a></span>ClientCallbackReaderWriter&lt; Request, Response &gt;</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class Request , class Response &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">friend class <a class="el" href="classgrpc_1_1_client_callback_reader_writer.html">ClientCallbackReaderWriter</a>&lt; Request, Response &gt;</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/grpcpp/impl/codegen/<a class="el" href="impl_2codegen_2client__callback_8h_source.html">client_callback.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 3 2021 19:17:24 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>