carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168
							<!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::ClientStreamingInterface 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_streaming_interface.html">ClientStreamingInterface</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::ClientStreamingInterface Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

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

<p><code>#include &lt;<a class="el" href="grpcpp_2impl_2codegen_2sync__stream_8h_source.html">sync_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:ab1a7a2664187d88d0354b69138db7eb1"><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_streaming_interface.html#ab1a7a2664187d88d0354b69138db7eb1">~ClientStreamingInterface</a> ()</td></tr>
<tr class="separator:ab1a7a2664187d88d0354b69138db7eb1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a47321b8c130947bcef5c793329a54619"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classgrpc_1_1_status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_client_streaming_interface.html#a47321b8c130947bcef5c793329a54619">Finish</a> ()=0</td></tr>
<tr class="memdesc:a47321b8c130947bcef5c793329a54619"><td class="mdescLeft">&#160;</td><td class="mdescRight">Block waiting until the stream finishes and a final status of the call is available.  <a href="#a47321b8c130947bcef5c793329a54619">More...</a><br /></td></tr>
<tr class="separator:a47321b8c130947bcef5c793329a54619"><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 synchronous client side streaming. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ab1a7a2664187d88d0354b69138db7eb1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab1a7a2664187d88d0354b69138db7eb1">&#9670;&nbsp;</a></span>~ClientStreamingInterface()</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::ClientStreamingInterface::~ClientStreamingInterface </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="a47321b8c130947bcef5c793329a54619"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a47321b8c130947bcef5c793329a54619">&#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 <a class="el" href="classgrpc_1_1_status.html">Status</a> grpc::internal::ClientStreamingInterface::Finish </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>Block waiting until the stream finishes and a final status of the call is available. </p>
<p>It is appropriate to call this method when both:</p><ul>
<li>the calling code (client-side) has no more message to send (this can be declared implicitly by calling this method, or explicitly through an earlier call to <em>WritesDone</em> method of the class in use, e.g. <em><a class="el" href="classgrpc_1_1_client_writer_interface.html#aff19574252338e9ac1b5446e82ed8ac5" title="Half close writing from the client. ">ClientWriterInterface::WritesDone</a></em> or <em><a class="el" href="classgrpc_1_1_client_reader_writer_interface.html#a52f4e5d5ac7fe0e4995cb337aa0ecfc8" title="Half close writing from the client. ">ClientReaderWriterInterface::WritesDone</a></em>).</li>
<li>there are no more messages to be received from the server (which can be known implicitly, or explicitly from an earlier call to <em><a class="el" href="classgrpc_1_1internal_1_1_reader_interface.html#adfb50ace59b4b9666a46548d3f732ee8" title="Block to read a message and parse to msg. ">ReaderInterface::Read</a></em> that returned "false").</li>
</ul>
<p>This function will return either:</p><ul>
<li>when all incoming messages have been read and the server has returned status.</li>
<li>when the server has returned a non-OK status.</li>
<li>OR when the call failed for some reason and the library generated a status.</li>
</ul>
<p>Return values:</p><ul>
<li><em><a class="el" href="classgrpc_1_1_status.html" title="Did it work? If it didn&#39;t, why? ">Status</a></em> contains the status code, message and details for the call</li>
<li>the <em><a class="el" href="classgrpc_1_1_client_context.html" title="A ClientContext allows the person implementing a service client to: ">ClientContext</a></em> associated with this call is updated with possible trailing metadata sent from the server. </li>
</ul>

<p>Implemented in <a class="el" href="classgrpc_1_1_client_reader_writer.html#a9fe0acda29ba46726d69cedfdb043c79">grpc::ClientReaderWriter&lt; W, R &gt;</a>, <a class="el" href="classgrpc_1_1_client_writer.html#ab6c58e110c289ac0f76ae1fdb8fe24a3">grpc::ClientWriter&lt; W &gt;</a>, and <a class="el" href="classgrpc_1_1_client_reader.html#a29f6f067be74bc657486d8ab232ca809">grpc::ClientReader&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_2sync__stream_8h_source.html">sync_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>