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

336 lines
17 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_impl::ClientReaderWriter&lt; W, 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.31.1</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__impl.html">grpc_impl</a></li><li class="navelem"><a class="el" href="classgrpc__impl_1_1_client_reader_writer.html">ClientReaderWriter</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::ClientReaderWriter&lt; W, R &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Synchronous (blocking) client-side API for bi-directional streaming RPCs, where the outgoing message stream coming from the client has messages of type <em>W</em>, and the incoming messages stream coming from the server has messages of type <em>R</em>.
<a href="classgrpc__impl_1_1_client_reader_writer.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:a886356d92a33a962ffe76c4c14e97c29"><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_writer.html#a886356d92a33a962ffe76c4c14e97c29">WaitForInitialMetadata</a> () override</td></tr>
<tr class="memdesc:a886356d92a33a962ffe76c4c14e97c29"><td class="mdescLeft">&#160;</td><td class="mdescRight">Block waiting to read initial metadata from the server. <a href="classgrpc__impl_1_1_client_reader_writer.html#a886356d92a33a962ffe76c4c14e97c29">More...</a><br /></td></tr>
<tr class="separator:a886356d92a33a962ffe76c4c14e97c29"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a11e5995b215db84b18aadaf710768b57"><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_writer.html#a11e5995b215db84b18aadaf710768b57">NextMessageSize</a> (uint32_t *sz) override</td></tr>
<tr class="separator:a11e5995b215db84b18aadaf710768b57"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a81b490710516815442c809eb662a436d"><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_writer.html#a81b490710516815442c809eb662a436d">Read</a> (R *msg) override</td></tr>
<tr class="memdesc:a81b490710516815442c809eb662a436d"><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_writer.html#a81b490710516815442c809eb662a436d">More...</a><br /></td></tr>
<tr class="separator:a81b490710516815442c809eb662a436d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad50a2cc981c1dbef6f53e319d3156a7d"><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_writer.html#ad50a2cc981c1dbef6f53e319d3156a7d">Write</a> (const W &amp;msg, ::<a class="el" href="classgrpc_1_1_write_options.html">grpc::WriteOptions</a> options) override</td></tr>
<tr class="separator:ad50a2cc981c1dbef6f53e319d3156a7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac717ee1b9b2c146d7cdfa435177c7e03"><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_writer.html#ac717ee1b9b2c146d7cdfa435177c7e03">WritesDone</a> () override</td></tr>
<tr class="separator:ac717ee1b9b2c146d7cdfa435177c7e03"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac685735e49e581d5ef7a004e82a1096e"><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_writer.html#ac685735e49e581d5ef7a004e82a1096e">Finish</a> () override</td></tr>
<tr class="memdesc:ac685735e49e581d5ef7a004e82a1096e"><td class="mdescLeft">&#160;</td><td class="mdescRight">See the ClientStreamingInterface.Finish method for semantics. <a href="classgrpc__impl_1_1_client_reader_writer.html#ac685735e49e581d5ef7a004e82a1096e">More...</a><br /></td></tr>
<tr class="separator:ac685735e49e581d5ef7a004e82a1096e"><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:afecda317e553ccff29f57d43166b2d34"><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_writer.html#afecda317e553ccff29f57d43166b2d34">internal::ClientReaderWriterFactory&lt; W, R &gt;</a></td></tr>
<tr class="separator:afecda317e553ccff29f57d43166b2d34"><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 W, class R&gt;<br />
class grpc_impl::ClientReaderWriter&lt; W, R &gt;</h3>
<p>Synchronous (blocking) client-side API for bi-directional streaming RPCs, where the outgoing message stream coming from the client has messages of type <em>W</em>, and the incoming messages stream coming from the server has messages of type <em>R</em>. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ac685735e49e581d5ef7a004e82a1096e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac685735e49e581d5ef7a004e82a1096e">&#9670;&nbsp;</a></span>Finish()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W , 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_writer.html">grpc_impl::ClientReaderWriter</a>&lt; W, 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 ClientStreamingInterface.Finish method for semantics. </p>
<p>Side effect:</p><ul>
<li>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 trailing metadata sent from the server. </li>
</ul>
</div>
</div>
<a id="a11e5995b215db84b18aadaf710768b57"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a11e5995b215db84b18aadaf710768b57">&#9670;&nbsp;</a></span>NextMessageSize()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W , 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_writer.html">grpc_impl::ClientReaderWriter</a>&lt; W, 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="a81b490710516815442c809eb662a436d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a81b490710516815442c809eb662a436d">&#9670;&nbsp;</a></span>Read()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W , 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_writer.html">grpc_impl::ClientReaderWriter</a>&lt; W, 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: Also receives initial metadata if not already received (updates 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 in that case). </p>
</div>
</div>
<a id="a886356d92a33a962ffe76c4c14e97c29"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a886356d92a33a962ffe76c4c14e97c29">&#9670;&nbsp;</a></span>WaitForInitialMetadata()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W , 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_writer.html">grpc_impl::ClientReaderWriter</a>&lt; W, 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>Block waiting to read initial metadata from the server. </p>
<p>This call is optional, but if it is used, it cannot be used concurrently with or after the <em>Finish</em> method.</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>
</div>
</div>
<a id="ad50a2cc981c1dbef6f53e319d3156a7d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad50a2cc981c1dbef6f53e319d3156a7d">&#9670;&nbsp;</a></span>Write()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W , 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_writer.html">grpc_impl::ClientReaderWriter</a>&lt; W, R &gt;::Write </td>
<td>(</td>
<td class="paramtype">const W &amp;&#160;</td>
<td class="paramname"><em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">::<a class="el" href="classgrpc_1_1_write_options.html">grpc::WriteOptions</a>&#160;</td>
<td class="paramname"><em>options</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">inline</span><span class="mlabel">override</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ac717ee1b9b2c146d7cdfa435177c7e03"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac717ee1b9b2c146d7cdfa435177c7e03">&#9670;&nbsp;</a></span>WritesDone()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W , 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_writer.html">grpc_impl::ClientReaderWriter</a>&lt; W, R &gt;::WritesDone </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">
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="afecda317e553ccff29f57d43166b2d34"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afecda317e553ccff29f57d43166b2d34">&#9670;&nbsp;</a></span>internal::ClientReaderWriterFactory&lt; W, R &gt;</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W , 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_writer_factory.html">internal::ClientReaderWriterFactory</a>&lt; W, 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 Aug 18 2020 16:24:48 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