classgrpc_1_1_server_async_writer.html 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405
  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.13"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>GRPC C++: grpc::ServerAsyncWriter&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. <script type="text/javascript"> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-60127042-1', 'auto'); ga('send', 'pageview'); </script></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.13.0-dev</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.13 -->
  34. <script type="text/javascript">
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36. </script>
  37. <script type="text/javascript" src="menudata.js"></script>
  38. <script type="text/javascript" src="menu.js"></script>
  39. <script type="text/javascript">
  40. $(function() {
  41. initMenu('',true,false,'search.php','Search');
  42. $(document).ready(function() { init_search(); });
  43. });
  44. </script>
  45. <div id="main-nav"></div>
  46. <!-- window showing the filter options -->
  47. <div id="MSearchSelectWindow"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. onkeydown="return searchBox.OnSearchSelectKey(event)">
  51. </div>
  52. <!-- iframe showing the search results (closed by default) -->
  53. <div id="MSearchResultsWindow">
  54. <iframe src="javascript:void(0)" frameborder="0"
  55. name="MSearchResults" id="MSearchResults">
  56. </iframe>
  57. </div>
  58. <div id="nav-path" class="navpath">
  59. <ul>
  60. <li class="navelem"><a class="el" href="namespacegrpc.html">grpc</a></li><li class="navelem"><a class="el" href="classgrpc_1_1_server_async_writer.html">ServerAsyncWriter</a></li> </ul>
  61. </div>
  62. </div><!-- top -->
  63. <div class="header">
  64. <div class="summary">
  65. <a href="#pub-methods">Public Member Functions</a> </div>
  66. <div class="headertitle">
  67. <div class="title">grpc::ServerAsyncWriter&lt; W &gt; Class Template Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div>
  68. </div><!--header-->
  69. <div class="contents">
  70. <p>Async server-side API for doing server streaming RPCs, where the outgoing message stream from the server has messages of type <em>W</em>.
  71. <a href="classgrpc_1_1_server_async_writer.html#details">More...</a></p>
  72. <p><code>#include &lt;<a class="el" href="grpcpp_2impl_2codegen_2async__stream_8h_source.html">async_stream.h</a>&gt;</code></p>
  73. <table class="memberdecls">
  74. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  75. Public Member Functions</h2></td></tr>
  76. <tr class="memitem:aa841b99fddf9ce347b9c617058f179f2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_async_writer.html#aa841b99fddf9ce347b9c617058f179f2">ServerAsyncWriter</a> (<a class="el" href="classgrpc_1_1_server_context.html">ServerContext</a> *ctx)</td></tr>
  77. <tr class="separator:aa841b99fddf9ce347b9c617058f179f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:adbefffa0dd7ae810ed1c2bf877d46f96"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_async_writer.html#adbefffa0dd7ae810ed1c2bf877d46f96">SendInitialMetadata</a> (void *tag) override</td></tr>
  79. <tr class="memdesc:adbefffa0dd7ae810ed1c2bf877d46f96"><td class="mdescLeft">&#160;</td><td class="mdescRight">See <em>ServerAsyncStreamingInterface::SendInitialMetadata</em> for semantics. <a href="#adbefffa0dd7ae810ed1c2bf877d46f96">More...</a><br /></td></tr>
  80. <tr class="separator:adbefffa0dd7ae810ed1c2bf877d46f96"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:a467f70c7460ceb7738fb938b3bf93c85"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_async_writer.html#a467f70c7460ceb7738fb938b3bf93c85">Write</a> (const W &amp;msg, void *tag) override</td></tr>
  82. <tr class="memdesc:a467f70c7460ceb7738fb938b3bf93c85"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request the writing of <em>msg</em> with identifying tag <em>tag</em>. <a href="#a467f70c7460ceb7738fb938b3bf93c85">More...</a><br /></td></tr>
  83. <tr class="separator:a467f70c7460ceb7738fb938b3bf93c85"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:a370212343d5044083c218b5ee0fa0057"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_async_writer.html#a370212343d5044083c218b5ee0fa0057">Write</a> (const W &amp;msg, <a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> options, void *tag) override</td></tr>
  85. <tr class="memdesc:a370212343d5044083c218b5ee0fa0057"><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="#a370212343d5044083c218b5ee0fa0057">More...</a><br /></td></tr>
  86. <tr class="separator:a370212343d5044083c218b5ee0fa0057"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:a80866b79d44c03e3ad73199dbe91a21d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_async_writer.html#a80866b79d44c03e3ad73199dbe91a21d">WriteAndFinish</a> (const W &amp;msg, <a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> options, const <a class="el" href="classgrpc_1_1_status.html">Status</a> &amp;status, void *tag) override</td></tr>
  88. <tr class="memdesc:a80866b79d44c03e3ad73199dbe91a21d"><td class="mdescLeft">&#160;</td><td class="mdescRight">See the <em><a class="el" href="classgrpc_1_1_server_async_writer_interface.html#a6ef0f1e5f548977e0e98671b46fd80eb" title="Request the writing of msg and coalesce it with trailing metadata which contains status, using WriteOptions options with identifying tag tag. ">ServerAsyncWriterInterface.WriteAndFinish</a></em> method for semantics. <a href="#a80866b79d44c03e3ad73199dbe91a21d">More...</a><br /></td></tr>
  89. <tr class="separator:a80866b79d44c03e3ad73199dbe91a21d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a330082d0766d6867517a54919d650a20"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_async_writer.html#a330082d0766d6867517a54919d650a20">Finish</a> (const <a class="el" href="classgrpc_1_1_status.html">Status</a> &amp;status, void *tag) override</td></tr>
  91. <tr class="memdesc:a330082d0766d6867517a54919d650a20"><td class="mdescLeft">&#160;</td><td class="mdescRight">See the <em><a class="el" href="classgrpc_1_1_server_async_writer_interface.html#a52ecaf07a626039b4fd00bed98000152" title="Indicate that the stream is to be finished with a certain status code. ">ServerAsyncWriterInterface.Finish</a></em> method for semantics. <a href="#a330082d0766d6867517a54919d650a20">More...</a><br /></td></tr>
  92. <tr class="separator:a330082d0766d6867517a54919d650a20"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="inherit_header pub_methods_classgrpc_1_1internal_1_1_server_async_streaming_interface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1internal_1_1_server_async_streaming_interface')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc_1_1internal_1_1_server_async_streaming_interface.html">grpc::internal::ServerAsyncStreamingInterface</a></td></tr>
  94. <tr class="memitem:aeace2295f3792ce24975361c300d641a inherit pub_methods_classgrpc_1_1internal_1_1_server_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_server_async_streaming_interface.html#aeace2295f3792ce24975361c300d641a">~ServerAsyncStreamingInterface</a> ()</td></tr>
  95. <tr class="separator:aeace2295f3792ce24975361c300d641a inherit pub_methods_classgrpc_1_1internal_1_1_server_async_streaming_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <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>
  97. <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>
  98. <tr class="separator:a8ad846091252c112c4db0b41965e5a4c inherit pub_methods_classgrpc_1_1internal_1_1_async_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:a02565abb7c6b4a7a49c0b29159194b66 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#a02565abb7c6b4a7a49c0b29159194b66">WriteLast</a> (const W &amp;msg, <a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> options, void *tag)</td></tr>
  100. <tr class="memdesc:a02565abb7c6b4a7a49c0b29159194b66 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#a02565abb7c6b4a7a49c0b29159194b66">More...</a><br /></td></tr>
  101. <tr class="separator:a02565abb7c6b4a7a49c0b29159194b66 inherit pub_methods_classgrpc_1_1internal_1_1_async_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. </table>
  103. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  104. <div class="textblock"><h3>template&lt;class W&gt;<br />
  105. class grpc::ServerAsyncWriter&lt; W &gt;</h3>
  106. <p>Async server-side API for doing server streaming RPCs, where the outgoing message stream from the server has messages of type <em>W</em>. </p>
  107. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  108. <a id="aa841b99fddf9ce347b9c617058f179f2"></a>
  109. <h2 class="memtitle"><span class="permalink"><a href="#aa841b99fddf9ce347b9c617058f179f2">&#9670;&nbsp;</a></span>ServerAsyncWriter()</h2>
  110. <div class="memitem">
  111. <div class="memproto">
  112. <div class="memtemplate">
  113. template&lt;class W &gt; </div>
  114. <table class="mlabels">
  115. <tr>
  116. <td class="mlabels-left">
  117. <table class="memname">
  118. <tr>
  119. <td class="memname"><a class="el" href="classgrpc_1_1_server_async_writer.html">grpc::ServerAsyncWriter</a>&lt; W &gt;::<a class="el" href="classgrpc_1_1_server_async_writer.html">ServerAsyncWriter</a> </td>
  120. <td>(</td>
  121. <td class="paramtype"><a class="el" href="classgrpc_1_1_server_context.html">ServerContext</a> *&#160;</td>
  122. <td class="paramname"><em>ctx</em></td><td>)</td>
  123. <td></td>
  124. </tr>
  125. </table>
  126. </td>
  127. <td class="mlabels-right">
  128. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
  129. </tr>
  130. </table>
  131. </div><div class="memdoc">
  132. </div>
  133. </div>
  134. <h2 class="groupheader">Member Function Documentation</h2>
  135. <a id="a330082d0766d6867517a54919d650a20"></a>
  136. <h2 class="memtitle"><span class="permalink"><a href="#a330082d0766d6867517a54919d650a20">&#9670;&nbsp;</a></span>Finish()</h2>
  137. <div class="memitem">
  138. <div class="memproto">
  139. <div class="memtemplate">
  140. template&lt;class W &gt; </div>
  141. <table class="mlabels">
  142. <tr>
  143. <td class="mlabels-left">
  144. <table class="memname">
  145. <tr>
  146. <td class="memname">void <a class="el" href="classgrpc_1_1_server_async_writer.html">grpc::ServerAsyncWriter</a>&lt; W &gt;::Finish </td>
  147. <td>(</td>
  148. <td class="paramtype">const <a class="el" href="classgrpc_1_1_status.html">Status</a> &amp;&#160;</td>
  149. <td class="paramname"><em>status</em>, </td>
  150. </tr>
  151. <tr>
  152. <td class="paramkey"></td>
  153. <td></td>
  154. <td class="paramtype">void *&#160;</td>
  155. <td class="paramname"><em>tag</em>&#160;</td>
  156. </tr>
  157. <tr>
  158. <td></td>
  159. <td>)</td>
  160. <td></td><td></td>
  161. </tr>
  162. </table>
  163. </td>
  164. <td class="mlabels-right">
  165. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  166. </tr>
  167. </table>
  168. </div><div class="memdoc">
  169. <p>See the <em><a class="el" href="classgrpc_1_1_server_async_writer_interface.html#a52ecaf07a626039b4fd00bed98000152" title="Indicate that the stream is to be finished with a certain status code. ">ServerAsyncWriterInterface.Finish</a></em> method for semantics. </p>
  170. <p>Implicit input parameter:</p><ul>
  171. <li>the <em><a class="el" href="classgrpc_1_1_server_context.html" title="A ServerContext allows the person implementing a service handler to: ">ServerContext</a></em> associated with this call is used for sending trailing (and initial if not already sent) metadata to the client.</li>
  172. </ul>
  173. <p>Note: there are no restrictions are the code of <em>status</em>,it may be non-OK </p>
  174. <p>Implements <a class="el" href="classgrpc_1_1_server_async_writer_interface.html#a52ecaf07a626039b4fd00bed98000152">grpc::ServerAsyncWriterInterface&lt; W &gt;</a>.</p>
  175. </div>
  176. </div>
  177. <a id="adbefffa0dd7ae810ed1c2bf877d46f96"></a>
  178. <h2 class="memtitle"><span class="permalink"><a href="#adbefffa0dd7ae810ed1c2bf877d46f96">&#9670;&nbsp;</a></span>SendInitialMetadata()</h2>
  179. <div class="memitem">
  180. <div class="memproto">
  181. <div class="memtemplate">
  182. template&lt;class W &gt; </div>
  183. <table class="mlabels">
  184. <tr>
  185. <td class="mlabels-left">
  186. <table class="memname">
  187. <tr>
  188. <td class="memname">void <a class="el" href="classgrpc_1_1_server_async_writer.html">grpc::ServerAsyncWriter</a>&lt; W &gt;::SendInitialMetadata </td>
  189. <td>(</td>
  190. <td class="paramtype">void *&#160;</td>
  191. <td class="paramname"><em>tag</em></td><td>)</td>
  192. <td></td>
  193. </tr>
  194. </table>
  195. </td>
  196. <td class="mlabels-right">
  197. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  198. </tr>
  199. </table>
  200. </div><div class="memdoc">
  201. <p>See <em>ServerAsyncStreamingInterface::SendInitialMetadata</em> for semantics. </p>
  202. <p>Implicit input parameter:</p><ul>
  203. <li>The initial metadata that will be sent to the client from this op will be taken from the <em><a class="el" href="classgrpc_1_1_server_context.html" title="A ServerContext allows the person implementing a service handler to: ">ServerContext</a></em> associated with the call.</li>
  204. </ul>
  205. <dl class="params"><dt>Parameters</dt><dd>
  206. <table class="params">
  207. <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>Tag identifying this request. </td></tr>
  208. </table>
  209. </dd>
  210. </dl>
  211. <p>Implements <a class="el" href="classgrpc_1_1internal_1_1_server_async_streaming_interface.html#ac55759faf2283db8bf716183881efe01">grpc::internal::ServerAsyncStreamingInterface</a>.</p>
  212. </div>
  213. </div>
  214. <a id="a467f70c7460ceb7738fb938b3bf93c85"></a>
  215. <h2 class="memtitle"><span class="permalink"><a href="#a467f70c7460ceb7738fb938b3bf93c85">&#9670;&nbsp;</a></span>Write() <span class="overload">[1/2]</span></h2>
  216. <div class="memitem">
  217. <div class="memproto">
  218. <div class="memtemplate">
  219. template&lt;class W &gt; </div>
  220. <table class="mlabels">
  221. <tr>
  222. <td class="mlabels-left">
  223. <table class="memname">
  224. <tr>
  225. <td class="memname">void <a class="el" href="classgrpc_1_1_server_async_writer.html">grpc::ServerAsyncWriter</a>&lt; W &gt;::Write </td>
  226. <td>(</td>
  227. <td class="paramtype">const W &amp;&#160;</td>
  228. <td class="paramname"><em>msg</em>, </td>
  229. </tr>
  230. <tr>
  231. <td class="paramkey"></td>
  232. <td></td>
  233. <td class="paramtype">void *&#160;</td>
  234. <td class="paramname"><em>tag</em>&#160;</td>
  235. </tr>
  236. <tr>
  237. <td></td>
  238. <td>)</td>
  239. <td></td><td></td>
  240. </tr>
  241. </table>
  242. </td>
  243. <td class="mlabels-right">
  244. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  245. </tr>
  246. </table>
  247. </div><div class="memdoc">
  248. <p>Request the writing of <em>msg</em> with identifying tag <em>tag</em>. </p>
  249. <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>AsyncReaderInterface::Read</em> </p>
  250. <dl class="params"><dt>Parameters</dt><dd>
  251. <table class="params">
  252. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>The message to be written. </td></tr>
  253. <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The tag identifying the operation. </td></tr>
  254. </table>
  255. </dd>
  256. </dl>
  257. <p>Implements <a class="el" href="classgrpc_1_1internal_1_1_async_writer_interface.html#aa61e21fdfef0a4fb34f595bef767e6a8">grpc::internal::AsyncWriterInterface&lt; W &gt;</a>.</p>
  258. </div>
  259. </div>
  260. <a id="a370212343d5044083c218b5ee0fa0057"></a>
  261. <h2 class="memtitle"><span class="permalink"><a href="#a370212343d5044083c218b5ee0fa0057">&#9670;&nbsp;</a></span>Write() <span class="overload">[2/2]</span></h2>
  262. <div class="memitem">
  263. <div class="memproto">
  264. <div class="memtemplate">
  265. template&lt;class W &gt; </div>
  266. <table class="mlabels">
  267. <tr>
  268. <td class="mlabels-left">
  269. <table class="memname">
  270. <tr>
  271. <td class="memname">void <a class="el" href="classgrpc_1_1_server_async_writer.html">grpc::ServerAsyncWriter</a>&lt; W &gt;::Write </td>
  272. <td>(</td>
  273. <td class="paramtype">const W &amp;&#160;</td>
  274. <td class="paramname"><em>msg</em>, </td>
  275. </tr>
  276. <tr>
  277. <td class="paramkey"></td>
  278. <td></td>
  279. <td class="paramtype"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&#160;</td>
  280. <td class="paramname"><em>options</em>, </td>
  281. </tr>
  282. <tr>
  283. <td class="paramkey"></td>
  284. <td></td>
  285. <td class="paramtype">void *&#160;</td>
  286. <td class="paramname"><em>tag</em>&#160;</td>
  287. </tr>
  288. <tr>
  289. <td></td>
  290. <td>)</td>
  291. <td></td><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 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>
  301. <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>AsyncReaderInterface::Read</em> </p>
  302. <dl class="params"><dt>Parameters</dt><dd>
  303. <table class="params">
  304. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>The message to be written. </td></tr>
  305. <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>
  306. <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The tag identifying the operation. </td></tr>
  307. </table>
  308. </dd>
  309. </dl>
  310. <p>Implements <a class="el" href="classgrpc_1_1internal_1_1_async_writer_interface.html#a5745991911afa0fb12646a5f79738a0d">grpc::internal::AsyncWriterInterface&lt; W &gt;</a>.</p>
  311. </div>
  312. </div>
  313. <a id="a80866b79d44c03e3ad73199dbe91a21d"></a>
  314. <h2 class="memtitle"><span class="permalink"><a href="#a80866b79d44c03e3ad73199dbe91a21d">&#9670;&nbsp;</a></span>WriteAndFinish()</h2>
  315. <div class="memitem">
  316. <div class="memproto">
  317. <div class="memtemplate">
  318. template&lt;class W &gt; </div>
  319. <table class="mlabels">
  320. <tr>
  321. <td class="mlabels-left">
  322. <table class="memname">
  323. <tr>
  324. <td class="memname">void <a class="el" href="classgrpc_1_1_server_async_writer.html">grpc::ServerAsyncWriter</a>&lt; W &gt;::WriteAndFinish </td>
  325. <td>(</td>
  326. <td class="paramtype">const W &amp;&#160;</td>
  327. <td class="paramname"><em>msg</em>, </td>
  328. </tr>
  329. <tr>
  330. <td class="paramkey"></td>
  331. <td></td>
  332. <td class="paramtype"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&#160;</td>
  333. <td class="paramname"><em>options</em>, </td>
  334. </tr>
  335. <tr>
  336. <td class="paramkey"></td>
  337. <td></td>
  338. <td class="paramtype">const <a class="el" href="classgrpc_1_1_status.html">Status</a> &amp;&#160;</td>
  339. <td class="paramname"><em>status</em>, </td>
  340. </tr>
  341. <tr>
  342. <td class="paramkey"></td>
  343. <td></td>
  344. <td class="paramtype">void *&#160;</td>
  345. <td class="paramname"><em>tag</em>&#160;</td>
  346. </tr>
  347. <tr>
  348. <td></td>
  349. <td>)</td>
  350. <td></td><td></td>
  351. </tr>
  352. </table>
  353. </td>
  354. <td class="mlabels-right">
  355. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  356. </tr>
  357. </table>
  358. </div><div class="memdoc">
  359. <p>See the <em><a class="el" href="classgrpc_1_1_server_async_writer_interface.html#a6ef0f1e5f548977e0e98671b46fd80eb" title="Request the writing of msg and coalesce it with trailing metadata which contains status, using WriteOptions options with identifying tag tag. ">ServerAsyncWriterInterface.WriteAndFinish</a></em> method for semantics. </p>
  360. <p>Implicit input parameter:</p><ul>
  361. <li>the <em><a class="el" href="classgrpc_1_1_server_context.html" title="A ServerContext allows the person implementing a service handler to: ">ServerContext</a></em> associated with this call is used for sending trailing (and initial) metadata to the client.</li>
  362. </ul>
  363. <p>Note: <em>status</em> must have an OK code. </p>
  364. <p>Implements <a class="el" href="classgrpc_1_1_server_async_writer_interface.html#a6ef0f1e5f548977e0e98671b46fd80eb">grpc::ServerAsyncWriterInterface&lt; W &gt;</a>.</p>
  365. </div>
  366. </div>
  367. <hr/>The documentation for this class was generated from the following file:<ul>
  368. <li>include/grpcpp/impl/codegen/<a class="el" href="grpcpp_2impl_2codegen_2async__stream_8h_source.html">async_stream.h</a></li>
  369. </ul>
  370. </div><!-- contents -->
  371. <!-- start footer part -->
  372. <hr class="footer"/><address class="footer"><small>
  373. Generated on Tue May 15 2018 17:01:01 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  374. <img class="footer" src="doxygen.png" alt="doxygen"/>
  375. </a> 1.8.13
  376. </small></address>
  377. </body>
  378. </html>