classgrpc_1_1_client_async_writer.html 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471
  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.6"/>
  7. <title>GRPC C++: grpc::ClientAsyncWriter&lt; W &gt; Class Template Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/search.js"></script>
  13. <script type="text/javascript">
  14. $(document).ready(function() { searchBox.OnSelectItem(0); });
  15. </script>
  16. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr style="height: 56px;">
  24. <td style="padding-left: 0.5em;">
  25. <div id="projectname">GRPC C++
  26. &#160;<span id="projectnumber">1.8.0</span>
  27. </div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.6 -->
  35. <script type="text/javascript">
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. </script>
  38. <div id="navrow1" class="tabs">
  39. <ul class="tablist">
  40. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  41. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  42. <li><a href="modules.html"><span>Modules</span></a></li>
  43. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  44. <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  45. <li><a href="files.html"><span>Files</span></a></li>
  46. <li>
  47. <div id="MSearchBox" class="MSearchBoxInactive">
  48. <span class="left">
  49. <img id="MSearchSelect" src="search/mag_sel.png"
  50. onmouseover="return searchBox.OnSearchSelectShow()"
  51. onmouseout="return searchBox.OnSearchSelectHide()"
  52. alt=""/>
  53. <input type="text" id="MSearchField" value="Search" accesskey="S"
  54. onfocus="searchBox.OnSearchFieldFocus(true)"
  55. onblur="searchBox.OnSearchFieldFocus(false)"
  56. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  57. </span><span class="right">
  58. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  59. </span>
  60. </div>
  61. </li>
  62. </ul>
  63. </div>
  64. <div id="navrow2" class="tabs2">
  65. <ul class="tablist">
  66. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  67. <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
  68. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  69. <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
  70. </ul>
  71. </div>
  72. <!-- window showing the filter options -->
  73. <div id="MSearchSelectWindow"
  74. onmouseover="return searchBox.OnSearchSelectShow()"
  75. onmouseout="return searchBox.OnSearchSelectHide()"
  76. onkeydown="return searchBox.OnSearchSelectKey(event)">
  77. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(12)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  78. <!-- iframe showing the search results (closed by default) -->
  79. <div id="MSearchResultsWindow">
  80. <iframe src="javascript:void(0)" frameborder="0"
  81. name="MSearchResults" id="MSearchResults">
  82. </iframe>
  83. </div>
  84. <div id="nav-path" class="navpath">
  85. <ul>
  86. <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>
  87. </div>
  88. </div><!-- top -->
  89. <div class="header">
  90. <div class="summary">
  91. <a href="#pub-methods">Public Member Functions</a> &#124;
  92. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  93. <a href="#friends">Friends</a> </div>
  94. <div class="headertitle">
  95. <div class="title">grpc::ClientAsyncWriter&lt; W &gt; Class Template Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div>
  96. </div><!--header-->
  97. <div class="contents">
  98. <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>.
  99. <a href="classgrpc_1_1_client_async_writer.html#details">More...</a></p>
  100. <p><code>#include &lt;<a class="el" href="impl_2codegen_2async__stream_8h_source.html">async_stream.h</a>&gt;</code></p>
  101. <table class="memberdecls">
  102. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  103. Public Member Functions</h2></td></tr>
  104. <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>
  105. <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="#a42b8329c9a8bf18528fee8a3776db3d6">More...</a><br/></td></tr>
  106. <tr class="separator:a42b8329c9a8bf18528fee8a3776db3d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <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>
  108. <tr class="memdesc:a02f613eaaed4177f1682da3f5eebbdeb"><td class="mdescLeft">&#160;</td><td class="mdescRight">See the <em>ClientAsyncStreamingInterface.ReadInitialMetadata</em> method for semantics. <a href="#a02f613eaaed4177f1682da3f5eebbdeb">More...</a><br/></td></tr>
  109. <tr class="separator:a02f613eaaed4177f1682da3f5eebbdeb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <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>
  111. <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="#a0e981b6dcce663e655edf305573f2f30">More...</a><br/></td></tr>
  112. <tr class="separator:a0e981b6dcce663e655edf305573f2f30"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:a3f3d8e3e47b7181f7312fd6e3eb32674"><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#a3f3d8e3e47b7181f7312fd6e3eb32674">Write</a> (const W &amp;msg, <a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> options, void *tag) override</td></tr>
  114. <tr class="memdesc:a3f3d8e3e47b7181f7312fd6e3eb32674"><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="#a3f3d8e3e47b7181f7312fd6e3eb32674">More...</a><br/></td></tr>
  115. <tr class="separator:a3f3d8e3e47b7181f7312fd6e3eb32674"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <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>
  117. <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="#ab9fd5cd7dedd73d878a86de84c58e8ff">More...</a><br/></td></tr>
  118. <tr class="separator:ab9fd5cd7dedd73d878a86de84c58e8ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:a0bcd44cd9303fae2ab19bfed22766be3"><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#a0bcd44cd9303fae2ab19bfed22766be3">Finish</a> (<a class="el" href="classgrpc_1_1_status.html">Status</a> *status, void *tag) override</td></tr>
  120. <tr class="memdesc:a0bcd44cd9303fae2ab19bfed22766be3"><td class="mdescLeft">&#160;</td><td class="mdescRight">See the <em>ClientAsyncStreamingInterface.Finish</em> method for semantics. <a href="#a0bcd44cd9303fae2ab19bfed22766be3">More...</a><br/></td></tr>
  121. <tr class="separator:a0bcd44cd9303fae2ab19bfed22766be3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <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>
  123. <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>
  124. <tr class="separator:a5691ad84f8160a3eb10131f1f5de4708 inherit pub_methods_classgrpc_1_1internal_1_1_client_async_streaming_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <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>
  126. <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>
  127. <tr class="separator:a8ad846091252c112c4db0b41965e5a4c inherit pub_methods_classgrpc_1_1internal_1_1_async_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a02565abb7c6b4a7a49c0b29159194b66 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#a02565abb7c6b4a7a49c0b29159194b66">WriteLast</a> (const W &amp;msg, <a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> options, void *tag)</td></tr>
  129. <tr class="memdesc:a02565abb7c6b4a7a49c0b29159194b66 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="#a02565abb7c6b4a7a49c0b29159194b66">More...</a><br/></td></tr>
  130. <tr class="separator:a02565abb7c6b4a7a49c0b29159194b66 inherit pub_methods_classgrpc_1_1internal_1_1_async_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. </table><table class="memberdecls">
  132. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  133. Static Public Member Functions</h2></td></tr>
  134. <tr class="memitem:a38cfef152cb45c498cac2134fc5d263c"><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#a38cfef152cb45c498cac2134fc5d263c">operator delete</a> (void *ptr, std::size_t size)</td></tr>
  135. <tr class="separator:a38cfef152cb45c498cac2134fc5d263c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. </table><table class="memberdecls">
  137. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  138. Friends</h2></td></tr>
  139. <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>
  140. <tr class="separator:a5e0a3f0980c67fa6bdb0affd2659b8d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. </table>
  142. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  143. <div class="textblock"><h3>template&lt;class W&gt;<br/>
  144. class grpc::ClientAsyncWriter&lt; W &gt;</h3>
  145. <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>
  146. </div><h2 class="groupheader">Member Function Documentation</h2>
  147. <a class="anchor" id="a0bcd44cd9303fae2ab19bfed22766be3"></a>
  148. <div class="memitem">
  149. <div class="memproto">
  150. <div class="memtemplate">
  151. template&lt;class W &gt; </div>
  152. <table class="mlabels">
  153. <tr>
  154. <td class="mlabels-left">
  155. <table class="memname">
  156. <tr>
  157. <td class="memname">void <a class="el" href="classgrpc_1_1_client_async_writer.html">grpc::ClientAsyncWriter</a>&lt; W &gt;::Finish </td>
  158. <td>(</td>
  159. <td class="paramtype"><a class="el" href="classgrpc_1_1_status.html">Status</a> *&#160;</td>
  160. <td class="paramname"><em>status</em>, </td>
  161. </tr>
  162. <tr>
  163. <td class="paramkey"></td>
  164. <td></td>
  165. <td class="paramtype">void *&#160;</td>
  166. <td class="paramname"><em>tag</em>&#160;</td>
  167. </tr>
  168. <tr>
  169. <td></td>
  170. <td>)</td>
  171. <td></td><td></td>
  172. </tr>
  173. </table>
  174. </td>
  175. <td class="mlabels-right">
  176. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  177. </tr>
  178. </table>
  179. </div><div class="memdoc">
  180. <p>See the <em>ClientAsyncStreamingInterface.Finish</em> method for semantics. </p>
  181. <p>Side effect:</p>
  182. <ul>
  183. <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>
  184. <li>attempts to fill in the <em>response</em> parameter passed to this class's constructor with the server's response message. </li>
  185. </ul>
  186. <p>Implements <a class="el" href="classgrpc_1_1internal_1_1_client_async_streaming_interface.html#ad83ce06905fe819ae1e6b5b85e437642">grpc::internal::ClientAsyncStreamingInterface</a>.</p>
  187. </div>
  188. </div>
  189. <a class="anchor" id="a38cfef152cb45c498cac2134fc5d263c"></a>
  190. <div class="memitem">
  191. <div class="memproto">
  192. <div class="memtemplate">
  193. template&lt;class W &gt; </div>
  194. <table class="mlabels">
  195. <tr>
  196. <td class="mlabels-left">
  197. <table class="memname">
  198. <tr>
  199. <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>
  200. <td>(</td>
  201. <td class="paramtype">void *&#160;</td>
  202. <td class="paramname"><em>ptr</em>, </td>
  203. </tr>
  204. <tr>
  205. <td class="paramkey"></td>
  206. <td></td>
  207. <td class="paramtype">std::size_t&#160;</td>
  208. <td class="paramname"><em>size</em>&#160;</td>
  209. </tr>
  210. <tr>
  211. <td></td>
  212. <td>)</td>
  213. <td></td><td></td>
  214. </tr>
  215. </table>
  216. </td>
  217. <td class="mlabels-right">
  218. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  219. </tr>
  220. </table>
  221. </div><div class="memdoc">
  222. </div>
  223. </div>
  224. <a class="anchor" id="a02f613eaaed4177f1682da3f5eebbdeb"></a>
  225. <div class="memitem">
  226. <div class="memproto">
  227. <div class="memtemplate">
  228. template&lt;class W &gt; </div>
  229. <table class="mlabels">
  230. <tr>
  231. <td class="mlabels-left">
  232. <table class="memname">
  233. <tr>
  234. <td class="memname">void <a class="el" href="classgrpc_1_1_client_async_writer.html">grpc::ClientAsyncWriter</a>&lt; W &gt;::ReadInitialMetadata </td>
  235. <td>(</td>
  236. <td class="paramtype">void *&#160;</td>
  237. <td class="paramname"><em>tag</em></td><td>)</td>
  238. <td></td>
  239. </tr>
  240. </table>
  241. </td>
  242. <td class="mlabels-right">
  243. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  244. </tr>
  245. </table>
  246. </div><div class="memdoc">
  247. <p>See the <em>ClientAsyncStreamingInterface.ReadInitialMetadata</em> method for semantics. </p>
  248. <p>Side effect:</p>
  249. <ul>
  250. <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>
  251. </ul>
  252. <p>Implements <a class="el" href="classgrpc_1_1internal_1_1_client_async_streaming_interface.html#ab5a35e289028ac2aaf062572ba6d567d">grpc::internal::ClientAsyncStreamingInterface</a>.</p>
  253. </div>
  254. </div>
  255. <a class="anchor" id="a42b8329c9a8bf18528fee8a3776db3d6"></a>
  256. <div class="memitem">
  257. <div class="memproto">
  258. <div class="memtemplate">
  259. template&lt;class W &gt; </div>
  260. <table class="mlabels">
  261. <tr>
  262. <td class="mlabels-left">
  263. <table class="memname">
  264. <tr>
  265. <td class="memname">void <a class="el" href="classgrpc_1_1_client_async_writer.html">grpc::ClientAsyncWriter</a>&lt; W &gt;::StartCall </td>
  266. <td>(</td>
  267. <td class="paramtype">void *&#160;</td>
  268. <td class="paramname"><em>tag</em></td><td>)</td>
  269. <td></td>
  270. </tr>
  271. </table>
  272. </td>
  273. <td class="mlabels-right">
  274. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  275. </tr>
  276. </table>
  277. </div><div class="memdoc">
  278. <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>
  279. <p>Implements <a class="el" href="classgrpc_1_1internal_1_1_client_async_streaming_interface.html#a2bd65338b34000980fa048911c577637">grpc::internal::ClientAsyncStreamingInterface</a>.</p>
  280. </div>
  281. </div>
  282. <a class="anchor" id="a0e981b6dcce663e655edf305573f2f30"></a>
  283. <div class="memitem">
  284. <div class="memproto">
  285. <div class="memtemplate">
  286. template&lt;class W &gt; </div>
  287. <table class="mlabels">
  288. <tr>
  289. <td class="mlabels-left">
  290. <table class="memname">
  291. <tr>
  292. <td class="memname">void <a class="el" href="classgrpc_1_1_client_async_writer.html">grpc::ClientAsyncWriter</a>&lt; W &gt;::Write </td>
  293. <td>(</td>
  294. <td class="paramtype">const W &amp;&#160;</td>
  295. <td class="paramname"><em>msg</em>, </td>
  296. </tr>
  297. <tr>
  298. <td class="paramkey"></td>
  299. <td></td>
  300. <td class="paramtype">void *&#160;</td>
  301. <td class="paramname"><em>tag</em>&#160;</td>
  302. </tr>
  303. <tr>
  304. <td></td>
  305. <td>)</td>
  306. <td></td><td></td>
  307. </tr>
  308. </table>
  309. </td>
  310. <td class="mlabels-right">
  311. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  312. </tr>
  313. </table>
  314. </div><div class="memdoc">
  315. <p>Request the writing of <em>msg</em> with identifying tag <em>tag</em>. </p>
  316. <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>
  317. <dl class="params"><dt>Parameters</dt><dd>
  318. <table class="params">
  319. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>The message to be written. </td></tr>
  320. <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The tag identifying the operation. </td></tr>
  321. </table>
  322. </dd>
  323. </dl>
  324. <p>Implements <a class="el" href="classgrpc_1_1internal_1_1_async_writer_interface.html#aa61e21fdfef0a4fb34f595bef767e6a8">grpc::internal::AsyncWriterInterface&lt; W &gt;</a>.</p>
  325. </div>
  326. </div>
  327. <a class="anchor" id="a3f3d8e3e47b7181f7312fd6e3eb32674"></a>
  328. <div class="memitem">
  329. <div class="memproto">
  330. <div class="memtemplate">
  331. template&lt;class W &gt; </div>
  332. <table class="mlabels">
  333. <tr>
  334. <td class="mlabels-left">
  335. <table class="memname">
  336. <tr>
  337. <td class="memname">void <a class="el" href="classgrpc_1_1_client_async_writer.html">grpc::ClientAsyncWriter</a>&lt; W &gt;::Write </td>
  338. <td>(</td>
  339. <td class="paramtype">const W &amp;&#160;</td>
  340. <td class="paramname"><em>msg</em>, </td>
  341. </tr>
  342. <tr>
  343. <td class="paramkey"></td>
  344. <td></td>
  345. <td class="paramtype"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&#160;</td>
  346. <td class="paramname"><em>options</em>, </td>
  347. </tr>
  348. <tr>
  349. <td class="paramkey"></td>
  350. <td></td>
  351. <td class="paramtype">void *&#160;</td>
  352. <td class="paramname"><em>tag</em>&#160;</td>
  353. </tr>
  354. <tr>
  355. <td></td>
  356. <td>)</td>
  357. <td></td><td></td>
  358. </tr>
  359. </table>
  360. </td>
  361. <td class="mlabels-right">
  362. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  363. </tr>
  364. </table>
  365. </div><div class="memdoc">
  366. <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>
  367. <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>
  368. <dl class="params"><dt>Parameters</dt><dd>
  369. <table class="params">
  370. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>The message to be written. </td></tr>
  371. <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>
  372. <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The tag identifying the operation. </td></tr>
  373. </table>
  374. </dd>
  375. </dl>
  376. <p>Implements <a class="el" href="classgrpc_1_1internal_1_1_async_writer_interface.html#a5745991911afa0fb12646a5f79738a0d">grpc::internal::AsyncWriterInterface&lt; W &gt;</a>.</p>
  377. </div>
  378. </div>
  379. <a class="anchor" id="ab9fd5cd7dedd73d878a86de84c58e8ff"></a>
  380. <div class="memitem">
  381. <div class="memproto">
  382. <div class="memtemplate">
  383. template&lt;class W &gt; </div>
  384. <table class="mlabels">
  385. <tr>
  386. <td class="mlabels-left">
  387. <table class="memname">
  388. <tr>
  389. <td class="memname">void <a class="el" href="classgrpc_1_1_client_async_writer.html">grpc::ClientAsyncWriter</a>&lt; W &gt;::WritesDone </td>
  390. <td>(</td>
  391. <td class="paramtype">void *&#160;</td>
  392. <td class="paramname"><em>tag</em></td><td>)</td>
  393. <td></td>
  394. </tr>
  395. </table>
  396. </td>
  397. <td class="mlabels-right">
  398. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  399. </tr>
  400. </table>
  401. </div><div class="memdoc">
  402. <p>Signal the client is done with the writes (half-close the client stream). </p>
  403. <p>Thread-safe with respect to <em>AsyncReaderInterface::Read</em> </p>
  404. <dl class="params"><dt>Parameters</dt><dd>
  405. <table class="params">
  406. <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The tag identifying the operation. </td></tr>
  407. </table>
  408. </dd>
  409. </dl>
  410. <p>Implements <a class="el" href="classgrpc_1_1_client_async_writer_interface.html#a488d42d85f8e34902401e013572ff822">grpc::ClientAsyncWriterInterface&lt; W &gt;</a>.</p>
  411. </div>
  412. </div>
  413. <h2 class="groupheader">Friends And Related Function Documentation</h2>
  414. <a class="anchor" id="a5e0a3f0980c67fa6bdb0affd2659b8d2"></a>
  415. <div class="memitem">
  416. <div class="memproto">
  417. <div class="memtemplate">
  418. template&lt;class W &gt; </div>
  419. <table class="mlabels">
  420. <tr>
  421. <td class="mlabels-left">
  422. <table class="memname">
  423. <tr>
  424. <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>
  425. </tr>
  426. </table>
  427. </td>
  428. <td class="mlabels-right">
  429. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  430. </tr>
  431. </table>
  432. </div><div class="memdoc">
  433. </div>
  434. </div>
  435. <hr/>The documentation for this class was generated from the following file:<ul>
  436. <li>include/grpc++/impl/codegen/<a class="el" href="impl_2codegen_2async__stream_8h_source.html">async_stream.h</a></li>
  437. </ul>
  438. </div><!-- contents -->
  439. <!-- start footer part -->
  440. <hr class="footer"/><address class="footer"><small>
  441. Generated on Tue Dec 12 2017 18:36:13 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  442. <img class="footer" src="doxygen.png" alt="doxygen"/>
  443. </a> 1.8.6
  444. </small></address>
  445. </body>
  446. </html>