carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271
							<!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::ClientAsyncResponseReaderInterface&lt; 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_response_reader_interface.html">ClientAsyncResponseReaderInterface</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::ClientAsyncResponseReaderInterface&lt; R &gt; Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>An interface relevant for async client side unary RPCs (which send one request message to a server and receive one response message).  
 <a href="classgrpc__impl_1_1_client_async_response_reader_interface.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="impl_2codegen_2async__unary__call__impl_8h_source.html">async_unary_call_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:a2594e53a26e44765261f60ca2ba42918"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_client_async_response_reader_interface.html#a2594e53a26e44765261f60ca2ba42918">~ClientAsyncResponseReaderInterface</a> ()</td></tr>
<tr class="separator:a2594e53a26e44765261f60ca2ba42918"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aabf97823fef06189ee30e985d52adb2c"><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_response_reader_interface.html#aabf97823fef06189ee30e985d52adb2c">StartCall</a> ()=0</td></tr>
<tr class="memdesc:aabf97823fef06189ee30e985d52adb2c"><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_1_client_async_response_reader_interface.html#aabf97823fef06189ee30e985d52adb2c">More...</a><br /></td></tr>
<tr class="separator:aabf97823fef06189ee30e985d52adb2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90e74f22d09cb7208f7db43715419cdc"><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_response_reader_interface.html#a90e74f22d09cb7208f7db43715419cdc">ReadInitialMetadata</a> (void *tag)=0</td></tr>
<tr class="memdesc:a90e74f22d09cb7208f7db43715419cdc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request notification of the reading of initial metadata.  <a href="classgrpc__impl_1_1_client_async_response_reader_interface.html#a90e74f22d09cb7208f7db43715419cdc">More...</a><br /></td></tr>
<tr class="separator:a90e74f22d09cb7208f7db43715419cdc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc377e1ee7d8ce7f33bef95efb5c8d4a"><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_response_reader_interface.html#adc377e1ee7d8ce7f33bef95efb5c8d4a">Finish</a> (R *msg, ::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> *status, void *tag)=0</td></tr>
<tr class="memdesc:adc377e1ee7d8ce7f33bef95efb5c8d4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request to receive the server's response <em>msg</em> and final <em>status</em> for the call, and to notify <em>tag</em> on this call's completion queue when finished.  <a href="classgrpc__impl_1_1_client_async_response_reader_interface.html#adc377e1ee7d8ce7f33bef95efb5c8d4a">More...</a><br /></td></tr>
<tr class="separator:adc377e1ee7d8ce7f33bef95efb5c8d4a"><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 R&gt;<br />
class grpc_impl::ClientAsyncResponseReaderInterface&lt; R &gt;</h3>

<p>An interface relevant for async client side unary RPCs (which send one request message to a server and receive one response message). </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a2594e53a26e44765261f60ca2ba42918"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2594e53a26e44765261f60ca2ba42918">&#9670;&nbsp;</a></span>~ClientAsyncResponseReaderInterface()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class R &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classgrpc__impl_1_1_client_async_response_reader_interface.html">grpc_impl::ClientAsyncResponseReaderInterface</a>&lt; R &gt;::~<a class="el" href="classgrpc__impl_1_1_client_async_response_reader_interface.html">ClientAsyncResponseReaderInterface</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="adc377e1ee7d8ce7f33bef95efb5c8d4a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adc377e1ee7d8ce7f33bef95efb5c8d4a">&#9670;&nbsp;</a></span>Finish()</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;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_response_reader_interface.html">grpc_impl::ClientAsyncResponseReaderInterface</a>&lt; R &gt;::Finish </td>
          <td>(</td>
          <td class="paramtype">R *&#160;</td>
          <td class="paramname"><em>msg</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> *&#160;</td>
          <td class="paramname"><em>status</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>tag</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">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Request to receive the server's response <em>msg</em> and final <em>status</em> for the call, and to notify <em>tag</em> on this call's completion queue when finished. </p>
<p>This function will return when either:</p><ul>
<li>when the server's response message and status have been received.</li>
<li>when the server has returned a non-OK status (no message expected in this case).</li>
<li>when the call failed for some reason and the library generated a non-OK status.</li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>Tag identifying this request. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">status</td><td>To be updated with the operation status. </td></tr>
    <tr><td class="paramdir">[out]</td><td class="paramname">msg</td><td>To be filled in with the server's response message. </td></tr>
  </table>
  </dd>
</dl>

<p>Implemented in <a class="el" href="classgrpc__impl_1_1_client_async_response_reader.html#a1960d246611c7f9dd4db4735c1fe0651">grpc_impl::ClientAsyncResponseReader&lt; R &gt;</a>.</p>

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

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;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_response_reader_interface.html">grpc_impl::ClientAsyncResponseReaderInterface</a>&lt; R &gt;::ReadInitialMetadata </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>Request notification of the reading of initial metadata. </p>
<p>Completion will be notified by <em>tag</em> on the associated completion queue. This call is optional, but if it is used, it cannot be used concurrently with or after the <em>Finish</em> method.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>Tag identifying this request. </td></tr>
  </table>
  </dd>
</dl>

<p>Implemented in <a class="el" href="classgrpc__impl_1_1_client_async_response_reader.html#a4102ef0829887ee75600c630d268ada8">grpc_impl::ClientAsyncResponseReader&lt; R &gt;</a>.</p>

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

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;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_response_reader_interface.html">grpc_impl::ClientAsyncResponseReaderInterface</a>&lt; R &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">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>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. </p>

<p>Implemented in <a class="el" href="classgrpc__impl_1_1_client_async_response_reader.html#aeb1dfcf053efe021834167a6d4b617da">grpc_impl::ClientAsyncResponseReader&lt; 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__unary__call__impl_8h_source.html">async_unary_call_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>