classgrpc_1_1_client_async_writer.html 29 KB

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