classgrpc_1_1_client_writer_interface.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153
  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::ClientWriterInterface&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_writer_interface.html">ClientWriterInterface</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::ClientWriterInterface&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>Client-side interface for streaming writes of message type <em>W</em>.
  74. <a href="classgrpc_1_1_client_writer_interface.html#details">More...</a></p>
  75. <p><code>#include &lt;<a class="el" href="grpcpp_2impl_2codegen_2sync__stream_8h_source.html">sync_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:aff19574252338e9ac1b5446e82ed8ac5"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_writer_interface.html#aff19574252338e9ac1b5446e82ed8ac5">WritesDone</a> ()=0</td></tr>
  80. <tr class="memdesc:aff19574252338e9ac1b5446e82ed8ac5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Half close writing from the client. <a href="classgrpc_1_1_client_writer_interface.html#aff19574252338e9ac1b5446e82ed8ac5">More...</a><br /></td></tr>
  81. <tr class="separator:aff19574252338e9ac1b5446e82ed8ac5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="inherit_header pub_methods_classgrpc_1_1internal_1_1_client_streaming_interface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1internal_1_1_client_streaming_interface')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc_1_1internal_1_1_client_streaming_interface.html">grpc::internal::ClientStreamingInterface</a></td></tr>
  83. <tr class="memitem:ab1a7a2664187d88d0354b69138db7eb1 inherit pub_methods_classgrpc_1_1internal_1_1_client_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_streaming_interface.html#ab1a7a2664187d88d0354b69138db7eb1">~ClientStreamingInterface</a> ()</td></tr>
  84. <tr class="separator:ab1a7a2664187d88d0354b69138db7eb1 inherit pub_methods_classgrpc_1_1internal_1_1_client_streaming_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:aee6647289bab889e8fee849221ab66ec inherit pub_methods_classgrpc_1_1internal_1_1_client_streaming_interface"><td class="memItemLeft" align="right" valign="top">virtual ::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_client_streaming_interface.html#aee6647289bab889e8fee849221ab66ec">Finish</a> ()=0</td></tr>
  86. <tr class="memdesc:aee6647289bab889e8fee849221ab66ec inherit pub_methods_classgrpc_1_1internal_1_1_client_streaming_interface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Block waiting until the stream finishes and a final status of the call is available. <a href="classgrpc_1_1internal_1_1_client_streaming_interface.html#aee6647289bab889e8fee849221ab66ec">More...</a><br /></td></tr>
  87. <tr class="separator:aee6647289bab889e8fee849221ab66ec inherit pub_methods_classgrpc_1_1internal_1_1_client_streaming_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="inherit_header pub_methods_classgrpc_1_1internal_1_1_writer_interface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1internal_1_1_writer_interface')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc_1_1internal_1_1_writer_interface.html">grpc::internal::WriterInterface&lt; W &gt;</a></td></tr>
  89. <tr class="memitem:a0f3bb9c5625b43d600d33d2bf8c17b60 inherit pub_methods_classgrpc_1_1internal_1_1_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_writer_interface.html#a0f3bb9c5625b43d600d33d2bf8c17b60">~WriterInterface</a> ()</td></tr>
  90. <tr class="separator:a0f3bb9c5625b43d600d33d2bf8c17b60 inherit pub_methods_classgrpc_1_1internal_1_1_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:a8a0facf00dd7edb34f0ebb0247001449 inherit pub_methods_classgrpc_1_1internal_1_1_writer_interface"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_writer_interface.html#a8a0facf00dd7edb34f0ebb0247001449">Write</a> (const W &amp;msg, ::<a class="el" href="classgrpc_1_1_write_options.html">grpc::WriteOptions</a> options)=0</td></tr>
  92. <tr class="memdesc:a8a0facf00dd7edb34f0ebb0247001449 inherit pub_methods_classgrpc_1_1internal_1_1_writer_interface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Block to write <em>msg</em> to the stream with <a class="el" href="classgrpc_1_1_write_options.html" title="Per-message write options.">WriteOptions</a> <em>options</em>. <a href="classgrpc_1_1internal_1_1_writer_interface.html#a8a0facf00dd7edb34f0ebb0247001449">More...</a><br /></td></tr>
  93. <tr class="separator:a8a0facf00dd7edb34f0ebb0247001449 inherit pub_methods_classgrpc_1_1internal_1_1_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a89d051f5c00ede4469cfb216bd05b594 inherit pub_methods_classgrpc_1_1internal_1_1_writer_interface"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_writer_interface.html#a89d051f5c00ede4469cfb216bd05b594">Write</a> (const W &amp;msg)</td></tr>
  95. <tr class="memdesc:a89d051f5c00ede4469cfb216bd05b594 inherit pub_methods_classgrpc_1_1internal_1_1_writer_interface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Block to write <em>msg</em> to the stream with default write options. <a href="classgrpc_1_1internal_1_1_writer_interface.html#a89d051f5c00ede4469cfb216bd05b594">More...</a><br /></td></tr>
  96. <tr class="separator:a89d051f5c00ede4469cfb216bd05b594 inherit pub_methods_classgrpc_1_1internal_1_1_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:ab43631883751b02971d5a1467cf1022b inherit pub_methods_classgrpc_1_1internal_1_1_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_writer_interface.html#ab43631883751b02971d5a1467cf1022b">WriteLast</a> (const W &amp;msg, ::<a class="el" href="classgrpc_1_1_write_options.html">grpc::WriteOptions</a> options)</td></tr>
  98. <tr class="memdesc:ab43631883751b02971d5a1467cf1022b inherit pub_methods_classgrpc_1_1internal_1_1_writer_interface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write <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>. <a href="classgrpc_1_1internal_1_1_writer_interface.html#ab43631883751b02971d5a1467cf1022b">More...</a><br /></td></tr>
  99. <tr class="separator:ab43631883751b02971d5a1467cf1022b inherit pub_methods_classgrpc_1_1internal_1_1_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. </table>
  101. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  102. <div class="textblock"><h3>template&lt;class W&gt;<br />
  103. class grpc::ClientWriterInterface&lt; W &gt;</h3>
  104. <p>Client-side interface for streaming writes of message type <em>W</em>. </p>
  105. </div><h2 class="groupheader">Member Function Documentation</h2>
  106. <a id="aff19574252338e9ac1b5446e82ed8ac5"></a>
  107. <h2 class="memtitle"><span class="permalink"><a href="#aff19574252338e9ac1b5446e82ed8ac5">&#9670;&nbsp;</a></span>WritesDone()</h2>
  108. <div class="memitem">
  109. <div class="memproto">
  110. <div class="memtemplate">
  111. template&lt;class W &gt; </div>
  112. <table class="mlabels">
  113. <tr>
  114. <td class="mlabels-left">
  115. <table class="memname">
  116. <tr>
  117. <td class="memname">virtual bool <a class="el" href="classgrpc_1_1_client_writer_interface.html">grpc::ClientWriterInterface</a>&lt; W &gt;::WritesDone </td>
  118. <td>(</td>
  119. <td class="paramname"></td><td>)</td>
  120. <td></td>
  121. </tr>
  122. </table>
  123. </td>
  124. <td class="mlabels-right">
  125. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  126. </tr>
  127. </table>
  128. </div><div class="memdoc">
  129. <p>Half close writing from the client. </p>
  130. <p>(signal that the stream of messages coming from the client is complete). Blocks until currently-pending writes are completed. Thread safe with respect to <em>ReaderInterface::Read</em> operations only</p>
  131. <dl class="section return"><dt>Returns</dt><dd>Whether the writes were successful. </dd></dl>
  132. </div>
  133. </div>
  134. <hr/>The documentation for this class was generated from the following file:<ul>
  135. <li>include/grpcpp/impl/codegen/<a class="el" href="grpcpp_2impl_2codegen_2sync__stream_8h_source.html">sync_stream.h</a></li>
  136. </ul>
  137. </div><!-- contents -->
  138. <!-- start footer part -->
  139. <hr class="footer"/><address class="footer"><small>
  140. Generated on Wed Mar 3 2021 19:17:24 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  141. <img class="footer" src="doxygen.png" alt="doxygen"/>
  142. </a> 1.8.17
  143. </small></address>
  144. </body>
  145. </html>