classgrpc_1_1_client_async_writer_interface.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.17"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>GRPC C++: grpc::ClientAsyncWriterInterface&lt; W &gt; Class Template Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">GRPC C++
  25. &#160;<span id="projectnumber">1.36.1</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.17 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */</script>
  48. <div id="main-nav"></div>
  49. <!-- window showing the filter options -->
  50. <div id="MSearchSelectWindow"
  51. onmouseover="return searchBox.OnSearchSelectShow()"
  52. onmouseout="return searchBox.OnSearchSelectHide()"
  53. onkeydown="return searchBox.OnSearchSelectKey(event)">
  54. </div>
  55. <!-- iframe showing the search results (closed by default) -->
  56. <div id="MSearchResultsWindow">
  57. <iframe src="javascript:void(0)" frameborder="0"
  58. name="MSearchResults" id="MSearchResults">
  59. </iframe>
  60. </div>
  61. <div id="nav-path" class="navpath">
  62. <ul>
  63. <li class="navelem"><a class="el" href="namespacegrpc.html">grpc</a></li><li class="navelem"><a class="el" href="classgrpc_1_1_client_async_writer_interface.html">ClientAsyncWriterInterface</a></li> </ul>
  64. </div>
  65. </div><!-- top -->
  66. <div class="header">
  67. <div class="summary">
  68. <a href="#pub-methods">Public Member Functions</a> </div>
  69. <div class="headertitle">
  70. <div class="title">grpc::ClientAsyncWriterInterface&lt; W &gt; Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
  71. </div><!--header-->
  72. <div class="contents">
  73. <p>Common interface for client side asynchronous writing.
  74. <a href="classgrpc_1_1_client_async_writer_interface.html#details">More...</a></p>
  75. <p><code>#include &lt;<a class="el" href="grpcpp_2impl_2codegen_2async__stream_8h_source.html">async_stream.h</a>&gt;</code></p>
  76. <table class="memberdecls">
  77. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  78. Public Member Functions</h2></td></tr>
  79. <tr class="memitem:a488d42d85f8e34902401e013572ff822"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_async_writer_interface.html#a488d42d85f8e34902401e013572ff822">WritesDone</a> (void *tag)=0</td></tr>
  80. <tr class="memdesc:a488d42d85f8e34902401e013572ff822"><td class="mdescLeft">&#160;</td><td class="mdescRight">Signal the client is done with the writes (half-close the client stream). <a href="classgrpc_1_1_client_async_writer_interface.html#a488d42d85f8e34902401e013572ff822">More...</a><br /></td></tr>
  81. <tr class="separator:a488d42d85f8e34902401e013572ff822"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <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>
  83. <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>
  84. <tr class="separator:a5691ad84f8160a3eb10131f1f5de4708 inherit pub_methods_classgrpc_1_1internal_1_1_client_async_streaming_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:a2bd65338b34000980fa048911c577637 inherit pub_methods_classgrpc_1_1internal_1_1_client_async_streaming_interface"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_client_async_streaming_interface.html#a2bd65338b34000980fa048911c577637">StartCall</a> (void *tag)=0</td></tr>
  86. <tr class="memdesc:a2bd65338b34000980fa048911c577637 inherit pub_methods_classgrpc_1_1internal_1_1_client_async_streaming_interface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start the call that was set up by the constructor, but only if the constructor was invoked through the "Prepare" API which doesn't actually start the call. <a href="classgrpc_1_1internal_1_1_client_async_streaming_interface.html#a2bd65338b34000980fa048911c577637">More...</a><br /></td></tr>
  87. <tr class="separator:a2bd65338b34000980fa048911c577637 inherit pub_methods_classgrpc_1_1internal_1_1_client_async_streaming_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:ab5a35e289028ac2aaf062572ba6d567d inherit pub_methods_classgrpc_1_1internal_1_1_client_async_streaming_interface"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_client_async_streaming_interface.html#ab5a35e289028ac2aaf062572ba6d567d">ReadInitialMetadata</a> (void *tag)=0</td></tr>
  89. <tr class="memdesc:ab5a35e289028ac2aaf062572ba6d567d inherit pub_methods_classgrpc_1_1internal_1_1_client_async_streaming_interface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request notification of the reading of the initial metadata. <a href="classgrpc_1_1internal_1_1_client_async_streaming_interface.html#ab5a35e289028ac2aaf062572ba6d567d">More...</a><br /></td></tr>
  90. <tr class="separator:ab5a35e289028ac2aaf062572ba6d567d inherit pub_methods_classgrpc_1_1internal_1_1_client_async_streaming_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:a0c4fd4be2228fa196ae446502828e23a inherit pub_methods_classgrpc_1_1internal_1_1_client_async_streaming_interface"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_client_async_streaming_interface.html#a0c4fd4be2228fa196ae446502828e23a">Finish</a> (::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> *status, void *tag)=0</td></tr>
  92. <tr class="memdesc:a0c4fd4be2228fa196ae446502828e23a inherit pub_methods_classgrpc_1_1internal_1_1_client_async_streaming_interface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicate that the stream is to be finished and request notification for when the call has been ended. <a href="classgrpc_1_1internal_1_1_client_async_streaming_interface.html#a0c4fd4be2228fa196ae446502828e23a">More...</a><br /></td></tr>
  93. <tr class="separator:a0c4fd4be2228fa196ae446502828e23a inherit pub_methods_classgrpc_1_1internal_1_1_client_async_streaming_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <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>
  95. <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>
  96. <tr class="separator:a8ad846091252c112c4db0b41965e5a4c inherit pub_methods_classgrpc_1_1internal_1_1_async_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:aa61e21fdfef0a4fb34f595bef767e6a8 inherit pub_methods_classgrpc_1_1internal_1_1_async_writer_interface"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_async_writer_interface.html#aa61e21fdfef0a4fb34f595bef767e6a8">Write</a> (const W &amp;msg, void *tag)=0</td></tr>
  98. <tr class="memdesc:aa61e21fdfef0a4fb34f595bef767e6a8 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> with identifying tag <em>tag</em>. <a href="classgrpc_1_1internal_1_1_async_writer_interface.html#aa61e21fdfef0a4fb34f595bef767e6a8">More...</a><br /></td></tr>
  99. <tr class="separator:aa61e21fdfef0a4fb34f595bef767e6a8 inherit pub_methods_classgrpc_1_1internal_1_1_async_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:a9fef3a3ceb6be3a140ef4a8ad33c6c75 inherit pub_methods_classgrpc_1_1internal_1_1_async_writer_interface"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_async_writer_interface.html#a9fef3a3ceb6be3a140ef4a8ad33c6c75">Write</a> (const W &amp;msg, ::<a class="el" href="classgrpc_1_1_write_options.html">grpc::WriteOptions</a> options, void *tag)=0</td></tr>
  101. <tr class="memdesc:a9fef3a3ceb6be3a140ef4a8ad33c6c75 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> 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#a9fef3a3ceb6be3a140ef4a8ad33c6c75">More...</a><br /></td></tr>
  102. <tr class="separator:a9fef3a3ceb6be3a140ef4a8ad33c6c75 inherit pub_methods_classgrpc_1_1internal_1_1_async_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:a8dbc8f388cb8e79f587b821fd7d64ce7 inherit pub_methods_classgrpc_1_1internal_1_1_async_writer_interface"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_async_writer_interface.html#a8dbc8f388cb8e79f587b821fd7d64ce7">WriteLast</a> (const W &amp;msg, ::<a class="el" href="classgrpc_1_1_write_options.html">grpc::WriteOptions</a> options, void *tag)</td></tr>
  104. <tr class="memdesc:a8dbc8f388cb8e79f587b821fd7d64ce7 inherit pub_methods_classgrpc_1_1internal_1_1_async_writer_interface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request the writing of <em>msg</em> and coalesce it with the writing of trailing metadata, using <a class="el" href="classgrpc_1_1_write_options.html" title="Per-message write options.">WriteOptions</a> <em>options</em> with identifying tag <em>tag</em>. <a href="classgrpc_1_1internal_1_1_async_writer_interface.html#a8dbc8f388cb8e79f587b821fd7d64ce7">More...</a><br /></td></tr>
  105. <tr class="separator:a8dbc8f388cb8e79f587b821fd7d64ce7 inherit pub_methods_classgrpc_1_1internal_1_1_async_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. </table>
  107. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  108. <div class="textblock"><h3>template&lt;class W&gt;<br />
  109. class grpc::ClientAsyncWriterInterface&lt; W &gt;</h3>
  110. <p>Common interface for client side asynchronous writing. </p>
  111. </div><h2 class="groupheader">Member Function Documentation</h2>
  112. <a id="a488d42d85f8e34902401e013572ff822"></a>
  113. <h2 class="memtitle"><span class="permalink"><a href="#a488d42d85f8e34902401e013572ff822">&#9670;&nbsp;</a></span>WritesDone()</h2>
  114. <div class="memitem">
  115. <div class="memproto">
  116. <div class="memtemplate">
  117. template&lt;class W &gt; </div>
  118. <table class="mlabels">
  119. <tr>
  120. <td class="mlabels-left">
  121. <table class="memname">
  122. <tr>
  123. <td class="memname">virtual void <a class="el" href="classgrpc_1_1_client_async_writer_interface.html">grpc::ClientAsyncWriterInterface</a>&lt; W &gt;::WritesDone </td>
  124. <td>(</td>
  125. <td class="paramtype">void *&#160;</td>
  126. <td class="paramname"><em>tag</em></td><td>)</td>
  127. <td></td>
  128. </tr>
  129. </table>
  130. </td>
  131. <td class="mlabels-right">
  132. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  133. </tr>
  134. </table>
  135. </div><div class="memdoc">
  136. <p>Signal the client is done with the writes (half-close the client stream). </p>
  137. <p>Thread-safe with respect to <em>AsyncReaderInterface::Read</em> </p>
  138. <dl class="params"><dt>Parameters</dt><dd>
  139. <table class="params">
  140. <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The tag identifying the operation. </td></tr>
  141. </table>
  142. </dd>
  143. </dl>
  144. <p>Implemented in <a class="el" href="classgrpc_1_1_client_async_writer.html#ab9fd5cd7dedd73d878a86de84c58e8ff">grpc::ClientAsyncWriter&lt; W &gt;</a>.</p>
  145. </div>
  146. </div>
  147. <hr/>The documentation for this class was generated from the following file:<ul>
  148. <li>include/grpcpp/impl/codegen/<a class="el" href="grpcpp_2impl_2codegen_2async__stream_8h_source.html">async_stream.h</a></li>
  149. </ul>
  150. </div><!-- contents -->
  151. <!-- start footer part -->
  152. <hr class="footer"/><address class="footer"><small>
  153. Generated on Wed Mar 3 2021 19:17:24 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  154. <img class="footer" src="doxygen.png" alt="doxygen"/>
  155. </a> 1.8.17
  156. </small></address>
  157. </body>
  158. </html>