classgrpc__impl_1_1_client_async_writer.html 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.13"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>GRPC C++: grpc_impl::ClientAsyncWriter&lt; W &gt; Class Template Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">GRPC C++
  25. &#160;<span id="projectnumber">1.23.0</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.13 -->
  34. <script type="text/javascript">
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36. </script>
  37. <script type="text/javascript" src="menudata.js"></script>
  38. <script type="text/javascript" src="menu.js"></script>
  39. <script type="text/javascript">
  40. $(function() {
  41. initMenu('',true,false,'search.php','Search');
  42. $(document).ready(function() { init_search(); });
  43. });
  44. </script>
  45. <div id="main-nav"></div>
  46. <!-- window showing the filter options -->
  47. <div id="MSearchSelectWindow"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. onkeydown="return searchBox.OnSearchSelectKey(event)">
  51. </div>
  52. <!-- iframe showing the search results (closed by default) -->
  53. <div id="MSearchResultsWindow">
  54. <iframe src="javascript:void(0)" frameborder="0"
  55. name="MSearchResults" id="MSearchResults">
  56. </iframe>
  57. </div>
  58. <div id="nav-path" class="navpath">
  59. <ul>
  60. <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>
  61. </div>
  62. </div><!-- top -->
  63. <div class="header">
  64. <div class="summary">
  65. <a href="#pub-methods">Public Member Functions</a> &#124;
  66. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  67. <a href="#friends">Friends</a> </div>
  68. <div class="headertitle">
  69. <div class="title">grpc_impl::ClientAsyncWriter&lt; W &gt; Class Template Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div>
  70. </div><!--header-->
  71. <div class="contents">
  72. <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>.
  73. <a href="classgrpc__impl_1_1_client_async_writer.html#details">More...</a></p>
  74. <p><code>#include &lt;<a class="el" href="impl_2codegen_2async__stream__impl_8h_source.html">async_stream_impl.h</a>&gt;</code></p>
  75. <table class="memberdecls">
  76. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  77. Public Member Functions</h2></td></tr>
  78. <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>
  79. <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="#a99315f6eee1607910abf47f6cb9e908d">More...</a><br /></td></tr>
  80. <tr class="separator:a99315f6eee1607910abf47f6cb9e908d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <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>
  82. <tr class="memdesc:ad59395cea7267f21fe0b52679e552609"><td class="mdescLeft">&#160;</td><td class="mdescRight">See the <em>ClientAsyncStreamingInterface.ReadInitialMetadata</em> method for semantics. <a href="#ad59395cea7267f21fe0b52679e552609">More...</a><br /></td></tr>
  83. <tr class="separator:ad59395cea7267f21fe0b52679e552609"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <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>
  85. <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="#a5a91f21f3a4023afc737bebfc14e7b54">More...</a><br /></td></tr>
  86. <tr class="separator:a5a91f21f3a4023afc737bebfc14e7b54"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <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>
  88. <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="#a2d4f04e9e37879524463f9c5e3c88365">More...</a><br /></td></tr>
  89. <tr class="separator:a2d4f04e9e37879524463f9c5e3c88365"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <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>
  91. <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="#a209864790dbafefb34f6ad00871e296c">More...</a><br /></td></tr>
  92. <tr class="separator:a209864790dbafefb34f6ad00871e296c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <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>
  94. <tr class="memdesc:aa4bc2b8ec0b9b18a16b1ef12129a8979"><td class="mdescLeft">&#160;</td><td class="mdescRight">See the <em>ClientAsyncStreamingInterface.Finish</em> method for semantics. <a href="#aa4bc2b8ec0b9b18a16b1ef12129a8979">More...</a><br /></td></tr>
  95. <tr class="separator:aa4bc2b8ec0b9b18a16b1ef12129a8979"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <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>
  97. <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>
  98. <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>
  99. <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>
  100. <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>
  101. <tr class="separator:abb8fa894b94e09e9a2b6ca261a20ec8b inherit pub_methods_classgrpc__impl_1_1internal_1_1_async_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <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>
  103. <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>
  104. <tr class="separator:a05ab1b1965def7cec0324fe27b0fa67f inherit pub_methods_classgrpc__impl_1_1internal_1_1_async_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. </table><table class="memberdecls">
  106. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  107. Static Public Member Functions</h2></td></tr>
  108. <tr class="memitem:afc5ba7b29f19a3fa248ada6ba9bbafa6"><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#afc5ba7b29f19a3fa248ada6ba9bbafa6">operator delete</a> (void *ptr, std::size_t size)</td></tr>
  109. <tr class="separator:afc5ba7b29f19a3fa248ada6ba9bbafa6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <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>
  111. <tr class="separator:a7cbee51c158a82cf92a214cf0240bc35"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. </table><table class="memberdecls">
  113. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  114. Friends</h2></td></tr>
  115. <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>
  116. <tr class="separator:a5e0a3f0980c67fa6bdb0affd2659b8d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. </table>
  118. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  119. <div class="textblock"><h3>template&lt;class W&gt;<br />
  120. class grpc_impl::ClientAsyncWriter&lt; W &gt;</h3>
  121. <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>
  122. </div><h2 class="groupheader">Member Function Documentation</h2>
  123. <a id="aa4bc2b8ec0b9b18a16b1ef12129a8979"></a>
  124. <h2 class="memtitle"><span class="permalink"><a href="#aa4bc2b8ec0b9b18a16b1ef12129a8979">&#9670;&nbsp;</a></span>Finish()</h2>
  125. <div class="memitem">
  126. <div class="memproto">
  127. <div class="memtemplate">
  128. template&lt;class W &gt; </div>
  129. <table class="mlabels">
  130. <tr>
  131. <td class="mlabels-left">
  132. <table class="memname">
  133. <tr>
  134. <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>
  135. <td>(</td>
  136. <td class="paramtype">::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> *&#160;</td>
  137. <td class="paramname"><em>status</em>, </td>
  138. </tr>
  139. <tr>
  140. <td class="paramkey"></td>
  141. <td></td>
  142. <td class="paramtype">void *&#160;</td>
  143. <td class="paramname"><em>tag</em>&#160;</td>
  144. </tr>
  145. <tr>
  146. <td></td>
  147. <td>)</td>
  148. <td></td><td></td>
  149. </tr>
  150. </table>
  151. </td>
  152. <td class="mlabels-right">
  153. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  154. </tr>
  155. </table>
  156. </div><div class="memdoc">
  157. <p>See the <em>ClientAsyncStreamingInterface.Finish</em> method for semantics. </p>
  158. <p>Side effect:</p><ul>
  159. <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>
  160. <li>attempts to fill in the <em>response</em> parameter passed to this class's constructor with the server's response message. </li>
  161. </ul>
  162. <p>Implements <a class="el" href="classgrpc__impl_1_1internal_1_1_client_async_streaming_interface.html#a5a711906e79c3ed81754390d855b0d17">grpc_impl::internal::ClientAsyncStreamingInterface</a>.</p>
  163. </div>
  164. </div>
  165. <a id="afc5ba7b29f19a3fa248ada6ba9bbafa6"></a>
  166. <h2 class="memtitle"><span class="permalink"><a href="#afc5ba7b29f19a3fa248ada6ba9bbafa6">&#9670;&nbsp;</a></span>operator delete() <span class="overload">[1/2]</span></h2>
  167. <div class="memitem">
  168. <div class="memproto">
  169. <div class="memtemplate">
  170. template&lt;class W &gt; </div>
  171. <table class="mlabels">
  172. <tr>
  173. <td class="mlabels-left">
  174. <table class="memname">
  175. <tr>
  176. <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>
  177. <td>(</td>
  178. <td class="paramtype">void *&#160;</td>
  179. <td class="paramname"><em>ptr</em>, </td>
  180. </tr>
  181. <tr>
  182. <td class="paramkey"></td>
  183. <td></td>
  184. <td class="paramtype">std::size_t&#160;</td>
  185. <td class="paramname"><em>size</em>&#160;</td>
  186. </tr>
  187. <tr>
  188. <td></td>
  189. <td>)</td>
  190. <td></td><td></td>
  191. </tr>
  192. </table>
  193. </td>
  194. <td class="mlabels-right">
  195. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  196. </tr>
  197. </table>
  198. </div><div class="memdoc">
  199. </div>
  200. </div>
  201. <a id="a7cbee51c158a82cf92a214cf0240bc35"></a>
  202. <h2 class="memtitle"><span class="permalink"><a href="#a7cbee51c158a82cf92a214cf0240bc35">&#9670;&nbsp;</a></span>operator delete() <span class="overload">[2/2]</span></h2>
  203. <div class="memitem">
  204. <div class="memproto">
  205. <div class="memtemplate">
  206. template&lt;class W &gt; </div>
  207. <table class="mlabels">
  208. <tr>
  209. <td class="mlabels-left">
  210. <table class="memname">
  211. <tr>
  212. <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>
  213. <td>(</td>
  214. <td class="paramtype">void *&#160;</td>
  215. <td class="paramname">, </td>
  216. </tr>
  217. <tr>
  218. <td class="paramkey"></td>
  219. <td></td>
  220. <td class="paramtype">void *&#160;</td>
  221. <td class="paramname">&#160;</td>
  222. </tr>
  223. <tr>
  224. <td></td>
  225. <td>)</td>
  226. <td></td><td></td>
  227. </tr>
  228. </table>
  229. </td>
  230. <td class="mlabels-right">
  231. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  232. </tr>
  233. </table>
  234. </div><div class="memdoc">
  235. </div>
  236. </div>
  237. <a id="ad59395cea7267f21fe0b52679e552609"></a>
  238. <h2 class="memtitle"><span class="permalink"><a href="#ad59395cea7267f21fe0b52679e552609">&#9670;&nbsp;</a></span>ReadInitialMetadata()</h2>
  239. <div class="memitem">
  240. <div class="memproto">
  241. <div class="memtemplate">
  242. template&lt;class W &gt; </div>
  243. <table class="mlabels">
  244. <tr>
  245. <td class="mlabels-left">
  246. <table class="memname">
  247. <tr>
  248. <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>
  249. <td>(</td>
  250. <td class="paramtype">void *&#160;</td>
  251. <td class="paramname"><em>tag</em></td><td>)</td>
  252. <td></td>
  253. </tr>
  254. </table>
  255. </td>
  256. <td class="mlabels-right">
  257. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  258. </tr>
  259. </table>
  260. </div><div class="memdoc">
  261. <p>See the <em>ClientAsyncStreamingInterface.ReadInitialMetadata</em> method for semantics. </p>
  262. <p>Side effect:</p><ul>
  263. <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>
  264. </ul>
  265. <p>Implements <a class="el" href="classgrpc__impl_1_1internal_1_1_client_async_streaming_interface.html#aba046f399b355f6c67160d0c5779add4">grpc_impl::internal::ClientAsyncStreamingInterface</a>.</p>
  266. </div>
  267. </div>
  268. <a id="a99315f6eee1607910abf47f6cb9e908d"></a>
  269. <h2 class="memtitle"><span class="permalink"><a href="#a99315f6eee1607910abf47f6cb9e908d">&#9670;&nbsp;</a></span>StartCall()</h2>
  270. <div class="memitem">
  271. <div class="memproto">
  272. <div class="memtemplate">
  273. template&lt;class W &gt; </div>
  274. <table class="mlabels">
  275. <tr>
  276. <td class="mlabels-left">
  277. <table class="memname">
  278. <tr>
  279. <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>
  280. <td>(</td>
  281. <td class="paramtype">void *&#160;</td>
  282. <td class="paramname"><em>tag</em></td><td>)</td>
  283. <td></td>
  284. </tr>
  285. </table>
  286. </td>
  287. <td class="mlabels-right">
  288. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  289. </tr>
  290. </table>
  291. </div><div class="memdoc">
  292. <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>
  293. <p>Implements <a class="el" href="classgrpc__impl_1_1internal_1_1_client_async_streaming_interface.html#a2958b0c18e9713d33b5e32efa1ebb8d6">grpc_impl::internal::ClientAsyncStreamingInterface</a>.</p>
  294. </div>
  295. </div>
  296. <a id="a5a91f21f3a4023afc737bebfc14e7b54"></a>
  297. <h2 class="memtitle"><span class="permalink"><a href="#a5a91f21f3a4023afc737bebfc14e7b54">&#9670;&nbsp;</a></span>Write() <span class="overload">[1/2]</span></h2>
  298. <div class="memitem">
  299. <div class="memproto">
  300. <div class="memtemplate">
  301. template&lt;class W &gt; </div>
  302. <table class="mlabels">
  303. <tr>
  304. <td class="mlabels-left">
  305. <table class="memname">
  306. <tr>
  307. <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>
  308. <td>(</td>
  309. <td class="paramtype">const W &amp;&#160;</td>
  310. <td class="paramname"><em>msg</em>, </td>
  311. </tr>
  312. <tr>
  313. <td class="paramkey"></td>
  314. <td></td>
  315. <td class="paramtype">void *&#160;</td>
  316. <td class="paramname"><em>tag</em>&#160;</td>
  317. </tr>
  318. <tr>
  319. <td></td>
  320. <td>)</td>
  321. <td></td><td></td>
  322. </tr>
  323. </table>
  324. </td>
  325. <td class="mlabels-right">
  326. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  327. </tr>
  328. </table>
  329. </div><div class="memdoc">
  330. <p>Request the writing of <em>msg</em> with identifying tag <em>tag</em>. </p>
  331. <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>
  332. <p>gRPC doesn't take ownership or a reference to <em>msg</em>, so it is safe to to deallocate once Write returns.</p>
  333. <dl class="params"><dt>Parameters</dt><dd>
  334. <table class="params">
  335. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>The message to be written. </td></tr>
  336. <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The tag identifying the operation. </td></tr>
  337. </table>
  338. </dd>
  339. </dl>
  340. <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>
  341. </div>
  342. </div>
  343. <a id="a2d4f04e9e37879524463f9c5e3c88365"></a>
  344. <h2 class="memtitle"><span class="permalink"><a href="#a2d4f04e9e37879524463f9c5e3c88365">&#9670;&nbsp;</a></span>Write() <span class="overload">[2/2]</span></h2>
  345. <div class="memitem">
  346. <div class="memproto">
  347. <div class="memtemplate">
  348. template&lt;class W &gt; </div>
  349. <table class="mlabels">
  350. <tr>
  351. <td class="mlabels-left">
  352. <table class="memname">
  353. <tr>
  354. <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>
  355. <td>(</td>
  356. <td class="paramtype">const W &amp;&#160;</td>
  357. <td class="paramname"><em>msg</em>, </td>
  358. </tr>
  359. <tr>
  360. <td class="paramkey"></td>
  361. <td></td>
  362. <td class="paramtype">::<a class="el" href="classgrpc_1_1_write_options.html">grpc::WriteOptions</a>&#160;</td>
  363. <td class="paramname"><em>options</em>, </td>
  364. </tr>
  365. <tr>
  366. <td class="paramkey"></td>
  367. <td></td>
  368. <td class="paramtype">void *&#160;</td>
  369. <td class="paramname"><em>tag</em>&#160;</td>
  370. </tr>
  371. <tr>
  372. <td></td>
  373. <td>)</td>
  374. <td></td><td></td>
  375. </tr>
  376. </table>
  377. </td>
  378. <td class="mlabels-right">
  379. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  380. </tr>
  381. </table>
  382. </div><div class="memdoc">
  383. <p>Request the writing of <em>msg</em> using WriteOptions <em>options</em> with identifying tag <em>tag</em>. </p>
  384. <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>
  385. <p>gRPC doesn't take ownership or a reference to <em>msg</em>, so it is safe to to deallocate once Write returns.</p>
  386. <dl class="params"><dt>Parameters</dt><dd>
  387. <table class="params">
  388. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>The message to be written. </td></tr>
  389. <tr><td class="paramdir">[in]</td><td class="paramname">options</td><td>The WriteOptions to be used to write this message. </td></tr>
  390. <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The tag identifying the operation. </td></tr>
  391. </table>
  392. </dd>
  393. </dl>
  394. <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>
  395. </div>
  396. </div>
  397. <a id="a209864790dbafefb34f6ad00871e296c"></a>
  398. <h2 class="memtitle"><span class="permalink"><a href="#a209864790dbafefb34f6ad00871e296c">&#9670;&nbsp;</a></span>WritesDone()</h2>
  399. <div class="memitem">
  400. <div class="memproto">
  401. <div class="memtemplate">
  402. template&lt;class W &gt; </div>
  403. <table class="mlabels">
  404. <tr>
  405. <td class="mlabels-left">
  406. <table class="memname">
  407. <tr>
  408. <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>
  409. <td>(</td>
  410. <td class="paramtype">void *&#160;</td>
  411. <td class="paramname"><em>tag</em></td><td>)</td>
  412. <td></td>
  413. </tr>
  414. </table>
  415. </td>
  416. <td class="mlabels-right">
  417. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  418. </tr>
  419. </table>
  420. </div><div class="memdoc">
  421. <p>Signal the client is done with the writes (half-close the client stream). </p>
  422. <p>Thread-safe with respect to <em>AsyncReaderInterface::Read</em> </p>
  423. <dl class="params"><dt>Parameters</dt><dd>
  424. <table class="params">
  425. <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The tag identifying the operation. </td></tr>
  426. </table>
  427. </dd>
  428. </dl>
  429. <p>Implements <a class="el" href="classgrpc__impl_1_1_client_async_writer_interface.html#aff9c2dbe2b6775111e48ba5341b5929a">grpc_impl::ClientAsyncWriterInterface&lt; W &gt;</a>.</p>
  430. </div>
  431. </div>
  432. <h2 class="groupheader">Friends And Related Function Documentation</h2>
  433. <a id="a5e0a3f0980c67fa6bdb0affd2659b8d2"></a>
  434. <h2 class="memtitle"><span class="permalink"><a href="#a5e0a3f0980c67fa6bdb0affd2659b8d2">&#9670;&nbsp;</a></span>internal::ClientAsyncWriterFactory< W ></h2>
  435. <div class="memitem">
  436. <div class="memproto">
  437. <div class="memtemplate">
  438. template&lt;class W &gt; </div>
  439. <table class="mlabels">
  440. <tr>
  441. <td class="mlabels-left">
  442. <table class="memname">
  443. <tr>
  444. <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>
  445. </tr>
  446. </table>
  447. </td>
  448. <td class="mlabels-right">
  449. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  450. </tr>
  451. </table>
  452. </div><div class="memdoc">
  453. </div>
  454. </div>
  455. <hr/>The documentation for this class was generated from the following file:<ul>
  456. <li>include/grpcpp/impl/codegen/<a class="el" href="impl_2codegen_2async__stream__impl_8h_source.html">async_stream_impl.h</a></li>
  457. </ul>
  458. </div><!-- contents -->
  459. <!-- start footer part -->
  460. <hr class="footer"/><address class="footer"><small>
  461. Generated on Mon Aug 19 2019 12:05:23 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  462. <img class="footer" src="doxygen.png" alt="doxygen"/>
  463. </a> 1.8.13
  464. </small></address>
  465. </body>
  466. </html>