classgrpc_1_1_server_writer.html 9.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209
  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::ServerWriter&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_server_writer.html">ServerWriter</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> &#124;
  69. <a href="#friends">Friends</a> </div>
  70. <div class="headertitle">
  71. <div class="title">grpc::ServerWriter&lt; W &gt; Class Template Reference</div> </div>
  72. </div><!--header-->
  73. <div class="contents">
  74. <p>Synchronous (blocking) server-side API for doing for doing a server-streaming RPCs, where the outgoing message stream coming from the server has messages of type <em>W</em>.
  75. <a href="classgrpc_1_1_server_writer.html#details">More...</a></p>
  76. <p><code>#include &lt;<a class="el" href="grpcpp_2impl_2codegen_2completion__queue_8h_source.html">completion_queue.h</a>&gt;</code></p>
  77. <table class="memberdecls">
  78. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  79. Public Member Functions</h2></td></tr>
  80. <tr class="memitem:a29dfe2774aa23975c5372031ce4bcda1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_writer.html#a29dfe2774aa23975c5372031ce4bcda1">SendInitialMetadata</a> () override</td></tr>
  81. <tr class="memdesc:a29dfe2774aa23975c5372031ce4bcda1"><td class="mdescLeft">&#160;</td><td class="mdescRight">See the <em>ServerStreamingInterface.SendInitialMetadata</em> method for semantics. <a href="classgrpc_1_1_server_writer.html#a29dfe2774aa23975c5372031ce4bcda1">More...</a><br /></td></tr>
  82. <tr class="separator:a29dfe2774aa23975c5372031ce4bcda1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:a4e6cab7fc6b351abc2de92cf5f8eca17"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_writer.html#a4e6cab7fc6b351abc2de92cf5f8eca17">Write</a> (const W &amp;msg, ::<a class="el" href="classgrpc_1_1_write_options.html">grpc::WriteOptions</a> options) override</td></tr>
  84. <tr class="separator:a4e6cab7fc6b351abc2de92cf5f8eca17"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. </table><table class="memberdecls">
  86. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  87. Friends</h2></td></tr>
  88. <tr class="memitem:a92a457fe95d4f1662f65ed9b47be0f84"><td class="memTemplParams" colspan="2">template&lt;class ServiceType , class RequestType , class ResponseType &gt; </td></tr>
  89. <tr class="memitem:a92a457fe95d4f1662f65ed9b47be0f84"><td class="memTemplItemLeft" align="right" valign="top">class&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_writer.html#a92a457fe95d4f1662f65ed9b47be0f84">internal::ServerStreamingHandler</a></td></tr>
  90. <tr class="separator:a92a457fe95d4f1662f65ed9b47be0f84"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. </table>
  92. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  93. <div class="textblock"><h3>template&lt;class W&gt;<br />
  94. class grpc::ServerWriter&lt; W &gt;</h3>
  95. <p>Synchronous (blocking) server-side API for doing for doing a server-streaming RPCs, where the outgoing message stream coming from the server has messages of type <em>W</em>. </p>
  96. </div><h2 class="groupheader">Member Function Documentation</h2>
  97. <a id="a29dfe2774aa23975c5372031ce4bcda1"></a>
  98. <h2 class="memtitle"><span class="permalink"><a href="#a29dfe2774aa23975c5372031ce4bcda1">&#9670;&nbsp;</a></span>SendInitialMetadata()</h2>
  99. <div class="memitem">
  100. <div class="memproto">
  101. <div class="memtemplate">
  102. template&lt;class W &gt; </div>
  103. <table class="mlabels">
  104. <tr>
  105. <td class="mlabels-left">
  106. <table class="memname">
  107. <tr>
  108. <td class="memname">void <a class="el" href="classgrpc_1_1_server_writer.html">grpc::ServerWriter</a>&lt; W &gt;::SendInitialMetadata </td>
  109. <td>(</td>
  110. <td class="paramname"></td><td>)</td>
  111. <td></td>
  112. </tr>
  113. </table>
  114. </td>
  115. <td class="mlabels-right">
  116. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span></span> </td>
  117. </tr>
  118. </table>
  119. </div><div class="memdoc">
  120. <p>See the <em>ServerStreamingInterface.SendInitialMetadata</em> method for semantics. </p>
  121. <p>Note that initial metadata will be affected by the <em><a class="el" href="classgrpc_1_1_server_context.html" title="A ServerContext or CallbackServerContext allows the code implementing a service handler to:">ServerContext</a></em> associated with this call. </p>
  122. </div>
  123. </div>
  124. <a id="a4e6cab7fc6b351abc2de92cf5f8eca17"></a>
  125. <h2 class="memtitle"><span class="permalink"><a href="#a4e6cab7fc6b351abc2de92cf5f8eca17">&#9670;&nbsp;</a></span>Write()</h2>
  126. <div class="memitem">
  127. <div class="memproto">
  128. <div class="memtemplate">
  129. template&lt;class W &gt; </div>
  130. <table class="mlabels">
  131. <tr>
  132. <td class="mlabels-left">
  133. <table class="memname">
  134. <tr>
  135. <td class="memname">bool <a class="el" href="classgrpc_1_1_server_writer.html">grpc::ServerWriter</a>&lt; W &gt;::Write </td>
  136. <td>(</td>
  137. <td class="paramtype">const W &amp;&#160;</td>
  138. <td class="paramname"><em>msg</em>, </td>
  139. </tr>
  140. <tr>
  141. <td class="paramkey"></td>
  142. <td></td>
  143. <td class="paramtype">::<a class="el" href="classgrpc_1_1_write_options.html">grpc::WriteOptions</a>&#160;</td>
  144. <td class="paramname"><em>options</em>&#160;</td>
  145. </tr>
  146. <tr>
  147. <td></td>
  148. <td>)</td>
  149. <td></td><td></td>
  150. </tr>
  151. </table>
  152. </td>
  153. <td class="mlabels-right">
  154. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span></span> </td>
  155. </tr>
  156. </table>
  157. </div><div class="memdoc">
  158. </div>
  159. </div>
  160. <h2 class="groupheader">Friends And Related Function Documentation</h2>
  161. <a id="a92a457fe95d4f1662f65ed9b47be0f84"></a>
  162. <h2 class="memtitle"><span class="permalink"><a href="#a92a457fe95d4f1662f65ed9b47be0f84">&#9670;&nbsp;</a></span>internal::ServerStreamingHandler</h2>
  163. <div class="memitem">
  164. <div class="memproto">
  165. <div class="memtemplate">
  166. template&lt;class W &gt; </div>
  167. <div class="memtemplate">
  168. template&lt;class ServiceType , class RequestType , class ResponseType &gt; </div>
  169. <table class="mlabels">
  170. <tr>
  171. <td class="mlabels-left">
  172. <table class="memname">
  173. <tr>
  174. <td class="memname">friend class <a class="el" href="classgrpc_1_1internal_1_1_server_streaming_handler.html">internal::ServerStreamingHandler</a></td>
  175. </tr>
  176. </table>
  177. </td>
  178. <td class="mlabels-right">
  179. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  180. </tr>
  181. </table>
  182. </div><div class="memdoc">
  183. </div>
  184. </div>
  185. <hr/>The documentation for this class was generated from the following files:<ul>
  186. <li>include/grpcpp/impl/codegen/<a class="el" href="grpcpp_2impl_2codegen_2completion__queue_8h_source.html">completion_queue.h</a></li>
  187. <li>include/grpcpp/impl/codegen/<a class="el" href="grpcpp_2impl_2codegen_2sync__stream_8h_source.html">sync_stream.h</a></li>
  188. </ul>
  189. </div><!-- contents -->
  190. <!-- start footer part -->
  191. <hr class="footer"/><address class="footer"><small>
  192. Generated on Wed Mar 3 2021 19:17:25 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  193. <img class="footer" src="doxygen.png" alt="doxygen"/>
  194. </a> 1.8.17
  195. </small></address>
  196. </body>
  197. </html>