carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281
							<!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.16"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GRPC C++: grpc_impl::ClientReader&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.30.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.16 -->
<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_reader.html">ClientReader</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_impl::ClientReader&lt; R &gt; Class Template Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Synchronous (blocking) client-side API for doing server-streaming RPCs, where the stream of messages coming from the server has messages of type <em>R</em>.  
 <a href="classgrpc__impl_1_1_client_reader.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="grpcpp_2impl_2codegen_2channel__interface_8h_source.html">channel_interface.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:af7916c43398e295545bcb6371e8c4fb8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_client_reader.html#af7916c43398e295545bcb6371e8c4fb8">WaitForInitialMetadata</a> () override</td></tr>
<tr class="memdesc:af7916c43398e295545bcb6371e8c4fb8"><td class="mdescLeft">&#160;</td><td class="mdescRight">See the <em>ClientStreamingInterface.WaitForInitialMetadata</em> method for semantics.  <a href="classgrpc__impl_1_1_client_reader.html#af7916c43398e295545bcb6371e8c4fb8">More...</a><br /></td></tr>
<tr class="separator:af7916c43398e295545bcb6371e8c4fb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa2772fa3e484bbc83ab6825a3b689952"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_client_reader.html#aa2772fa3e484bbc83ab6825a3b689952">NextMessageSize</a> (uint32_t *sz) override</td></tr>
<tr class="memdesc:aa2772fa3e484bbc83ab6825a3b689952"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get an upper bound on the next message size available for reading on this stream.  <a href="classgrpc__impl_1_1_client_reader.html#aa2772fa3e484bbc83ab6825a3b689952">More...</a><br /></td></tr>
<tr class="separator:aa2772fa3e484bbc83ab6825a3b689952"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d655dd582352d5bd8ee6201b387b73a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_client_reader.html#a4d655dd582352d5bd8ee6201b387b73a">Read</a> (R *msg) override</td></tr>
<tr class="memdesc:a4d655dd582352d5bd8ee6201b387b73a"><td class="mdescLeft">&#160;</td><td class="mdescRight">See the <em>ReaderInterface.Read</em> method for semantics.  <a href="classgrpc__impl_1_1_client_reader.html#a4d655dd582352d5bd8ee6201b387b73a">More...</a><br /></td></tr>
<tr class="separator:a4d655dd582352d5bd8ee6201b387b73a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad25e039528c87a8078177b3a1a15fc99"><td class="memItemLeft" align="right" valign="top">::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_client_reader.html#ad25e039528c87a8078177b3a1a15fc99">Finish</a> () override</td></tr>
<tr class="memdesc:ad25e039528c87a8078177b3a1a15fc99"><td class="mdescLeft">&#160;</td><td class="mdescRight">See the <em>ClientStreamingInterface.Finish</em> method for semantics.  <a href="classgrpc__impl_1_1_client_reader.html#ad25e039528c87a8078177b3a1a15fc99">More...</a><br /></td></tr>
<tr class="separator:ad25e039528c87a8078177b3a1a15fc99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classgrpc__impl_1_1internal_1_1_client_streaming_interface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc__impl_1_1internal_1_1_client_streaming_interface')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc__impl_1_1internal_1_1_client_streaming_interface.html">grpc_impl::internal::ClientStreamingInterface</a></td></tr>
<tr class="memitem:a86e635c500f5cf517090a90b267d7e9b inherit pub_methods_classgrpc__impl_1_1internal_1_1_client_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_streaming_interface.html#a86e635c500f5cf517090a90b267d7e9b">~ClientStreamingInterface</a> ()</td></tr>
<tr class="separator:a86e635c500f5cf517090a90b267d7e9b inherit pub_methods_classgrpc__impl_1_1internal_1_1_client_streaming_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classgrpc__impl_1_1internal_1_1_reader_interface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc__impl_1_1internal_1_1_reader_interface')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc__impl_1_1internal_1_1_reader_interface.html">grpc_impl::internal::ReaderInterface&lt; R &gt;</a></td></tr>
<tr class="memitem:ae4f2b89ea092e964b6e7dd9f220138fb inherit pub_methods_classgrpc__impl_1_1internal_1_1_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_reader_interface.html#ae4f2b89ea092e964b6e7dd9f220138fb">~ReaderInterface</a> ()</td></tr>
<tr class="separator:ae4f2b89ea092e964b6e7dd9f220138fb inherit pub_methods_classgrpc__impl_1_1internal_1_1_reader_interface"><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:a4dbee7d0176cbb647eeff3fced646bfb"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_client_reader.html#a4dbee7d0176cbb647eeff3fced646bfb">internal::ClientReaderFactory&lt; R &gt;</a></td></tr>
<tr class="separator:a4dbee7d0176cbb647eeff3fced646bfb"><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::ClientReader&lt; R &gt;</h3>

