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

505 lines
28 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::ClientAsyncWriter&lt; W &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_async_writer.html">ClientAsyncWriter</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<div class="title">grpc_impl::ClientAsyncWriter&lt; W &gt; Class Template Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Async API on the client side for doing client-streaming RPCs, where the outgoing message stream going to the server contains messages of type <em>W</em>.
<a href="classgrpc__impl_1_1_client_async_writer.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="impl_2codegen_2async__stream__impl_8h_source.html">async_stream_impl.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:a99315f6eee1607910abf47f6cb9e908d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_client_async_writer.html#a99315f6eee1607910abf47f6cb9e908d">StartCall</a> (void *tag) override</td></tr>
<tr class="memdesc:a99315f6eee1607910abf47f6cb9e908d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start the call that was set up by the constructor, but only if the constructor was invoked through the "Prepare" API which doesn't actually start the call. <a href="classgrpc__impl_1_1_client_async_writer.html#a99315f6eee1607910abf47f6cb9e908d">More...</a><br /></td></tr>
<tr class="separator:a99315f6eee1607910abf47f6cb9e908d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad59395cea7267f21fe0b52679e552609"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_client_async_writer.html#ad59395cea7267f21fe0b52679e552609">ReadInitialMetadata</a> (void *tag) override</td></tr>
<tr class="memdesc:ad59395cea7267f21fe0b52679e552609"><td class="mdescLeft">&#160;</td><td class="mdescRight">See the <em>ClientAsyncStreamingInterface.ReadInitialMetadata</em> method for semantics. <a href="classgrpc__impl_1_1_client_async_writer.html#ad59395cea7267f21fe0b52679e552609">More...</a><br /></td></tr>
<tr class="separator:ad59395cea7267f21fe0b52679e552609"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5a91f21f3a4023afc737bebfc14e7b54"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_client_async_writer.html#a5a91f21f3a4023afc737bebfc14e7b54">Write</a> (const W &amp;msg, void *tag) override</td></tr>
<tr class="memdesc:a5a91f21f3a4023afc737bebfc14e7b54"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request the writing of <em>msg</em> with identifying tag <em>tag</em>. <a href="classgrpc__impl_1_1_client_async_writer.html#a5a91f21f3a4023afc737bebfc14e7b54">More...</a><br /></td></tr>
<tr class="separator:a5a91f21f3a4023afc737bebfc14e7b54"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d4f04e9e37879524463f9c5e3c88365"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_client_async_writer.html#a2d4f04e9e37879524463f9c5e3c88365">Write</a> (const W &amp;msg, ::<a class="el" href="classgrpc_1_1_write_options.html">grpc::WriteOptions</a> options, void *tag) override</td></tr>
<tr class="memdesc:a2d4f04e9e37879524463f9c5e3c88365"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request the writing of <em>msg</em> using WriteOptions <em>options</em> with identifying tag <em>tag</em>. <a href="classgrpc__impl_1_1_client_async_writer.html#a2d4f04e9e37879524463f9c5e3c88365">More...</a><br /></td></tr>
<tr class="separator:a2d4f04e9e37879524463f9c5e3c88365"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a209864790dbafefb34f6ad00871e296c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_client_async_writer.html#a209864790dbafefb34f6ad00871e296c">WritesDone</a> (void *tag) override</td></tr>
<tr class="memdesc:a209864790dbafefb34f6ad00871e296c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signal the client is done with the writes (half-close the client stream). <a href="classgrpc__impl_1_1_client_async_writer.html#a209864790dbafefb34f6ad00871e296c">More...</a><br /></td></tr>
<tr class="separator:a209864790dbafefb34f6ad00871e296c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa4bc2b8ec0b9b18a16b1ef12129a8979"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_client_async_writer.html#aa4bc2b8ec0b9b18a16b1ef12129a8979">Finish</a> (::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> *status, void *tag) override</td></tr>
<tr class="memdesc:aa4bc2b8ec0b9b18a16b1ef12129a8979"><td class="mdescLeft">&#160;</td><td class="mdescRight">See the <em>ClientAsyncStreamingInterface.Finish</em> method for semantics. <a href="classgrpc__impl_1_1_client_async_writer.html#aa4bc2b8ec0b9b18a16b1ef12129a8979">More...</a><br /></td></tr>
<tr class="separator:aa4bc2b8ec0b9b18a16b1ef12129a8979"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classgrpc__impl_1_1internal_1_1_client_async_streaming_interface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc__impl_1_1internal_1_1_client_async_streaming_interface')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc__impl_1_1internal_1_1_client_async_streaming_interface.html">grpc_impl::internal::ClientAsyncStreamingInterface</a></td></tr>
<tr class="memitem:a45466a53cfeccac4ac36a8e889c6b826 inherit pub_methods_classgrpc__impl_1_1internal_1_1_client_async_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_async_streaming_interface.html#a45466a53cfeccac4ac36a8e889c6b826">~ClientAsyncStreamingInterface</a> ()</td></tr>
<tr class="separator:a45466a53cfeccac4ac36a8e889c6b826 inherit pub_methods_classgrpc__impl_1_1internal_1_1_client_async_streaming_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classgrpc__impl_1_1internal_1_1_async_writer_interface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc__impl_1_1internal_1_1_async_writer_interface')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc__impl_1_1internal_1_1_async_writer_interface.html">grpc_impl::internal::AsyncWriterInterface&lt; W &gt;</a></td></tr>
<tr class="memitem:abb8fa894b94e09e9a2b6ca261a20ec8b inherit pub_methods_classgrpc__impl_1_1internal_1_1_async_writer_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_async_writer_interface.html#abb8fa894b94e09e9a2b6ca261a20ec8b">~AsyncWriterInterface</a> ()</td></tr>
<tr class="separator:abb8fa894b94e09e9a2b6ca261a20ec8b inherit pub_methods_classgrpc__impl_1_1internal_1_1_async_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a05ab1b1965def7cec0324fe27b0fa67f inherit pub_methods_classgrpc__impl_1_1internal_1_1_async_writer_interface"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1internal_1_1_async_writer_interface.html#a05ab1b1965def7cec0324fe27b0fa67f">WriteLast</a> (const W &amp;msg, ::<a class="el" href="classgrpc_1_1_write_options.html">grpc::WriteOptions</a> options, void *tag)</td></tr>
<tr class="memdesc:a05ab1b1965def7cec0324fe27b0fa67f inherit pub_methods_classgrpc__impl_1_1internal_1_1_async_writer_interface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request the writing of <em>msg</em> and coalesce it with the writing of trailing metadata, using WriteOptions <em>options</em> with identifying tag <em>tag</em>. <a href="classgrpc__impl_1_1internal_1_1_async_writer_interface.html#a05ab1b1965def7cec0324fe27b0fa67f">More...</a><br /></td></tr>
<tr class="separator:a05ab1b1965def7cec0324fe27b0fa67f inherit pub_methods_classgrpc__impl_1_1internal_1_1_async_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a8b1622a1c96bb92b2b9e23031e791b47"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_client_async_writer.html#a8b1622a1c96bb92b2b9e23031e791b47">operator delete</a> (void *, std::size_t size)</td></tr>
<tr class="separator:a8b1622a1c96bb92b2b9e23031e791b47"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7cbee51c158a82cf92a214cf0240bc35"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_client_async_writer.html#a7cbee51c158a82cf92a214cf0240bc35">operator delete</a> (void *, void *)</td></tr>
<tr class="separator:a7cbee51c158a82cf92a214cf0240bc35"><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:a5e0a3f0980c67fa6bdb0affd2659b8d2"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc__impl_1_1_client_async_writer.html#a5e0a3f0980c67fa6bdb0affd2659b8d2">internal::ClientAsyncWriterFactory&lt; W &gt;</a></td></tr>
<tr class="separator:a5e0a3f0980c67fa6bdb0affd2659b8d2"><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&gt;<br />
class grpc_impl::ClientAsyncWriter&lt; W &gt;</h3>
<p>Async API on the client side for doing client-streaming RPCs, where the outgoing message stream going to the server contains messages of type <em>W</em>. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="aa4bc2b8ec0b9b18a16b1ef12129a8979"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa4bc2b8ec0b9b18a16b1ef12129a8979">&#9670;&nbsp;</a></span>Finish()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W &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_async_writer.html">grpc_impl::ClientAsyncWriter</a>&lt; W &gt;::Finish </td>
<td>(</td>
<td class="paramtype">::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> *&#160;</td>
<td class="paramname"><em>status</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>tag</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 class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>See the <em>ClientAsyncStreamingInterface.Finish</em> 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 initial and trailing metadata received from the server.</li>
<li>attempts to fill in the <em>response</em> parameter passed to this class's constructor with the server's response message. </li>
</ul>
<p>Implements <a class="el" href="classgrpc__impl_1_1internal_1_1_client_async_streaming_interface.html#a5a711906e79c3ed81754390d855b0d17">grpc_impl::internal::ClientAsyncStreamingInterface</a>.</p>
</div>
</div>
<a id="a8b1622a1c96bb92b2b9e23031e791b47"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8b1622a1c96bb92b2b9e23031e791b47">&#9670;&nbsp;</a></span>operator delete() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void <a class="el" href="classgrpc__impl_1_1_client_async_writer.html">grpc_impl::ClientAsyncWriter</a>&lt; W &gt;::operator delete </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::size_t&#160;</td>
<td class="paramname"><em>size</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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a7cbee51c158a82cf92a214cf0240bc35"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7cbee51c158a82cf92a214cf0240bc35">&#9670;&nbsp;</a></span>operator delete() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W &gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void <a class="el" href="classgrpc__impl_1_1_client_async_writer.html">grpc_impl::ClientAsyncWriter</a>&lt; W &gt;::operator delete </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname">&#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">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ad59395cea7267f21fe0b52679e552609"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad59395cea7267f21fe0b52679e552609">&#9670;&nbsp;</a></span>ReadInitialMetadata()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W &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_async_writer.html">grpc_impl::ClientAsyncWriter</a>&lt; W &gt;::ReadInitialMetadata </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>tag</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>ClientAsyncStreamingInterface.ReadInitialMetadata</em> method for semantics. </p>
<p>Side effect:</p><ul>
<li>upon receiving initial metadata from the server, 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, and the calling code can access the received metadata 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>. </li>
</ul>
<p>Implements <a class="el" href="classgrpc__impl_1_1internal_1_1_client_async_streaming_interface.html#aba046f399b355f6c67160d0c5779add4">grpc_impl::internal::ClientAsyncStreamingInterface</a>.</p>
</div>
</div>
<a id="a99315f6eee1607910abf47f6cb9e908d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a99315f6eee1607910abf47f6cb9e908d">&#9670;&nbsp;</a></span>StartCall()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W &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_async_writer.html">grpc_impl::ClientAsyncWriter</a>&lt; W &gt;::StartCall </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>tag</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>Start the call that was set up by the constructor, but only if the constructor was invoked through the "Prepare" API which doesn't actually start the call. </p>
<p>Implements <a class="el" href="classgrpc__impl_1_1internal_1_1_client_async_streaming_interface.html#a2958b0c18e9713d33b5e32efa1ebb8d6">grpc_impl::internal::ClientAsyncStreamingInterface</a>.</p>
</div>
</div>
<a id="a2d4f04e9e37879524463f9c5e3c88365"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d4f04e9e37879524463f9c5e3c88365">&#9670;&nbsp;</a></span>Write() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W &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_async_writer.html">grpc_impl::ClientAsyncWriter</a>&lt; W &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>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>tag</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 class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Request the writing of <em>msg</em> using WriteOptions <em>options</em> with identifying tag <em>tag</em>. </p>
<p>Only one write may be outstanding at any given time. This means that after calling Write, one must wait to receive <em>tag</em> from the completion queue BEFORE calling Write again. WriteOptions <em>options</em> is used to set the write options of this message. This is thread-safe with respect to <em>AsyncReaderInterface::Read</em> </p>
<p>gRPC doesn't take ownership or a reference to <em>msg</em>, so it is safe to to deallocate once Write returns.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>The message to be written. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">options</td><td>The WriteOptions to be used to write this message. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The tag identifying the operation. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classgrpc__impl_1_1internal_1_1_async_writer_interface.html#a8b008c0685622ae659f8a57fb508bb5b">grpc_impl::internal::AsyncWriterInterface&lt; W &gt;</a>.</p>
</div>
</div>
<a id="a5a91f21f3a4023afc737bebfc14e7b54"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5a91f21f3a4023afc737bebfc14e7b54">&#9670;&nbsp;</a></span>Write() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W &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_async_writer.html">grpc_impl::ClientAsyncWriter</a>&lt; W &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">void *&#160;</td>
<td class="paramname"><em>tag</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 class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Request the writing of <em>msg</em> with identifying tag <em>tag</em>. </p>
<p>Only one write may be outstanding at any given time. This means that after calling Write, one must wait to receive <em>tag</em> from the completion queue BEFORE calling Write again. This is thread-safe with respect to <em>AsyncReaderInterface::Read</em> </p>
<p>gRPC doesn't take ownership or a reference to <em>msg</em>, so it is safe to to deallocate once Write returns.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>The message to be written. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The tag identifying the operation. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classgrpc__impl_1_1internal_1_1_async_writer_interface.html#a9c4e4ce91569478b6656992a35c5ece1">grpc_impl::internal::AsyncWriterInterface&lt; W &gt;</a>.</p>
</div>
</div>
<a id="a209864790dbafefb34f6ad00871e296c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a209864790dbafefb34f6ad00871e296c">&#9670;&nbsp;</a></span>WritesDone()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W &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_async_writer.html">grpc_impl::ClientAsyncWriter</a>&lt; W &gt;::WritesDone </td>
<td>(</td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>tag</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>Signal the client is done with the writes (half-close the client stream). </p>
<p>Thread-safe with respect to <em>AsyncReaderInterface::Read</em> </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The tag identifying the operation. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classgrpc__impl_1_1_client_async_writer_interface.html#aff9c2dbe2b6775111e48ba5341b5929a">grpc_impl::ClientAsyncWriterInterface&lt; W &gt;</a>.</p>
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="a5e0a3f0980c67fa6bdb0affd2659b8d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5e0a3f0980c67fa6bdb0affd2659b8d2">&#9670;&nbsp;</a></span>internal::ClientAsyncWriterFactory&lt; W &gt;</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class W &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_async_writer_factory.html">internal::ClientAsyncWriterFactory</a>&lt; W &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 file:<ul>
<li>include/grpcpp/impl/codegen/<a class="el" href="impl_2codegen_2async__stream__impl_8h_source.html">async_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