classgrpc_1_1_client_async_reader_writer.html 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523
  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.4.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> &#124;
  92. <a href="#pub-static-methods">Static Public Member Functions</a> </div>
  93. <div class="headertitle">
  94. <div class="title">grpc::ClientAsyncReaderWriter&lt; W, R &gt; Class Template Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div>
  95. </div><!--header-->
  96. <div class="contents">
  97. <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>.
  98. <a href="classgrpc_1_1_client_async_reader_writer.html#details">More...</a></p>
  99. <p><code>#include &lt;<a class="el" href="impl_2codegen_2async__stream_8h_source.html">async_stream.h</a>&gt;</code></p>
  100. <table class="memberdecls">
  101. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  102. Public Member Functions</h2></td></tr>
  103. <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>
  104. <tr class="memdesc:a169a2eb8bedfd7281b37c79fdd307eb2"><td class="mdescLeft">&#160;</td><td class="mdescRight">See the <em><a class="el" href="classgrpc_1_1_client_async_streaming_interface.html#ad83bfe2febf4a6296b7d2646799b8174" title="Request notification of the reading of the initial metadata. ">ClientAsyncStreamingInterface.ReadInitialMetadata</a></em> method for semantics of this method. <a href="#a169a2eb8bedfd7281b37c79fdd307eb2">More...</a><br/></td></tr>
  105. <tr class="separator:a169a2eb8bedfd7281b37c79fdd307eb2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <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>
  107. <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>
  108. <tr class="separator:a2f2c91734a7de5affdd427fb88ee6167"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <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>
  110. <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>
  111. <tr class="separator:a07bcc3a0737c3bee3ef50def89af5fc7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <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>
  113. <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>
  114. <tr class="separator:abcea1a4d9d8f6f1070940b1997fe0125"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <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>
  116. <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>
  117. <tr class="separator:af3e090a0801f6bc524f959cd93e4cddc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <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>
  119. <tr class="memdesc:a292fae35382e0f3c919840689cfb2358"><td class="mdescLeft">&#160;</td><td class="mdescRight">See the <em><a class="el" href="classgrpc_1_1_client_async_streaming_interface.html#afc1cfbd1514fea47088bc837bb578a24" title="Indicate that the stream is to be finished and request notification for when the call has been ended...">ClientAsyncStreamingInterface.Finish</a></em> method for semantics. <a href="#a292fae35382e0f3c919840689cfb2358">More...</a><br/></td></tr>
  120. <tr class="separator:a292fae35382e0f3c919840689cfb2358"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <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>
  122. <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>
  123. <tr class="separator:a103c33e82dbf1715749886c4249f3f28 inherit pub_methods_classgrpc_1_1_client_async_streaming_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <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>
  125. <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>
  126. <tr class="separator:a94cc9e4ed13c8fe4a1d883d465477ddd inherit pub_methods_classgrpc_1_1_async_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <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>
  128. <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>
  129. <tr class="separator:a78097d5f23f4aa2c1b919b12800db90d inherit pub_methods_classgrpc_1_1_async_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <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>
  131. <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>
  132. <tr class="separator:ac7845d2df90fb380008aadb7f5f2f379 inherit pub_methods_classgrpc_1_1_async_reader_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. </table><table class="memberdecls">
  134. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  135. Static Public Member Functions</h2></td></tr>
  136. <tr class="memitem:a6f127ad148c28447fcfd2af7101148b6"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classgrpc_1_1_client_async_reader_writer.html">ClientAsyncReaderWriter</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_async_reader_writer.html#a6f127ad148c28447fcfd2af7101148b6">Create</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>
  137. <tr class="memdesc:a6f127ad148c28447fcfd2af7101148b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a stream and write the first request out. <a href="#a6f127ad148c28447fcfd2af7101148b6">More...</a><br/></td></tr>
  138. <tr class="separator:a6f127ad148c28447fcfd2af7101148b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <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>
  140. <tr class="separator:a637f06cdc945255e39223bc265bfc5a5"><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, class R&gt;<br/>
  144. class grpc::ClientAsyncReaderWriter&lt; W, R &gt;</h3>
  145. <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>
  146. </div><h2 class="groupheader">Member Function Documentation</h2>
  147. <a class="anchor" id="a6f127ad148c28447fcfd2af7101148b6"></a>
  148. <div class="memitem">
  149. <div class="memproto">
  150. <div class="memtemplate">
  151. template&lt;class W , class R &gt; </div>
  152. <table class="mlabels">
  153. <tr>
  154. <td class="mlabels-left">
  155. <table class="memname">
  156. <tr>
  157. <td class="memname">static <a class="el" href="classgrpc_1_1_client_async_reader_writer.html">ClientAsyncReaderWriter</a>* <a class="el" href="classgrpc_1_1_client_async_reader_writer.html">grpc::ClientAsyncReaderWriter</a>&lt; W, R &gt;::Create </td>
  158. <td>(</td>
  159. <td class="paramtype"><a class="el" href="classgrpc_1_1_channel_interface.html">ChannelInterface</a> *&#160;</td>
  160. <td class="paramname"><em>channel</em>, </td>
  161. </tr>
  162. <tr>
  163. <td class="paramkey"></td>
  164. <td></td>
  165. <td class="paramtype"><a class="el" href="classgrpc_1_1_completion_queue.html">CompletionQueue</a> *&#160;</td>
  166. <td class="paramname"><em>cq</em>, </td>
  167. </tr>
  168. <tr>
  169. <td class="paramkey"></td>
  170. <td></td>
  171. <td class="paramtype">const <a class="el" href="classgrpc_1_1_rpc_method.html">RpcMethod</a> &amp;&#160;</td>
  172. <td class="paramname"><em>method</em>, </td>
  173. </tr>
  174. <tr>
  175. <td class="paramkey"></td>
  176. <td></td>
  177. <td class="paramtype"><a class="el" href="classgrpc_1_1_client_context.html">ClientContext</a> *&#160;</td>
  178. <td class="paramname"><em>context</em>, </td>
  179. </tr>
  180. <tr>
  181. <td class="paramkey"></td>
  182. <td></td>
  183. <td class="paramtype">void *&#160;</td>
  184. <td class="paramname"><em>tag</em>&#160;</td>
  185. </tr>
  186. <tr>
  187. <td></td>
  188. <td>)</td>
  189. <td></td><td></td>
  190. </tr>
  191. </table>
  192. </td>
  193. <td class="mlabels-right">
  194. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  195. </tr>
  196. </table>
  197. </div><div class="memdoc">
  198. <p>Create a stream and write the first request out. </p>
  199. <p><em>tag</em> will be notified on <em>cq</em> when the call has been started (i.e. intitial metadata sent). Note that <em>context</em> will be used to fill in custom initial metadata used to send to the server when starting the call. </p>
  200. </div>
  201. </div>
  202. <a class="anchor" id="a292fae35382e0f3c919840689cfb2358"></a>
  203. <div class="memitem">
  204. <div class="memproto">
  205. <div class="memtemplate">
  206. template&lt;class W , class R &gt; </div>
  207. <table class="mlabels">
  208. <tr>
  209. <td class="mlabels-left">
  210. <table class="memname">
  211. <tr>
  212. <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>
  213. <td>(</td>
  214. <td class="paramtype"><a class="el" href="classgrpc_1_1_status.html">Status</a> *&#160;</td>
  215. <td class="paramname"><em>status</em>, </td>
  216. </tr>
  217. <tr>
  218. <td class="paramkey"></td>
  219. <td></td>
  220. <td class="paramtype">void *&#160;</td>
  221. <td class="paramname"><em>tag</em>&#160;</td>
  222. </tr>
  223. <tr>
  224. <td></td>
  225. <td>)</td>
  226. <td></td><td></td>
  227. </tr>
  228. </table>
  229. </td>
  230. <td class="mlabels-right">
  231. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  232. </tr>
  233. </table>
  234. </div><div class="memdoc">
  235. <p>See the <em><a class="el" href="classgrpc_1_1_client_async_streaming_interface.html#afc1cfbd1514fea47088bc837bb578a24" title="Indicate that the stream is to be finished and request notification for when the call has been ended...">ClientAsyncStreamingInterface.Finish</a></em> method for semantics. </p>
  236. <p>Side effect</p>
  237. <ul>
  238. <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>
  239. </ul>
  240. <p>Implements <a class="el" href="classgrpc_1_1_client_async_streaming_interface.html#afc1cfbd1514fea47088bc837bb578a24">grpc::ClientAsyncStreamingInterface</a>.</p>
  241. </div>
  242. </div>
  243. <a class="anchor" id="a637f06cdc945255e39223bc265bfc5a5"></a>
  244. <div class="memitem">
  245. <div class="memproto">
  246. <div class="memtemplate">
  247. template&lt;class W , class R &gt; </div>
  248. <table class="mlabels">
  249. <tr>
  250. <td class="mlabels-left">
  251. <table class="memname">
  252. <tr>
  253. <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>
  254. <td>(</td>
  255. <td class="paramtype">void *&#160;</td>
  256. <td class="paramname"><em>ptr</em>, </td>
  257. </tr>
  258. <tr>
  259. <td class="paramkey"></td>
  260. <td></td>
  261. <td class="paramtype">std::size_t&#160;</td>
  262. <td class="paramname"><em>size</em>&#160;</td>
  263. </tr>
  264. <tr>
  265. <td></td>
  266. <td>)</td>
  267. <td></td><td></td>
  268. </tr>
  269. </table>
  270. </td>
  271. <td class="mlabels-right">
  272. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  273. </tr>
  274. </table>
  275. </div><div class="memdoc">
  276. </div>
  277. </div>
  278. <a class="anchor" id="a2f2c91734a7de5affdd427fb88ee6167"></a>
  279. <div class="memitem">
  280. <div class="memproto">
  281. <div class="memtemplate">
  282. template&lt;class W , class R &gt; </div>
  283. <table class="mlabels">
  284. <tr>
  285. <td class="mlabels-left">
  286. <table class="memname">
  287. <tr>
  288. <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>
  289. <td>(</td>
  290. <td class="paramtype">R *&#160;</td>
  291. <td class="paramname"><em>msg</em>, </td>
  292. </tr>
  293. <tr>
  294. <td class="paramkey"></td>
  295. <td></td>
  296. <td class="paramtype">void *&#160;</td>
  297. <td class="paramname"><em>tag</em>&#160;</td>
  298. </tr>
  299. <tr>
  300. <td></td>
  301. <td>)</td>
  302. <td></td><td></td>
  303. </tr>
  304. </table>
  305. </td>
  306. <td class="mlabels-right">
  307. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  308. </tr>
  309. </table>
  310. </div><div class="memdoc">
  311. <p>Read a message of type <em>R</em> into <em>msg</em>. </p>
  312. <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><a class="el" href="classgrpc_1_1_async_reader_interface.html#aa644cf63c12ae8c9d5fda16a361f8a11" title="Read a message of type R into msg. ">AsyncReaderInterface::Read</a></em> on the same stream since reads on the same stream are delivered in order.</p>
  313. <dl class="params"><dt>Parameters</dt><dd>
  314. <table class="params">
  315. <tr><td class="paramdir">[out]</td><td class="paramname">msg</td><td>Where to eventually store the read message. </td></tr>
  316. <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The tag identifying the operation.</td></tr>
  317. </table>
  318. </dd>
  319. </dl>
  320. <p>Side effect: note that this method attempt to receive initial metadata for a stream if it hasn't yet been received. </p>
  321. <p>Implements <a class="el" href="classgrpc_1_1_async_reader_interface.html#aa644cf63c12ae8c9d5fda16a361f8a11">grpc::AsyncReaderInterface&lt; R &gt;</a>.</p>
  322. </div>
  323. </div>
  324. <a class="anchor" id="a169a2eb8bedfd7281b37c79fdd307eb2"></a>
  325. <div class="memitem">
  326. <div class="memproto">
  327. <div class="memtemplate">
  328. template&lt;class W , class R &gt; </div>
  329. <table class="mlabels">
  330. <tr>
  331. <td class="mlabels-left">
  332. <table class="memname">
  333. <tr>
  334. <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>
  335. <td>(</td>
  336. <td class="paramtype">void *&#160;</td>
  337. <td class="paramname"><em>tag</em></td><td>)</td>
  338. <td></td>
  339. </tr>
  340. </table>
  341. </td>
  342. <td class="mlabels-right">
  343. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  344. </tr>
  345. </table>
  346. </div><div class="memdoc">
  347. <p>See the <em><a class="el" href="classgrpc_1_1_client_async_streaming_interface.html#ad83bfe2febf4a6296b7d2646799b8174" title="Request notification of the reading of the initial metadata. ">ClientAsyncStreamingInterface.ReadInitialMetadata</a></em> method for semantics of this method. </p>
  348. <p>Side effect:</p>
  349. <ul>
  350. <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>
  351. </ul>
  352. <p>Implements <a class="el" href="classgrpc_1_1_client_async_streaming_interface.html#ad83bfe2febf4a6296b7d2646799b8174">grpc::ClientAsyncStreamingInterface</a>.</p>
  353. </div>
  354. </div>
  355. <a class="anchor" id="a07bcc3a0737c3bee3ef50def89af5fc7"></a>
  356. <div class="memitem">
  357. <div class="memproto">
  358. <div class="memtemplate">
  359. template&lt;class W , class R &gt; </div>
  360. <table class="mlabels">
  361. <tr>
  362. <td class="mlabels-left">
  363. <table class="memname">
  364. <tr>
  365. <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>
  366. <td>(</td>
  367. <td class="paramtype">const W &amp;&#160;</td>
  368. <td class="paramname"><em>msg</em>, </td>
  369. </tr>
  370. <tr>
  371. <td class="paramkey"></td>
  372. <td></td>
  373. <td class="paramtype">void *&#160;</td>
  374. <td class="paramname"><em>tag</em>&#160;</td>
  375. </tr>
  376. <tr>
  377. <td></td>
  378. <td>)</td>
  379. <td></td><td></td>
  380. </tr>
  381. </table>
  382. </td>
  383. <td class="mlabels-right">
  384. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  385. </tr>
  386. </table>
  387. </div><div class="memdoc">
  388. <p>Request the writing of <em>msg</em> with identifying tag <em>tag</em>. </p>
  389. <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><a class="el" href="classgrpc_1_1_async_reader_interface.html#aa644cf63c12ae8c9d5fda16a361f8a11" title="Read a message of type R into msg. ">AsyncReaderInterface::Read</a></em> </p>
  390. <dl class="params"><dt>Parameters</dt><dd>
  391. <table class="params">
  392. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>The message to be written. </td></tr>
  393. <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The tag identifying the operation. </td></tr>
  394. </table>
  395. </dd>
  396. </dl>
  397. <p>Implements <a class="el" href="classgrpc_1_1_async_writer_interface.html#a40c1091ac5cb5243c874da725ae291b4">grpc::AsyncWriterInterface&lt; W &gt;</a>.</p>
  398. </div>
  399. </div>
  400. <a class="anchor" id="abcea1a4d9d8f6f1070940b1997fe0125"></a>
  401. <div class="memitem">
  402. <div class="memproto">
  403. <div class="memtemplate">
  404. template&lt;class W , class R &gt; </div>
  405. <table class="mlabels">
  406. <tr>
  407. <td class="mlabels-left">
  408. <table class="memname">
  409. <tr>
  410. <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>
  411. <td>(</td>
  412. <td class="paramtype">const W &amp;&#160;</td>
  413. <td class="paramname"><em>msg</em>, </td>
  414. </tr>
  415. <tr>
  416. <td class="paramkey"></td>
  417. <td></td>
  418. <td class="paramtype"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&#160;</td>
  419. <td class="paramname"><em>options</em>, </td>
  420. </tr>
  421. <tr>
  422. <td class="paramkey"></td>
  423. <td></td>
  424. <td class="paramtype">void *&#160;</td>
  425. <td class="paramname"><em>tag</em>&#160;</td>
  426. </tr>
  427. <tr>
  428. <td></td>
  429. <td>)</td>
  430. <td></td><td></td>
  431. </tr>
  432. </table>
  433. </td>
  434. <td class="mlabels-right">
  435. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  436. </tr>
  437. </table>
  438. </div><div class="memdoc">
  439. <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>
  440. <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><a class="el" href="classgrpc_1_1_async_reader_interface.html#aa644cf63c12ae8c9d5fda16a361f8a11" title="Read a message of type R into msg. ">AsyncReaderInterface::Read</a></em> </p>
  441. <dl class="params"><dt>Parameters</dt><dd>
  442. <table class="params">
  443. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>The message to be written. </td></tr>
  444. <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>
  445. <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The tag identifying the operation. </td></tr>
  446. </table>
  447. </dd>
  448. </dl>
  449. <p>Implements <a class="el" href="classgrpc_1_1_async_writer_interface.html#a6a8480dbf5ad95384c929d9db91b6074">grpc::AsyncWriterInterface&lt; W &gt;</a>.</p>
  450. </div>
  451. </div>
  452. <a class="anchor" id="af3e090a0801f6bc524f959cd93e4cddc"></a>
  453. <div class="memitem">
  454. <div class="memproto">
  455. <div class="memtemplate">
  456. template&lt;class W , class R &gt; </div>
  457. <table class="mlabels">
  458. <tr>
  459. <td class="mlabels-left">
  460. <table class="memname">
  461. <tr>
  462. <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>
  463. <td>(</td>
  464. <td class="paramtype">void *&#160;</td>
  465. <td class="paramname"><em>tag</em></td><td>)</td>
  466. <td></td>
  467. </tr>
  468. </table>
  469. </td>
  470. <td class="mlabels-right">
  471. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  472. </tr>
  473. </table>
  474. </div><div class="memdoc">
  475. <p>Signal the client is done with the writes (half-close the client stream). </p>
  476. <p>Thread-safe with respect to <em><a class="el" href="classgrpc_1_1_async_reader_interface.html#aa644cf63c12ae8c9d5fda16a361f8a11" title="Read a message of type R into msg. ">AsyncReaderInterface::Read</a></em> </p>
  477. <dl class="params"><dt>Parameters</dt><dd>
  478. <table class="params">
  479. <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The tag identifying the operation. </td></tr>
  480. </table>
  481. </dd>
  482. </dl>
  483. <p>Implements <a class="el" href="classgrpc_1_1_client_async_reader_writer_interface.html#a878193880df68ab969b697f1fcd7dbc3">grpc::ClientAsyncReaderWriterInterface&lt; W, R &gt;</a>.</p>
  484. </div>
  485. </div>
  486. <hr/>The documentation for this class was generated from the following file:<ul>
  487. <li>include/grpc++/impl/codegen/<a class="el" href="impl_2codegen_2async__stream_8h_source.html">async_stream.h</a></li>
  488. </ul>
  489. </div><!-- contents -->
  490. <!-- start footer part -->
  491. <hr class="footer"/><address class="footer"><small>
  492. Generated on Wed Jun 21 2017 14:13:08 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  493. <img class="footer" src="doxygen.png" alt="doxygen"/>
  494. </a> 1.8.6
  495. </small></address>
  496. </body>
  497. </html>