<p>Synchronous (blocking) client-side API for doing server-streaming RPCs, where the stream of messages coming from the server has messages of type <em>R</em>. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ad25e039528c87a8078177b3a1a15fc99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad25e039528c87a8078177b3a1a15fc99">&#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">::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> <a class="el" href="classgrpc__impl_1_1_client_reader.html">grpc_impl::ClientReader</a>&lt; R &gt;::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">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>See the <em>ClientStreamingInterface.Finish</em> method for semantics. </p>
<p>Side effect: The <em><a class="el" href="classgrpc__impl_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 metadata received from the server. </p>

<p>Implements <a class="el" href="classgrpc__impl_1_1internal_1_1_client_streaming_interface.html#a010a28c3d4428fae26c5e7f6866e502c">grpc_impl::internal::ClientStreamingInterface</a>.</p>

</div>
</div>
<a id="aa2772fa3e484bbc83ab6825a3b689952"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa2772fa3e484bbc83ab6825a3b689952">&#9670;&nbsp;</a></span>NextMessageSize()</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">bool <a class="el" href="classgrpc__impl_1_1_client_reader.html">grpc_impl::ClientReader</a>&lt; R &gt;::NextMessageSize </td>
          <td>(</td>
          <td class="paramtype">uint32_t *&#160;</td>
          <td class="paramname"><em>sz</em></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 class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Get an upper bound on the next message size available for reading on this stream. </p>

<p>Implements <a class="el" href="classgrpc__impl_1_1internal_1_1_reader_interface.html#acb8defa36c3981335a4de3b3a77fc890">grpc_impl::internal::ReaderInterface&lt; R &gt;</a>.</p>

</div>
</div>
<a id="a4d655dd582352d5bd8ee6201b387b73a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d655dd582352d5bd8ee6201b387b73a">&#9670;&nbsp;</a></span>Read()</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">bool <a class="el" href="classgrpc__impl_1_1_client_reader.html">grpc_impl::ClientReader</a>&lt; R &gt;::Read </td>
          <td>(</td>
          <td class="paramtype">R *&#160;</td>
          <td class="paramname"><em>msg</em></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 class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>See the <em>ReaderInterface.Read</em> method for semantics. </p>
<p>Side effect: This also receives initial metadata from the server, if not already received (if initial metadata is received, it can be then accessed through the <em><a class="el" href="classgrpc__impl_1_1_client_context.html" title="A ClientContext allows the person implementing a service client to:">ClientContext</a></em> associated with this call). </p>

<p>Implements <a class="el" href="classgrpc__impl_1_1internal_1_1_reader_interface.html#a005a2778e6005e25555dd0fdeb2db1a7">grpc_impl::internal::ReaderInterface&lt; R &gt;</a>.</p>

</div>
</div>
<a id="af7916c43398e295545bcb6371e8c4fb8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af7916c43398e295545bcb6371e8c4fb8">&#9670;&nbsp;</a></span>WaitForInitialMetadata()</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">void <a class="el" href="classgrpc__impl_1_1_client_reader.html">grpc_impl::ClientReader</a>&lt; R &gt;::WaitForInitialMetadata </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">override</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>See the <em>ClientStreamingInterface.WaitForInitialMetadata</em> method for semantics. </p>
<p>Once complete, the initial metadata read from the server will be accessible through the <em><a class="el" href="classgrpc__impl_1_1_client_context.html" title="A ClientContext allows the person implementing a service client to:">ClientContext</a></em> used to construct this object. </p>
<p>status ignored</p>

<p>Implements <a class="el" href="classgrpc__impl_1_1_client_reader_interface.html#abb7e5badfc96904b3ce5932a0706a075">grpc_impl::ClientReaderInterface&lt; R &gt;</a>.</p>

</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="a4dbee7d0176cbb647eeff3fced646bfb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4dbee7d0176cbb647eeff3fced646bfb">&#9670;&nbsp;</a></span>internal::ClientReaderFactory&lt; R &gt;</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">friend class <a class="el" href="classgrpc__impl_1_1internal_1_1_client_reader_factory.html">internal::ClientReaderFactory</a>&lt; R &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 files:<ul>
<li>include/grpcpp/impl/codegen/<a class="el" href="grpcpp_2impl_2codegen_2channel__interface_8h_source.html">channel_interface.h</a></li>
<li>include/grpcpp/impl/codegen/<a class="el" href="impl_2codegen_2sync__stream__impl_8h_source.html">sync_stream_impl.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Jun 30 2020 18:16: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.16
</small></address>
</body>
</html>