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

210 lines
11 KiB
HTML
Raw Permalink 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::internal::ReaderInterface&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.64.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="namespacegrpc_1_1internal.html">internal</a></li><li class="navelem"><a class="el" href="classgrpc_1_1internal_1_1_reader_interface.html">ReaderInterface</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::ReaderInterface&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 that yields a sequence of messages of type <em>R</em>.
<a href="classgrpc_1_1internal_1_1_reader_interface.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="grpcpp_2support_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:ad1d28c0720937a61b0f7952d3add7bba"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_reader_interface.html#ad1d28c0720937a61b0f7952d3add7bba">~ReaderInterface</a> ()</td></tr>
<tr class="separator:ad1d28c0720937a61b0f7952d3add7bba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad3216783fae57e614181e28df9435f33"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_reader_interface.html#ad3216783fae57e614181e28df9435f33">NextMessageSize</a> (uint32_t *sz)=0</td></tr>
<tr class="memdesc:ad3216783fae57e614181e28df9435f33"><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_1_1internal_1_1_reader_interface.html#ad3216783fae57e614181e28df9435f33">More...</a><br /></td></tr>
<tr class="separator:ad3216783fae57e614181e28df9435f33"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adfb50ace59b4b9666a46548d3f732ee8"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_reader_interface.html#adfb50ace59b4b9666a46548d3f732ee8">Read</a> (R *msg)=0</td></tr>
<tr class="memdesc:adfb50ace59b4b9666a46548d3f732ee8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Block to read a message and parse to <em>msg</em>. <a href="classgrpc_1_1internal_1_1_reader_interface.html#adfb50ace59b4b9666a46548d3f732ee8">More...</a><br /></td></tr>
<tr class="separator:adfb50ace59b4b9666a46548d3f732ee8"><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::internal::ReaderInterface&lt; R &gt;</h3>
<p>An interface that yields a sequence of messages of type <em>R</em>. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ad1d28c0720937a61b0f7952d3add7bba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad1d28c0720937a61b0f7952d3add7bba">&#9670;&nbsp;</a></span>~ReaderInterface()</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_1_1internal_1_1_reader_interface.html">grpc::internal::ReaderInterface</a>&lt; R &gt;::~<a class="el" href="classgrpc_1_1internal_1_1_reader_interface.html">ReaderInterface</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="ad3216783fae57e614181e28df9435f33"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad3216783fae57e614181e28df9435f33">&#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">virtual bool <a class="el" href="classgrpc_1_1internal_1_1_reader_interface.html">grpc::internal::ReaderInterface</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">pure 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>Implemented in <a class="el" href="classgrpc_1_1_server_split_streamer.html#afd992b3d73e9da01b4267b443fe39176">grpc::ServerSplitStreamer&lt; RequestType, ResponseType &gt;</a>, <a class="el" href="classgrpc_1_1_server_unary_streamer.html#a0a7c2fec34b451dbd6f2924321b4dc51">grpc::ServerUnaryStreamer&lt; RequestType, ResponseType &gt;</a>, and <a class="el" href="classgrpc_1_1_server_reader_writer.html#a647d6e58b7720113db0357d1c4b7750f">grpc::ServerReaderWriter&lt; W, R &gt;</a>.</p>
</div>
</div>
<a id="adfb50ace59b4b9666a46548d3f732ee8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adfb50ace59b4b9666a46548d3f732ee8">&#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">virtual bool <a class="el" href="classgrpc_1_1internal_1_1_reader_interface.html">grpc::internal::ReaderInterface</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">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Block to read a message and parse to <em>msg</em>. </p>
<p>Returns <em>true</em> on success. This is thread-safe with respect to <em>Write</em> or \WritesDone methods on the same stream. It should not be called concurrently with another <em>Read</em> on the same stream as the order of delivery will not be defined.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">msg</td><td>The read message.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><em>false</em> when there will be no more incoming messages, either because the other side has called <em>WritesDone()</em> or the stream has failed (or been cancelled). </dd></dl>
<p>Implemented in <a class="el" href="classgrpc_1_1_server_split_streamer.html#a0f408957f9071bb498b6f4a948ef6113">grpc::ServerSplitStreamer&lt; RequestType, ResponseType &gt;</a>, <a class="el" href="classgrpc_1_1_server_unary_streamer.html#a23294b403e6cb46ab88835e6d3be7491">grpc::ServerUnaryStreamer&lt; RequestType, ResponseType &gt;</a>, and <a class="el" href="classgrpc_1_1_server_reader_writer.html#adc1925f519a8d1dc7b7101d37513774b">grpc::ServerReaderWriter&lt; W, R &gt;</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<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 Fri May 17 2024 01:17: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