classgrpc_1_1_client_async_reader_writer.html 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475
  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::ClientAsyncReaderWriter&lt; W, R &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.3.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_reader_writer.html">ClientAsyncReaderWriter</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> </div>
  92. <div class="headertitle">
  93. <div class="title">grpc::ClientAsyncReaderWriter&lt; W, R &gt; Class Template Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div>
  94. </div><!--header-->
  95. <div class="contents">
  96. <p><code>#include &lt;<a class="el" href="impl_2codegen_2async__stream_8h_source.html">async_stream.h</a>&gt;</code></p>
  97. <table class="memberdecls">
  98. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  99. Public Member Functions</h2></td></tr>
  100. <tr class="memitem:a0511a6da96294a181471688be7765044"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_async_reader_writer.html#a0511a6da96294a181471688be7765044">ClientAsyncReaderWriter</a> (<a class="el" href="classgrpc_1_1_channel_interface.html">ChannelInterface</a> *channel, <a class="el" href="classgrpc_1_1_completion_queue.html">CompletionQueue</a> *cq, const <a class="el" href="classgrpc_1_1_rpc_method.html">RpcMethod</a> &amp;method, <a class="el" href="classgrpc_1_1_client_context.html">ClientContext</a> *context, void *tag)</td></tr>
  101. <tr class="separator:a0511a6da96294a181471688be7765044"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <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>
  103. <tr class="memdesc:a169a2eb8bedfd7281b37c79fdd307eb2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request notification of the reading of the initial metadata. <a href="#a169a2eb8bedfd7281b37c79fdd307eb2">More...</a><br/></td></tr>
  104. <tr class="separator:a169a2eb8bedfd7281b37c79fdd307eb2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <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>
  106. <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>
  107. <tr class="separator:a2f2c91734a7de5affdd427fb88ee6167"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <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>
  109. <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>
  110. <tr class="separator:a07bcc3a0737c3bee3ef50def89af5fc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <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>
  112. <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>
  113. <tr class="separator:abcea1a4d9d8f6f1070940b1997fe0125"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <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>
  115. <tr class="memdesc:af3e090a0801f6bc524f959cd93e4cddc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signal the client is done with the writes. <a href="#af3e090a0801f6bc524f959cd93e4cddc">More...</a><br/></td></tr>
  116. <tr class="separator:af3e090a0801f6bc524f959cd93e4cddc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <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>
  118. <tr class="memdesc:a292fae35382e0f3c919840689cfb2358"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicate that the stream is to be finished and request notification Should not be used concurrently with other operations. <a href="#a292fae35382e0f3c919840689cfb2358">More...</a><br/></td></tr>
  119. <tr class="separator:a292fae35382e0f3c919840689cfb2358"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="inherit_header pub_methods_classgrpc_1_1_client_async_streaming_interface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1_client_async_streaming_interface')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc_1_1_client_async_streaming_interface.html">grpc::ClientAsyncStreamingInterface</a></td></tr>
  121. <tr class="memitem:a103c33e82dbf1715749886c4249f3f28 inherit pub_methods_classgrpc_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_1_client_async_streaming_interface.html#a103c33e82dbf1715749886c4249f3f28">~ClientAsyncStreamingInterface</a> ()</td></tr>
  122. <tr class="separator:a103c33e82dbf1715749886c4249f3f28 inherit pub_methods_classgrpc_1_1_client_async_streaming_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="inherit_header pub_methods_classgrpc_1_1_async_writer_interface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1_async_writer_interface')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc_1_1_async_writer_interface.html">grpc::AsyncWriterInterface&lt; W &gt;</a></td></tr>
  124. <tr class="memitem:a94cc9e4ed13c8fe4a1d883d465477ddd inherit pub_methods_classgrpc_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_1_async_writer_interface.html#a94cc9e4ed13c8fe4a1d883d465477ddd">~AsyncWriterInterface</a> ()</td></tr>
  125. <tr class="separator:a94cc9e4ed13c8fe4a1d883d465477ddd inherit pub_methods_classgrpc_1_1_async_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:a78097d5f23f4aa2c1b919b12800db90d inherit pub_methods_classgrpc_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_1_async_writer_interface.html#a78097d5f23f4aa2c1b919b12800db90d">WriteLast</a> (const W &amp;msg, <a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> options, void *tag)</td></tr>
  127. <tr class="memdesc:a78097d5f23f4aa2c1b919b12800db90d inherit pub_methods_classgrpc_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="#a78097d5f23f4aa2c1b919b12800db90d">More...</a><br/></td></tr>
  128. <tr class="separator:a78097d5f23f4aa2c1b919b12800db90d inherit pub_methods_classgrpc_1_1_async_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="inherit_header pub_methods_classgrpc_1_1_async_reader_interface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1_async_reader_interface')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc_1_1_async_reader_interface.html">grpc::AsyncReaderInterface&lt; R &gt;</a></td></tr>
  130. <tr class="memitem:ac7845d2df90fb380008aadb7f5f2f379 inherit pub_methods_classgrpc_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_1_async_reader_interface.html#ac7845d2df90fb380008aadb7f5f2f379">~AsyncReaderInterface</a> ()</td></tr>
  131. <tr class="separator:ac7845d2df90fb380008aadb7f5f2f379 inherit pub_methods_classgrpc_1_1_async_reader_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. </table>
  133. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  134. <a class="anchor" id="a0511a6da96294a181471688be7765044"></a>
  135. <div class="memitem">
  136. <div class="memproto">
  137. <div class="memtemplate">
  138. template&lt;class W , class R &gt; </div>
  139. <table class="mlabels">
  140. <tr>
  141. <td class="mlabels-left">
  142. <table class="memname">
  143. <tr>
  144. <td class="memname"><a class="el" href="classgrpc_1_1_client_async_reader_writer.html">grpc::ClientAsyncReaderWriter</a>&lt; W, R &gt;::<a class="el" href="classgrpc_1_1_client_async_reader_writer.html">ClientAsyncReaderWriter</a> </td>
  145. <td>(</td>
  146. <td class="paramtype"><a class="el" href="classgrpc_1_1_channel_interface.html">ChannelInterface</a> *&#160;</td>
  147. <td class="paramname"><em>channel</em>, </td>
  148. </tr>
  149. <tr>
  150. <td class="paramkey"></td>
  151. <td></td>
  152. <td class="paramtype"><a class="el" href="classgrpc_1_1_completion_queue.html">CompletionQueue</a> *&#160;</td>
  153. <td class="paramname"><em>cq</em>, </td>
  154. </tr>
  155. <tr>
  156. <td class="paramkey"></td>
  157. <td></td>
  158. <td class="paramtype">const <a class="el" href="classgrpc_1_1_rpc_method.html">RpcMethod</a> &amp;&#160;</td>
  159. <td class="paramname"><em>method</em>, </td>
  160. </tr>
  161. <tr>
  162. <td class="paramkey"></td>
  163. <td></td>
  164. <td class="paramtype"><a class="el" href="classgrpc_1_1_client_context.html">ClientContext</a> *&#160;</td>
  165. <td class="paramname"><em>context</em>, </td>
  166. </tr>
  167. <tr>
  168. <td class="paramkey"></td>
  169. <td></td>
  170. <td class="paramtype">void *&#160;</td>
  171. <td class="paramname"><em>tag</em>&#160;</td>
  172. </tr>
  173. <tr>
  174. <td></td>
  175. <td>)</td>
  176. <td></td><td></td>
  177. </tr>
  178. </table>
  179. </td>
  180. <td class="mlabels-right">
  181. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  182. </tr>
  183. </table>
  184. </div><div class="memdoc">
  185. </div>
  186. </div>
  187. <h2 class="groupheader">Member Function Documentation</h2>
  188. <a class="anchor" id="a292fae35382e0f3c919840689cfb2358"></a>
  189. <div class="memitem">
  190. <div class="memproto">
  191. <div class="memtemplate">
  192. template&lt;class W , class R &gt; </div>
  193. <table class="mlabels">
  194. <tr>
  195. <td class="mlabels-left">
  196. <table class="memname">
  197. <tr>
  198. <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>
  199. <td>(</td>
  200. <td class="paramtype"><a class="el" href="classgrpc_1_1_status.html">Status</a> *&#160;</td>
  201. <td class="paramname"><em>status</em>, </td>
  202. </tr>
  203. <tr>
  204. <td class="paramkey"></td>
  205. <td></td>
  206. <td class="paramtype">void *&#160;</td>
  207. <td class="paramname"><em>tag</em>&#160;</td>
  208. </tr>
  209. <tr>
  210. <td></td>
  211. <td>)</td>
  212. <td></td><td></td>
  213. </tr>
  214. </table>
  215. </td>
  216. <td class="mlabels-right">
  217. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  218. </tr>
  219. </table>
  220. </div><div class="memdoc">
  221. <p>Indicate that the stream is to be finished and request notification Should not be used concurrently with other operations. </p>
  222. <dl class="params"><dt>Parameters</dt><dd>
  223. <table class="params">
  224. <tr><td class="paramdir">[out]</td><td class="paramname">status</td><td>To be updated with the operation status. </td></tr>
  225. <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>Tag identifying this request. </td></tr>
  226. </table>
  227. </dd>
  228. </dl>
  229. <p>Implements <a class="el" href="classgrpc_1_1_client_async_streaming_interface.html#afc1cfbd1514fea47088bc837bb578a24">grpc::ClientAsyncStreamingInterface</a>.</p>
  230. </div>
  231. </div>
  232. <a class="anchor" id="a2f2c91734a7de5affdd427fb88ee6167"></a>
  233. <div class="memitem">
  234. <div class="memproto">
  235. <div class="memtemplate">
  236. template&lt;class W , class R &gt; </div>
  237. <table class="mlabels">
  238. <tr>
  239. <td class="mlabels-left">
  240. <table class="memname">
  241. <tr>
  242. <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>
  243. <td>(</td>
  244. <td class="paramtype">R *&#160;</td>
  245. <td class="paramname"><em>msg</em>, </td>
  246. </tr>
  247. <tr>
  248. <td class="paramkey"></td>
  249. <td></td>
  250. <td class="paramtype">void *&#160;</td>
  251. <td class="paramname"><em>tag</em>&#160;</td>
  252. </tr>
  253. <tr>
  254. <td></td>
  255. <td>)</td>
  256. <td></td><td></td>
  257. </tr>
  258. </table>
  259. </td>
  260. <td class="mlabels-right">
  261. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  262. </tr>
  263. </table>
  264. </div><div class="memdoc">
  265. <p>Read a message of type <em>R</em> into <em>msg</em>. </p>
  266. <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>Read</em> on the same stream since reads on the same stream are delivered in order.</p>
  267. <dl class="params"><dt>Parameters</dt><dd>
  268. <table class="params">
  269. <tr><td class="paramdir">[out]</td><td class="paramname">msg</td><td>Where to eventually store the read message. </td></tr>
  270. <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The tag identifying the operation. </td></tr>
  271. </table>
  272. </dd>
  273. </dl>
  274. <p>Implements <a class="el" href="classgrpc_1_1_async_reader_interface.html#aa644cf63c12ae8c9d5fda16a361f8a11">grpc::AsyncReaderInterface&lt; R &gt;</a>.</p>
  275. </div>
  276. </div>
  277. <a class="anchor" id="a169a2eb8bedfd7281b37c79fdd307eb2"></a>
  278. <div class="memitem">
  279. <div class="memproto">
  280. <div class="memtemplate">
  281. template&lt;class W , class R &gt; </div>
  282. <table class="mlabels">
  283. <tr>
  284. <td class="mlabels-left">
  285. <table class="memname">
  286. <tr>
  287. <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>
  288. <td>(</td>
  289. <td class="paramtype">void *&#160;</td>
  290. <td class="paramname"><em>tag</em></td><td>)</td>
  291. <td></td>
  292. </tr>
  293. </table>
  294. </td>
  295. <td class="mlabels-right">
  296. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  297. </tr>
  298. </table>
  299. </div><div class="memdoc">
  300. <p>Request notification of the reading of the initial metadata. </p>
  301. <p>Completion will be notified by <em>tag</em> on the associated completion queue. This call is optional, but if it is used, it cannot be used concurrently with or after the <em>Read</em> method.</p>
  302. <dl class="params"><dt>Parameters</dt><dd>
  303. <table class="params">
  304. <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>Tag identifying this request. </td></tr>
  305. </table>
  306. </dd>
  307. </dl>
  308. <p>Implements <a class="el" href="classgrpc_1_1_client_async_streaming_interface.html#ad83bfe2febf4a6296b7d2646799b8174">grpc::ClientAsyncStreamingInterface</a>.</p>
  309. </div>
  310. </div>
  311. <a class="anchor" id="a07bcc3a0737c3bee3ef50def89af5fc7"></a>
  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>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_1_async_writer_interface.html#a40c1091ac5cb5243c874da725ae291b4">grpc::AsyncWriterInterface&lt; W &gt;</a>.</p>
  354. </div>
  355. </div>
  356. <a class="anchor" id="abcea1a4d9d8f6f1070940b1997fe0125"></a>
  357. <div class="memitem">
  358. <div class="memproto">
  359. <div class="memtemplate">
  360. template&lt;class W , class R &gt; </div>
  361. <table class="mlabels">
  362. <tr>
  363. <td class="mlabels-left">
  364. <table class="memname">
  365. <tr>
  366. <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>
  367. <td>(</td>
  368. <td class="paramtype">const W &amp;&#160;</td>
  369. <td class="paramname"><em>msg</em>, </td>
  370. </tr>
  371. <tr>
  372. <td class="paramkey"></td>
  373. <td></td>
  374. <td class="paramtype"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&#160;</td>
  375. <td class="paramname"><em>options</em>, </td>
  376. </tr>
  377. <tr>
  378. <td class="paramkey"></td>
  379. <td></td>
  380. <td class="paramtype">void *&#160;</td>
  381. <td class="paramname"><em>tag</em>&#160;</td>
  382. </tr>
  383. <tr>
  384. <td></td>
  385. <td>)</td>
  386. <td></td><td></td>
  387. </tr>
  388. </table>
  389. </td>
  390. <td class="mlabels-right">
  391. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  392. </tr>
  393. </table>
  394. </div><div class="memdoc">
  395. <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>
  396. <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>Read</em> </p>
  397. <dl class="params"><dt>Parameters</dt><dd>
  398. <table class="params">
  399. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>The message to be written. </td></tr>
  400. <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>
  401. <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The tag identifying the operation. </td></tr>
  402. </table>
  403. </dd>
  404. </dl>
  405. <p>Implements <a class="el" href="classgrpc_1_1_async_writer_interface.html#a6a8480dbf5ad95384c929d9db91b6074">grpc::AsyncWriterInterface&lt; W &gt;</a>.</p>
  406. </div>
  407. </div>
  408. <a class="anchor" id="af3e090a0801f6bc524f959cd93e4cddc"></a>
  409. <div class="memitem">
  410. <div class="memproto">
  411. <div class="memtemplate">
  412. template&lt;class W , class R &gt; </div>
  413. <table class="mlabels">
  414. <tr>
  415. <td class="mlabels-left">
  416. <table class="memname">
  417. <tr>
  418. <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>
  419. <td>(</td>
  420. <td class="paramtype">void *&#160;</td>
  421. <td class="paramname"><em>tag</em></td><td>)</td>
  422. <td></td>
  423. </tr>
  424. </table>
  425. </td>
  426. <td class="mlabels-right">
  427. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  428. </tr>
  429. </table>
  430. </div><div class="memdoc">
  431. <p>Signal the client is done with the writes. </p>
  432. <p>Thread-safe with respect to <em>Read</em> </p>
  433. <dl class="params"><dt>Parameters</dt><dd>
  434. <table class="params">
  435. <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The tag identifying the operation. </td></tr>
  436. </table>
  437. </dd>
  438. </dl>
  439. <p>Implements <a class="el" href="classgrpc_1_1_client_async_reader_writer_interface.html#a878193880df68ab969b697f1fcd7dbc3">grpc::ClientAsyncReaderWriterInterface&lt; W, R &gt;</a>.</p>
  440. </div>
  441. </div>
  442. <hr/>The documentation for this class was generated from the following file:<ul>
  443. <li>include/grpc++/impl/codegen/<a class="el" href="impl_2codegen_2async__stream_8h_source.html">async_stream.h</a></li>
  444. </ul>
  445. </div><!-- contents -->
  446. <!-- start footer part -->
  447. <hr class="footer"/><address class="footer"><small>
  448. Generated on Thu Apr 27 2017 17:26:13 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  449. <img class="footer" src="doxygen.png" alt="doxygen"/>
  450. </a> 1.8.6
  451. </small></address>
  452. </body>
  453. </html>