carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GRPC C++: grpc::internal::ClientAsyncStreamingInterface Class 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" />
<script type="text/javascript"> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-60127042-1', 'auto'); ga('send', 'pageview'); </script></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.13.0-dev</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</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="namespacegrpc_1_1internal.html">internal</a></li><li class="navelem"><a class="el" href="classgrpc_1_1internal_1_1_client_async_streaming_interface.html">ClientAsyncStreamingInterface</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::internal::ClientAsyncStreamingInterface Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>Common interface for all client side asynchronous streaming.  
 <a href="classgrpc_1_1internal_1_1_client_async_streaming_interface.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="grpcpp_2impl_2codegen_2async__stream_8h_source.html">async_stream.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:a5691ad84f8160a3eb10131f1f5de4708"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_client_async_streaming_interface.html#a5691ad84f8160a3eb10131f1f5de4708">~ClientAsyncStreamingInterface</a> ()</td></tr>
<tr class="separator:a5691ad84f8160a3eb10131f1f5de4708"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2bd65338b34000980fa048911c577637"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_client_async_streaming_interface.html#a2bd65338b34000980fa048911c577637">StartCall</a> (void *tag)=0</td></tr>
<tr class="memdesc:a2bd65338b34000980fa048911c577637"><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="#a2bd65338b34000980fa048911c577637">More...</a><br /></td></tr>
<tr class="separator:a2bd65338b34000980fa048911c577637"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab5a35e289028ac2aaf062572ba6d567d"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_client_async_streaming_interface.html#ab5a35e289028ac2aaf062572ba6d567d">ReadInitialMetadata</a> (void *tag)=0</td></tr>
<tr class="memdesc:ab5a35e289028ac2aaf062572ba6d567d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request notification of the reading of the initial metadata.  <a href="#ab5a35e289028ac2aaf062572ba6d567d">More...</a><br /></td></tr>
<tr class="separator:ab5a35e289028ac2aaf062572ba6d567d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad83ce06905fe819ae1e6b5b85e437642"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_client_async_streaming_interface.html#ad83ce06905fe819ae1e6b5b85e437642">Finish</a> (<a class="el" href="classgrpc_1_1_status.html">Status</a> *status, void *tag)=0</td></tr>
<tr class="memdesc:ad83ce06905fe819ae1e6b5b85e437642"><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="#ad83ce06905fe819ae1e6b5b85e437642">More...</a><br /></td></tr>
<tr class="separator:ad83ce06905fe819ae1e6b5b85e437642"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Common interface for all client side asynchronous streaming. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a5691ad84f8160a3eb10131f1f5de4708"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5691ad84f8160a3eb10131f1f5de4708">&#9670;&nbsp;</a></span>~ClientAsyncStreamingInterface()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual grpc::internal::ClientAsyncStreamingInterface::~ClientAsyncStreamingInterface </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="ad83ce06905fe819ae1e6b5b85e437642"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad83ce06905fe819ae1e6b5b85e437642">&#9670;&nbsp;</a></span>Finish()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void grpc::internal::ClientAsyncStreamingInterface::Finish </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classgrpc_1_1_status.html">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>Indicate that the stream is to be finished and request notification for when the call has been ended. </p>
<p>Should not be used concurrently with other operations.</p>
<p>It is appropriate to call this method when both:</p><ul>
<li>the client side has no more message to send (this can be declared implicitly by calling this method, or explicitly through an earlier call to the <em>WritesDone</em> method of the class in use, e.g. <em><a class="el" href="classgrpc_1_1_client_async_writer_interface.html#a488d42d85f8e34902401e013572ff822" title="Signal the client is done with the writes (half-close the client stream). ">ClientAsyncWriterInterface::WritesDone</a></em> or <em><a class="el" href="classgrpc_1_1_client_async_reader_writer_interface.html#a878193880df68ab969b697f1fcd7dbc3" title="Signal the client is done with the writes (half-close the client stream). ">ClientAsyncReaderWriterInterface::WritesDone</a></em>).</li>
<li>there are no more messages to be received from the server (this can be known implicitly by the calling code, or explicitly from an earlier call to <em><a class="el" href="classgrpc_1_1internal_1_1_async_reader_interface.html#adf87c602036d69158950b7299d0aae70" title="Read a message of type R into msg. ">AsyncReaderInterface::Read</a></em> that yielded a failed result, e.g. cq-&gt;Next(&amp;read_tag, &amp;ok) filled in 'ok' with 'false').</li>
</ul>
<p>This function will return when either:</p><ul>
<li>all incoming messages have been read and the server has returned a status.</li>
<li>the server has returned a non-OK status.</li>
<li>the call failed for some reason and the library generated a status.</li>
</ul>
<p>Note that implementations of this method attempt to receive initial metadata from the server if initial metadata hasn't yet been received.</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>
    <tr><td class="paramdir">[out]</td><td class="paramname">status</td><td>To be updated with the operation status. </td></tr>
  </table>
  </dd>
</dl>

<p>Implemented in <a class="el" href="classgrpc_1_1_client_async_reader_writer.html#a292fae35382e0f3c919840689cfb2358">grpc::ClientAsyncReaderWriter&lt; W, R &gt;</a>, <a class="el" href="classgrpc_1_1_client_async_writer.html#a0bcd44cd9303fae2ab19bfed22766be3">grpc::ClientAsyncWriter&lt; W &gt;</a>, and <a class="el" href="classgrpc_1_1_client_async_reader.html#ad727cbb34fa9dd996d4f58234213953d">grpc::ClientAsyncReader&lt; R &gt;</a>.</p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void grpc::internal::ClientAsyncStreamingInterface::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 the 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><a class="el" href="classgrpc_1_1internal_1_1_async_reader_interface.html#adf87c602036d69158950b7299d0aae70" title="Read a message of type R into msg. ">AsyncReaderInterface::Read</a></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_1_1_client_async_reader_writer.html#a169a2eb8bedfd7281b37c79fdd307eb2">grpc::ClientAsyncReaderWriter&lt; W, R &gt;</a>, <a class="el" href="classgrpc_1_1_client_async_writer.html#a02f613eaaed4177f1682da3f5eebbdeb">grpc::ClientAsyncWriter&lt; W &gt;</a>, and <a class="el" href="classgrpc_1_1_client_async_reader.html#a66e76c15ee94cf0c2892def9041210d1">grpc::ClientAsyncReader&lt; R &gt;</a>.</p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void grpc::internal::ClientAsyncStreamingInterface::StartCall </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>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_1_1_client_async_reader_writer.html#ae72f68c240ac2cbca98b524e723bd05b">grpc::ClientAsyncReaderWriter&lt; W, R &gt;</a>, <a class="el" href="classgrpc_1_1_client_async_writer.html#a42b8329c9a8bf18528fee8a3776db3d6">grpc::ClientAsyncWriter&lt; W &gt;</a>, and <a class="el" href="classgrpc_1_1_client_async_reader.html#a1afd3a30d2d6182ebf13941089b683d6">grpc::ClientAsyncReader&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="grpcpp_2impl_2codegen_2async__stream_8h_source.html">async_stream.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue May 15 2018 17:01:01 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>