carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173
							<!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_impl::ClientAsyncReaderWriterInterface&lt; W, R &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.32.0</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__impl.html">grpc_impl</a></li><li class="navelem"><a class="el" href="classgrpc__impl_1_1_client_async_reader_writer_interface.html">ClientAsyncReaderWriterInterface</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">grpc_impl::ClientAsyncReaderWriterInterface&lt; W, R &gt; Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>Async client-side interface for bi-directional streaming, where the client-to-server message stream has messages of type <em>W</em>, and the server-to-client message stream has messages of type <em>R</em>.  
 <a href="classgrpc__impl_1_1_client_async_reader_writer_interface.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="impl_2codegen_2async__stream__impl_8h_source.html">async_stream_impl.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:aec02073e13a7d60f903432a995aacac0"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_client_async_reader_writer_interface.html#aec02073e13a7d60f903432a995aacac0">WritesDone</a> (void *tag)=0</td></tr>
<tr class="memdesc:aec02073e13a7d60f903432a995aacac0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signal the client is done with the writes (half-close the client stream).  <a href="classgrpc__impl_1_1_client_async_reader_writer_interface.html#aec02073e13a7d60f903432a995aacac0">More...</a><br /></td></tr>
<tr class="separator:aec02073e13a7d60f903432a995aacac0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classgrpc__impl_1_1internal_1_1_client_async_streaming_interface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc__impl_1_1internal_1_1_client_async_streaming_interface')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc__impl_1_1internal_1_1_client_async_streaming_interface.html">grpc_impl::internal::ClientAsyncStreamingInterface</a></td></tr>
<tr class="memitem:a45466a53cfeccac4ac36a8e889c6b826 inherit pub_methods_classgrpc__impl_1_1internal_1_1_client_async_streaming_interface"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1internal_1_1_client_async_streaming_interface.html#a45466a53cfeccac4ac36a8e889c6b826">~ClientAsyncStreamingInterface</a> ()</td></tr>
<tr class="separator:a45466a53cfeccac4ac36a8e889c6b826 inherit pub_methods_classgrpc__impl_1_1internal_1_1_client_async_streaming_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2958b0c18e9713d33b5e32efa1ebb8d6 inherit pub_methods_classgrpc__impl_1_1internal_1_1_client_async_streaming_interface"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1internal_1_1_client_async_streaming_interface.html#a2958b0c18e9713d33b5e32efa1ebb8d6">StartCall</a> (void *tag)=0</td></tr>
<tr class="memdesc:a2958b0c18e9713d33b5e32efa1ebb8d6 inherit pub_methods_classgrpc__impl_1_1internal_1_1_client_async_streaming_interface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start the call that was set up by the constructor, but only if the constructor was invoked through the "Prepare" API which doesn't actually start the call.  <a href="classgrpc__impl_1_1internal_1_1_client_async_streaming_interface.html#a2958b0c18e9713d33b5e32efa1ebb8d6">More...</a><br /></td></tr>
<tr class="separator:a2958b0c18e9713d33b5e32efa1ebb8d6 inherit pub_methods_classgrpc__impl_1_1internal_1_1_client_async_streaming_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aba046f399b355f6c67160d0c5779add4 inherit pub_methods_classgrpc__impl_1_1internal_1_1_client_async_streaming_interface"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1internal_1_1_client_async_streaming_interface.html#aba046f399b355f6c67160d0c5779add4">ReadInitialMetadata</a> (void *tag)=0</td></tr>
<tr class="memdesc:aba046f399b355f6c67160d0c5779add4 inherit pub_methods_classgrpc__impl_1_1internal_1_1_client_async_streaming_interface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request notification of the reading of the initial metadata.  <a href="classgrpc__impl_1_1internal_1_1_client_async_streaming_interface.html#aba046f399b355f6c67160d0c5779add4">More...</a><br /></td></tr>
<tr class="separator:aba046f399b355f6c67160d0c5779add4 inherit pub_methods_classgrpc__impl_1_1internal_1_1_client_async_streaming_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a711906e79c3ed81754390d855b0d17 inherit pub_methods_classgrpc__impl_1_1internal_1_1_client_async_streaming_interface"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1internal_1_1_client_async_streaming_interface.html#a5a711906e79c3ed81754390d855b0d17">Finish</a> (::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> *status, void *tag)=0</td></tr>
<tr class="memdesc:a5a711906e79c3ed81754390d855b0d17 inherit pub_methods_classgrpc__impl_1_1internal_1_1_client_async_streaming_interface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicate that the stream is to be finished and request notification for when the call has been ended.  <a href="classgrpc__impl_1_1internal_1_1_client_async_streaming_interface.html#a5a711906e79c3ed81754390d855b0d17">More...</a><br /></td></tr>
<tr class="separator:a5a711906e79c3ed81754390d855b0d17 inherit pub_methods_classgrpc__impl_1_1internal_1_1_client_async_streaming_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classgrpc__impl_1_1internal_1_1_async_writer_interface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc__impl_1_1internal_1_1_async_writer_interface')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc__impl_1_1internal_1_1_async_writer_interface.html">grpc_impl::internal::AsyncWriterInterface&lt; W &gt;</a></td></tr>
<tr class="memitem:abb8fa894b94e09e9a2b6ca261a20ec8b inherit pub_methods_classgrpc__impl_1_1internal_1_1_async_writer_interface"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1internal_1_1_async_writer_interface.html#abb8fa894b94e09e9a2b6ca261a20ec8b">~AsyncWriterInterface</a> ()</td></tr>
<tr class="separator:abb8fa894b94e09e9a2b6ca261a20ec8b inherit pub_methods_classgrpc__impl_1_1internal_1_1_async_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c4e4ce91569478b6656992a35c5ece1 inherit pub_methods_classgrpc__impl_1_1internal_1_1_async_writer_interface"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1internal_1_1_async_writer_interface.html#a9c4e4ce91569478b6656992a35c5ece1">Write</a> (const W &amp;msg, void *tag)=0</td></tr>
<tr class="memdesc:a9c4e4ce91569478b6656992a35c5ece1 inherit pub_methods_classgrpc__impl_1_1internal_1_1_async_writer_interface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request the writing of <em>msg</em> with identifying tag <em>tag</em>.  <a href="classgrpc__impl_1_1internal_1_1_async_writer_interface.html#a9c4e4ce91569478b6656992a35c5ece1">More...</a><br /></td></tr>
<tr class="separator:a9c4e4ce91569478b6656992a35c5ece1 inherit pub_methods_classgrpc__impl_1_1internal_1_1_async_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b008c0685622ae659f8a57fb508bb5b inherit pub_methods_classgrpc__impl_1_1internal_1_1_async_writer_interface"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1internal_1_1_async_writer_interface.html#a8b008c0685622ae659f8a57fb508bb5b">Write</a> (const W &amp;msg, ::<a class="el" href="classgrpc_1_1_write_options.html">grpc::WriteOptions</a> options, void *tag)=0</td></tr>
<tr class="memdesc:a8b008c0685622ae659f8a57fb508bb5b inherit pub_methods_classgrpc__impl_1_1internal_1_1_async_writer_interface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request the writing of <em>msg</em> using WriteOptions <em>options</em> with identifying tag <em>tag</em>.  <a href="classgrpc__impl_1_1internal_1_1_async_writer_interface.html#a8b008c0685622ae659f8a57fb508bb5b">More...</a><br /></td></tr>
<tr class="separator:a8b008c0685622ae659f8a57fb508bb5b inherit pub_methods_classgrpc__impl_1_1internal_1_1_async_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a05ab1b1965def7cec0324fe27b0fa67f inherit pub_methods_classgrpc__impl_1_1internal_1_1_async_writer_interface"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1internal_1_1_async_writer_interface.html#a05ab1b1965def7cec0324fe27b0fa67f">WriteLast</a> (const W &amp;msg, ::<a class="el" href="classgrpc_1_1_write_options.html">grpc::WriteOptions</a> options, void *tag)</td></tr>
<tr class="memdesc:a05ab1b1965def7cec0324fe27b0fa67f inherit pub_methods_classgrpc__impl_1_1internal_1_1_async_writer_interface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request the writing of <em>msg</em> and coalesce it with the writing of trailing metadata, using WriteOptions <em>options</em> with identifying tag <em>tag</em>.  <a href="classgrpc__impl_1_1internal_1_1_async_writer_interface.html#a05ab1b1965def7cec0324fe27b0fa67f">More...</a><br /></td></tr>
<tr class="separator:a05ab1b1965def7cec0324fe27b0fa67f inherit pub_methods_classgrpc__impl_1_1internal_1_1_async_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classgrpc__impl_1_1internal_1_1_async_reader_interface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc__impl_1_1internal_1_1_async_reader_interface')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc__impl_1_1internal_1_1_async_reader_interface.html">grpc_impl::internal::AsyncReaderInterface&lt; R &gt;</a></td></tr>
<tr class="memitem:a7034ab602111113f5bf3a8e6e48e2c93 inherit pub_methods_classgrpc__impl_1_1internal_1_1_async_reader_interface"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1internal_1_1_async_reader_interface.html#a7034ab602111113f5bf3a8e6e48e2c93">~AsyncReaderInterface</a> ()</td></tr>
<tr class="separator:a7034ab602111113f5bf3a8e6e48e2c93 inherit pub_methods_classgrpc__impl_1_1internal_1_1_async_reader_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a02645c77e024a39abbd922650cfed5fd inherit pub_methods_classgrpc__impl_1_1internal_1_1_async_reader_interface"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1internal_1_1_async_reader_interface.html#a02645c77e024a39abbd922650cfed5fd">Read</a> (R *msg, void *tag)=0</td></tr>
<tr class="memdesc:a02645c77e024a39abbd922650cfed5fd inherit pub_methods_classgrpc__impl_1_1internal_1_1_async_reader_interface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read a message of type <em>R</em> into <em>msg</em>.  <a href="classgrpc__impl_1_1internal_1_1_async_reader_interface.html#a02645c77e024a39abbd922650cfed5fd">More...</a><br /></td></tr>
<tr class="separator:a02645c77e024a39abbd922650cfed5fd inherit pub_methods_classgrpc__impl_1_1internal_1_1_async_reader_interface"><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 W, class R&gt;<br />
class grpc_impl::ClientAsyncReaderWriterInterface&lt; W, R &gt;</h3>

<p>Async client-side interface for bi-directional streaming, where the client-to-server message stream has messages of type <em>W</em>, and the server-to-client message stream has messages of type <em>R</em>. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="aec02073e13a7d60f903432a995aacac0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec02073e13a7d60f903432a995aacac0">&#9670;&nbsp;</a></span>WritesDone()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W , class R &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void <a class="el" href="classgrpc__impl_1_1_client_async_reader_writer_interface.html">grpc_impl::ClientAsyncReaderWriterInterface</a>&lt; W, R &gt;::WritesDone </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>tag</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Signal the client is done with the writes (half-close the client stream). </p>
<p>Thread-safe with respect to <em>AsyncReaderInterface::Read</em> </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The tag identifying the operation. </td></tr>
  </table>
  </dd>
</dl>

<p>Implemented in <a class="el" href="classgrpc__impl_1_1_client_async_reader_writer.html#ab3ca11e723b3c8d434edc37b0b6c696e">grpc_impl::ClientAsyncReaderWriter&lt; W, R &gt;</a>.</p>

</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_2async__stream__impl_8h_source.html">async_stream_impl.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Sep 12 2020 00:53:57 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>