natas_hw
/
grpc
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
grpc/cpp/classgrpc_1_1_client_reader...

265 lines
13 KiB
HTML
Raw Blame History

<!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::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.58.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.html">grpc</a></li><li class="navelem"><a class="el" href="classgrpc_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::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_1_1_client_reader.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="grpcpp_2client__context_8h_source.html">client_context.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:a8fd52f51ae4f67cc86c36419acc505c5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_reader.html#a8fd52f51ae4f67cc86c36419acc505c5">WaitForInitialMetadata</a> () override</td></tr>
<tr class="memdesc:a8fd52f51ae4f67cc86c36419acc505c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">See the <em>ClientStreamingInterface.WaitForInitialMetadata</em> method for semantics. <a href="classgrpc_1_1_client_reader.html#a8fd52f51ae4f67cc86c36419acc505c5">More...</a><br /></td></tr>
<tr class="separator:a8fd52f51ae4f67cc86c36419acc505c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae687eb92304da9fb220d95a72c0a4605"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_reader.html#ae687eb92304da9fb220d95a72c0a4605">NextMessageSize</a> (uint32_t *sz) override</td></tr>
<tr class="separator:ae687eb92304da9fb220d95a72c0a4605"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a11b490573c4ea88d5fecc90b712717a8"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_reader.html#a11b490573c4ea88d5fecc90b712717a8">Read</a> (R *msg) override</td></tr>
<tr class="memdesc:a11b490573c4ea88d5fecc90b712717a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">See the <em>ReaderInterface.Read</em> method for semantics. <a href="classgrpc_1_1_client_reader.html#a11b490573c4ea88d5fecc90b712717a8">More...</a><br /></td></tr>
<tr class="separator:a11b490573c4ea88d5fecc90b712717a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ac52b46a70a5c13a30d948c3402dbbf"><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_1_1_client_reader.html#a2ac52b46a70a5c13a30d948c3402dbbf">Finish</a> () override</td></tr>
<tr class="memdesc:a2ac52b46a70a5c13a30d948c3402dbbf"><td class="mdescLeft">&#160;</td><td class="mdescRight">See the <em>ClientStreamingInterface.Finish</em> method for semantics. <a href="classgrpc_1_1_client_reader.html#a2ac52b46a70a5c13a30d948c3402dbbf">More...</a><br /></td></tr>
<tr class="separator:a2ac52b46a70a5c13a30d948c3402dbbf"><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_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::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="a2ac52b46a70a5c13a30d948c3402dbbf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ac52b46a70a5c13a30d948c3402dbbf">&#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_1_1_client_reader.html">grpc::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> </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_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>
</div>
</div>
<a id="ae687eb92304da9fb220d95a72c0a4605"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae687eb92304da9fb220d95a72c0a4605">&#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_1_1_client_reader.html">grpc::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> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a11b490573c4ea88d5fecc90b712717a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a11b490573c4ea88d5fecc90b712717a8">&#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_1_1_client_reader.html">grpc::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> </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_1_1_client_context.html" title="A ClientContext allows the person implementing a service client to:">ClientContext</a></em> associated with this call). </p>
</div>
</div>
<a id="a8fd52f51ae4f67cc86c36419acc505c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8fd52f51ae4f67cc86c36419acc505c5">&#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_1_1_client_reader.html">grpc::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> </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_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>
</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_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/<a class="el" href="grpcpp_2client__context_8h_source.html">client_context.h</a></li>
<li>include/grpcpp/support/<a class="el" href="grpcpp_2support_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 Wed Sep 6 2023 16:09:16 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>
Reference in New Issue View Git Blame Copy Permalink