classgrpc_1_1_client_async_reader_writer.html 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515
  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::ClientAsyncReaderWriter&lt; W, R &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. <script type="text/javascript"> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-60127042-1', 'auto'); ga('send', 'pageview'); </script></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.13.0-dev</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.html">grpc</a></li><li class="navelem"><a class="el" href="classgrpc_1_1_client_async_reader_writer.html">ClientAsyncReaderWriter</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::ClientAsyncReaderWriter&lt; W, R &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 client-side interface for bi-directional streaming, where the outgoing message stream going to the server has messages of type <em>W</em>, and the incoming message stream coming from the server has messages of type <em>R</em>.
  73. <a href="classgrpc_1_1_client_async_reader_writer.html#details">More...</a></p>
  74. <p><code>#include &lt;<a class="el" href="grpcpp_2impl_2codegen_2async__stream_8h_source.html">async_stream.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:ae72f68c240ac2cbca98b524e723bd05b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_async_reader_writer.html#ae72f68c240ac2cbca98b524e723bd05b">StartCall</a> (void *tag) override</td></tr>
  79. <tr class="memdesc:ae72f68c240ac2cbca98b524e723bd05b"><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="#ae72f68c240ac2cbca98b524e723bd05b">More...</a><br /></td></tr>
  80. <tr class="separator:ae72f68c240ac2cbca98b524e723bd05b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:a169a2eb8bedfd7281b37c79fdd307eb2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_async_reader_writer.html#a169a2eb8bedfd7281b37c79fdd307eb2">ReadInitialMetadata</a> (void *tag) override</td></tr>
  82. <tr class="memdesc:a169a2eb8bedfd7281b37c79fdd307eb2"><td class="mdescLeft">&#160;</td><td class="mdescRight">See the <em>ClientAsyncStreamingInterface.ReadInitialMetadata</em> method for semantics of this method. <a href="#a169a2eb8bedfd7281b37c79fdd307eb2">More...</a><br /></td></tr>
  83. <tr class="separator:a169a2eb8bedfd7281b37c79fdd307eb2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:a2f2c91734a7de5affdd427fb88ee6167"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_async_reader_writer.html#a2f2c91734a7de5affdd427fb88ee6167">Read</a> (R *msg, void *tag) override</td></tr>
  85. <tr class="memdesc:a2f2c91734a7de5affdd427fb88ee6167"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read a message of type <em>R</em> into <em>msg</em>. <a href="#a2f2c91734a7de5affdd427fb88ee6167">More...</a><br /></td></tr>
  86. <tr class="separator:a2f2c91734a7de5affdd427fb88ee6167"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:a07bcc3a0737c3bee3ef50def89af5fc7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_async_reader_writer.html#a07bcc3a0737c3bee3ef50def89af5fc7">Write</a> (const W &amp;msg, void *tag) override</td></tr>
  88. <tr class="memdesc:a07bcc3a0737c3bee3ef50def89af5fc7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request the writing of <em>msg</em> with identifying tag <em>tag</em>. <a href="#a07bcc3a0737c3bee3ef50def89af5fc7">More...</a><br /></td></tr>
  89. <tr class="separator:a07bcc3a0737c3bee3ef50def89af5fc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:abcea1a4d9d8f6f1070940b1997fe0125"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_async_reader_writer.html#abcea1a4d9d8f6f1070940b1997fe0125">Write</a> (const W &amp;msg, <a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> options, void *tag) override</td></tr>
  91. <tr class="memdesc:abcea1a4d9d8f6f1070940b1997fe0125"><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="#abcea1a4d9d8f6f1070940b1997fe0125">More...</a><br /></td></tr>
  92. <tr class="separator:abcea1a4d9d8f6f1070940b1997fe0125"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:af3e090a0801f6bc524f959cd93e4cddc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_async_reader_writer.html#af3e090a0801f6bc524f959cd93e4cddc">WritesDone</a> (void *tag) override</td></tr>
  94. <tr class="memdesc:af3e090a0801f6bc524f959cd93e4cddc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signal the client is done with the writes (half-close the client stream). <a href="#af3e090a0801f6bc524f959cd93e4cddc">More...</a><br /></td></tr>
  95. <tr class="separator:af3e090a0801f6bc524f959cd93e4cddc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:a292fae35382e0f3c919840689cfb2358"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_async_reader_writer.html#a292fae35382e0f3c919840689cfb2358">Finish</a> (<a class="el" href="classgrpc_1_1_status.html">Status</a> *status, void *tag) override</td></tr>
  97. <tr class="memdesc:a292fae35382e0f3c919840689cfb2358"><td class="mdescLeft">&#160;</td><td class="mdescRight">See the <em>ClientAsyncStreamingInterface.Finish</em> method for semantics. <a href="#a292fae35382e0f3c919840689cfb2358">More...</a><br /></td></tr>
  98. <tr class="separator:a292fae35382e0f3c919840689cfb2358"><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: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>
  106. <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="classgrpc_1_1internal_1_1_async_writer_interface.html#a02565abb7c6b4a7a49c0b29159194b66">More...</a><br /></td></tr>
  107. <tr class="separator:a02565abb7c6b4a7a49c0b29159194b66 inherit pub_methods_classgrpc_1_1internal_1_1_async_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="inherit_header pub_methods_classgrpc_1_1internal_1_1_async_reader_interface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1internal_1_1_async_reader_interface')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc_1_1internal_1_1_async_reader_interface.html">grpc::internal::AsyncReaderInterface&lt; R &gt;</a></td></tr>
  109. <tr class="memitem:a18fe4235232864c8770a562cc2aa1f3c inherit pub_methods_classgrpc_1_1internal_1_1_async_reader_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_reader_interface.html#a18fe4235232864c8770a562cc2aa1f3c">~AsyncReaderInterface</a> ()</td></tr>
  110. <tr class="separator:a18fe4235232864c8770a562cc2aa1f3c inherit pub_methods_classgrpc_1_1internal_1_1_async_reader_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. </table><table class="memberdecls">
  112. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  113. Static Public Member Functions</h2></td></tr>
  114. <tr class="memitem:a637f06cdc945255e39223bc265bfc5a5"><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_reader_writer.html#a637f06cdc945255e39223bc265bfc5a5">operator delete</a> (void *ptr, std::size_t size)</td></tr>
  115. <tr class="separator:a637f06cdc945255e39223bc265bfc5a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. </table><table class="memberdecls">
  117. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  118. Friends</h2></td></tr>
  119. <tr class="memitem:a5107c618ce45973618f594146940d81c"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_async_reader_writer.html#a5107c618ce45973618f594146940d81c">internal::ClientAsyncReaderWriterFactory&lt; W, R &gt;</a></td></tr>
  120. <tr class="separator:a5107c618ce45973618f594146940d81c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. </table>
  122. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  123. <div class="textblock"><h3>template&lt;class W, class R&gt;<br />
  124. class grpc::ClientAsyncReaderWriter&lt; W, R &gt;</h3>
  125. <p>Async client-side interface for bi-directional streaming, where the outgoing message stream going to the server has messages of type <em>W</em>, and the incoming message stream coming from the server has messages of type <em>R</em>. </p>
  126. </div><h2 class="groupheader">Member Function Documentation</h2>
  127. <a id="a292fae35382e0f3c919840689cfb2358"></a>
  128. <h2 class="memtitle"><span class="permalink"><a href="#a292fae35382e0f3c919840689cfb2358">&#9670;&nbsp;</a></span>Finish()</h2>
  129. <div class="memitem">
  130. <div class="memproto">
  131. <div class="memtemplate">
  132. template&lt;class W , class R &gt; </div>
  133. <table class="mlabels">
  134. <tr>
  135. <td class="mlabels-left">
  136. <table class="memname">
  137. <tr>
  138. <td class="memname">void <a class="el" href="classgrpc_1_1_client_async_reader_writer.html">grpc::ClientAsyncReaderWriter</a>&lt; W, R &gt;::Finish </td>
  139. <td>(</td>
  140. <td class="paramtype"><a class="el" href="classgrpc_1_1_status.html">Status</a> *&#160;</td>
  141. <td class="paramname"><em>status</em>, </td>
  142. </tr>
  143. <tr>
  144. <td class="paramkey"></td>
  145. <td></td>
  146. <td class="paramtype">void *&#160;</td>
  147. <td class="paramname"><em>tag</em>&#160;</td>
  148. </tr>
  149. <tr>
  150. <td></td>
  151. <td>)</td>
  152. <td></td><td></td>
  153. </tr>
  154. </table>
  155. </td>
  156. <td class="mlabels-right">
  157. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  158. </tr>
  159. </table>
  160. </div><div class="memdoc">
  161. <p>See the <em>ClientAsyncStreamingInterface.Finish</em> method for semantics. </p>
  162. <p>Side effect</p><ul>
  163. <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 sent from the server. </li>
  164. </ul>
  165. <p>Implements <a class="el" href="classgrpc_1_1internal_1_1_client_async_streaming_interface.html#ad83ce06905fe819ae1e6b5b85e437642">grpc::internal::ClientAsyncStreamingInterface</a>.</p>
  166. </div>
  167. </div>
  168. <a id="a637f06cdc945255e39223bc265bfc5a5"></a>
  169. <h2 class="memtitle"><span class="permalink"><a href="#a637f06cdc945255e39223bc265bfc5a5">&#9670;&nbsp;</a></span>operator delete()</h2>
  170. <div class="memitem">
  171. <div class="memproto">
  172. <div class="memtemplate">
  173. template&lt;class W , class R &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_reader_writer.html">grpc::ClientAsyncReaderWriter</a>&lt; W, R &gt;::operator delete </td>
  180. <td>(</td>
  181. <td class="paramtype">void *&#160;</td>
  182. <td class="paramname"><em>ptr</em>, </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="a2f2c91734a7de5affdd427fb88ee6167"></a>
  205. <h2 class="memtitle"><span class="permalink"><a href="#a2f2c91734a7de5affdd427fb88ee6167">&#9670;&nbsp;</a></span>Read()</h2>
  206. <div class="memitem">
  207. <div class="memproto">
  208. <div class="memtemplate">
  209. template&lt;class W , class R &gt; </div>
  210. <table class="mlabels">
  211. <tr>
  212. <td class="mlabels-left">
  213. <table class="memname">
  214. <tr>
  215. <td class="memname">void <a class="el" href="classgrpc_1_1_client_async_reader_writer.html">grpc::ClientAsyncReaderWriter</a>&lt; W, R &gt;::Read </td>
  216. <td>(</td>
  217. <td class="paramtype">R *&#160;</td>
  218. <td class="paramname"><em>msg</em>, </td>
  219. </tr>
  220. <tr>
  221. <td class="paramkey"></td>
  222. <td></td>
  223. <td class="paramtype">void *&#160;</td>
  224. <td class="paramname"><em>tag</em>&#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">override</span><span class="mlabel">virtual</span></span> </td>
  235. </tr>
  236. </table>
  237. </div><div class="memdoc">
  238. <p>Read a message of type <em>R</em> into <em>msg</em>. </p>
  239. <p>Completion will be notified by <em>tag</em> on the associated completion queue. This is thread-safe with respect to <em>Write</em> or <em>WritesDone</em> methods. It should not be called concurrently with other streaming APIs on the same stream. It is not meaningful to call it concurrently with another <em>AsyncReaderInterface::Read</em> on the same stream since reads on the same stream are delivered in order.</p>
  240. <dl class="params"><dt>Parameters</dt><dd>
  241. <table class="params">
  242. <tr><td class="paramdir">[out]</td><td class="paramname">msg</td><td>Where to eventually store the read message. </td></tr>
  243. <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The tag identifying the operation.</td></tr>
  244. </table>
  245. </dd>
  246. </dl>
  247. <p>Side effect: note that this method attempt to receive initial metadata for a stream if it hasn't yet been received. </p>
  248. <p>Implements <a class="el" href="classgrpc_1_1internal_1_1_async_reader_interface.html#adf87c602036d69158950b7299d0aae70">grpc::internal::AsyncReaderInterface&lt; R &gt;</a>.</p>
  249. </div>
  250. </div>
  251. <a id="a169a2eb8bedfd7281b37c79fdd307eb2"></a>
  252. <h2 class="memtitle"><span class="permalink"><a href="#a169a2eb8bedfd7281b37c79fdd307eb2">&#9670;&nbsp;</a></span>ReadInitialMetadata()</h2>
  253. <div class="memitem">
  254. <div class="memproto">
  255. <div class="memtemplate">
  256. template&lt;class W , class R &gt; </div>
  257. <table class="mlabels">
  258. <tr>
  259. <td class="mlabels-left">
  260. <table class="memname">
  261. <tr>
  262. <td class="memname">void <a class="el" href="classgrpc_1_1_client_async_reader_writer.html">grpc::ClientAsyncReaderWriter</a>&lt; W, R &gt;::ReadInitialMetadata </td>
  263. <td>(</td>
  264. <td class="paramtype">void *&#160;</td>
  265. <td class="paramname"><em>tag</em></td><td>)</td>
  266. <td></td>
  267. </tr>
  268. </table>
  269. </td>
  270. <td class="mlabels-right">
  271. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  272. </tr>
  273. </table>
  274. </div><div class="memdoc">
  275. <p>See the <em>ClientAsyncStreamingInterface.ReadInitialMetadata</em> method for semantics of this method. </p>
  276. <p>Side effect:</p><ul>
  277. <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> is updated with it, and then the receiving initial metadata can be accessed through this <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>
  278. </ul>
  279. <p>Implements <a class="el" href="classgrpc_1_1internal_1_1_client_async_streaming_interface.html#ab5a35e289028ac2aaf062572ba6d567d">grpc::internal::ClientAsyncStreamingInterface</a>.</p>
  280. </div>
  281. </div>
  282. <a id="ae72f68c240ac2cbca98b524e723bd05b"></a>
  283. <h2 class="memtitle"><span class="permalink"><a href="#ae72f68c240ac2cbca98b524e723bd05b">&#9670;&nbsp;</a></span>StartCall()</h2>
  284. <div class="memitem">
  285. <div class="memproto">
  286. <div class="memtemplate">
  287. template&lt;class W , class R &gt; </div>
  288. <table class="mlabels">
  289. <tr>
  290. <td class="mlabels-left">
  291. <table class="memname">
  292. <tr>
  293. <td class="memname">void <a class="el" href="classgrpc_1_1_client_async_reader_writer.html">grpc::ClientAsyncReaderWriter</a>&lt; W, R &gt;::StartCall </td>
  294. <td>(</td>
  295. <td class="paramtype">void *&#160;</td>
  296. <td class="paramname"><em>tag</em></td><td>)</td>
  297. <td></td>
  298. </tr>
  299. </table>
  300. </td>
  301. <td class="mlabels-right">
  302. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  303. </tr>
  304. </table>
  305. </div><div class="memdoc">
  306. <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>
  307. <p>Implements <a class="el" href="classgrpc_1_1internal_1_1_client_async_streaming_interface.html#a2bd65338b34000980fa048911c577637">grpc::internal::ClientAsyncStreamingInterface</a>.</p>
  308. </div>
  309. </div>
  310. <a id="a07bcc3a0737c3bee3ef50def89af5fc7"></a>
  311. <h2 class="memtitle"><span class="permalink"><a href="#a07bcc3a0737c3bee3ef50def89af5fc7">&#9670;&nbsp;</a></span>Write() <span class="overload">[1/2]</span></h2>
  312. <div class="memitem">
  313. <div class="memproto">
  314. <div class="memtemplate">
  315. template&lt;class W , class R &gt; </div>
  316. <table class="mlabels">
  317. <tr>
  318. <td class="mlabels-left">
  319. <table class="memname">
  320. <tr>
  321. <td class="memname">void <a class="el" href="classgrpc_1_1_client_async_reader_writer.html">grpc::ClientAsyncReaderWriter</a>&lt; W, R &gt;::Write </td>
  322. <td>(</td>
  323. <td class="paramtype">const W &amp;&#160;</td>
  324. <td class="paramname"><em>msg</em>, </td>
  325. </tr>
  326. <tr>
  327. <td class="paramkey"></td>
  328. <td></td>
  329. <td class="paramtype">void *&#160;</td>
  330. <td class="paramname"><em>tag</em>&#160;</td>
  331. </tr>
  332. <tr>
  333. <td></td>
  334. <td>)</td>
  335. <td></td><td></td>
  336. </tr>
  337. </table>
  338. </td>
  339. <td class="mlabels-right">
  340. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  341. </tr>
  342. </table>
  343. </div><div class="memdoc">
  344. <p>Request the writing of <em>msg</em> with identifying tag <em>tag</em>. </p>
  345. <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>
  346. <dl class="params"><dt>Parameters</dt><dd>
  347. <table class="params">
  348. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>The message to be written. </td></tr>
  349. <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The tag identifying the operation. </td></tr>
  350. </table>
  351. </dd>
  352. </dl>
  353. <p>Implements <a class="el" href="classgrpc_1_1internal_1_1_async_writer_interface.html#aa61e21fdfef0a4fb34f595bef767e6a8">grpc::internal::AsyncWriterInterface&lt; W &gt;</a>.</p>
  354. </div>
  355. </div>
  356. <a id="abcea1a4d9d8f6f1070940b1997fe0125"></a>
  357. <h2 class="memtitle"><span class="permalink"><a href="#abcea1a4d9d8f6f1070940b1997fe0125">&#9670;&nbsp;</a></span>Write() <span class="overload">[2/2]</span></h2>
  358. <div class="memitem">
  359. <div class="memproto">
  360. <div class="memtemplate">
  361. template&lt;class W , class R &gt; </div>
  362. <table class="mlabels">
  363. <tr>
  364. <td class="mlabels-left">
  365. <table class="memname">
  366. <tr>
  367. <td class="memname">void <a class="el" href="classgrpc_1_1_client_async_reader_writer.html">grpc::ClientAsyncReaderWriter</a>&lt; W, R &gt;::Write </td>
  368. <td>(</td>
  369. <td class="paramtype">const W &amp;&#160;</td>
  370. <td class="paramname"><em>msg</em>, </td>
  371. </tr>
  372. <tr>
  373. <td class="paramkey"></td>
  374. <td></td>
  375. <td class="paramtype"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&#160;</td>
  376. <td class="paramname"><em>options</em>, </td>
  377. </tr>
  378. <tr>
  379. <td class="paramkey"></td>
  380. <td></td>
  381. <td class="paramtype">void *&#160;</td>
  382. <td class="paramname"><em>tag</em>&#160;</td>
  383. </tr>
  384. <tr>
  385. <td></td>
  386. <td>)</td>
  387. <td></td><td></td>
  388. </tr>
  389. </table>
  390. </td>
  391. <td class="mlabels-right">
  392. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  393. </tr>
  394. </table>
  395. </div><div class="memdoc">
  396. <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>
  397. <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>
  398. <dl class="params"><dt>Parameters</dt><dd>
  399. <table class="params">
  400. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>The message to be written. </td></tr>
  401. <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>
  402. <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The tag identifying the operation. </td></tr>
  403. </table>
  404. </dd>
  405. </dl>
  406. <p>Implements <a class="el" href="classgrpc_1_1internal_1_1_async_writer_interface.html#a5745991911afa0fb12646a5f79738a0d">grpc::internal::AsyncWriterInterface&lt; W &gt;</a>.</p>
  407. </div>
  408. </div>
  409. <a id="af3e090a0801f6bc524f959cd93e4cddc"></a>
  410. <h2 class="memtitle"><span class="permalink"><a href="#af3e090a0801f6bc524f959cd93e4cddc">&#9670;&nbsp;</a></span>WritesDone()</h2>
  411. <div class="memitem">
  412. <div class="memproto">
  413. <div class="memtemplate">
  414. template&lt;class W , class R &gt; </div>
  415. <table class="mlabels">
  416. <tr>
  417. <td class="mlabels-left">
  418. <table class="memname">
  419. <tr>
  420. <td class="memname">void <a class="el" href="classgrpc_1_1_client_async_reader_writer.html">grpc::ClientAsyncReaderWriter</a>&lt; W, R &gt;::WritesDone </td>
  421. <td>(</td>
  422. <td class="paramtype">void *&#160;</td>
  423. <td class="paramname"><em>tag</em></td><td>)</td>
  424. <td></td>
  425. </tr>
  426. </table>
  427. </td>
  428. <td class="mlabels-right">
  429. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  430. </tr>
  431. </table>
  432. </div><div class="memdoc">
  433. <p>Signal the client is done with the writes (half-close the client stream). </p>
  434. <p>Thread-safe with respect to <em>AsyncReaderInterface::Read</em> </p>
  435. <dl class="params"><dt>Parameters</dt><dd>
  436. <table class="params">
  437. <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The tag identifying the operation. </td></tr>
  438. </table>
  439. </dd>
  440. </dl>
  441. <p>Implements <a class="el" href="classgrpc_1_1_client_async_reader_writer_interface.html#a878193880df68ab969b697f1fcd7dbc3">grpc::ClientAsyncReaderWriterInterface&lt; W, R &gt;</a>.</p>
  442. </div>
  443. </div>
  444. <h2 class="groupheader">Friends And Related Function Documentation</h2>
  445. <a id="a5107c618ce45973618f594146940d81c"></a>
  446. <h2 class="memtitle"><span class="permalink"><a href="#a5107c618ce45973618f594146940d81c">&#9670;&nbsp;</a></span>internal::ClientAsyncReaderWriterFactory< W, R ></h2>
  447. <div class="memitem">
  448. <div class="memproto">
  449. <div class="memtemplate">
  450. template&lt;class W , class R &gt; </div>
  451. <table class="mlabels">
  452. <tr>
  453. <td class="mlabels-left">
  454. <table class="memname">
  455. <tr>
  456. <td class="memname">friend class <a class="el" href="classgrpc_1_1internal_1_1_client_async_reader_writer_factory.html">internal::ClientAsyncReaderWriterFactory</a>&lt; W, R &gt;</td>
  457. </tr>
  458. </table>
  459. </td>
  460. <td class="mlabels-right">
  461. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  462. </tr>
  463. </table>
  464. </div><div class="memdoc">
  465. </div>
  466. </div>
  467. <hr/>The documentation for this class was generated from the following file:<ul>
  468. <li>include/grpcpp/impl/codegen/<a class="el" href="grpcpp_2impl_2codegen_2async__stream_8h_source.html">async_stream.h</a></li>
  469. </ul>
  470. </div><!-- contents -->
  471. <!-- start footer part -->
  472. <hr class="footer"/><address class="footer"><small>
  473. Generated on Tue May 15 2018 17:01:01 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  474. <img class="footer" src="doxygen.png" alt="doxygen"/>
  475. </a> 1.8.13
  476. </small></address>
  477. </body>
  478. </html>