classgrpc_1_1_server_async_reader_writer.html 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493
  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::ServerAsyncReaderWriter&lt; W, R &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_reader_writer.html">ServerAsyncReaderWriter</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> &#124;
  66. <a href="#friends">Friends</a> </div>
  67. <div class="headertitle">
  68. <div class="title">grpc::ServerAsyncReaderWriter&lt; W, R &gt; Class Template Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div>
  69. </div><!--header-->
  70. <div class="contents">
  71. <p>Async server-side API for doing bidirectional streaming RPCs, where the incoming message stream coming from the client has messages of type <em>R</em>, and the outgoing message stream coming from the server has messages of type <em>W</em>.
  72. <a href="classgrpc_1_1_server_async_reader_writer.html#details">More...</a></p>
  73. <p><code>#include &lt;<a class="el" href="grpcpp_2impl_2codegen_2async__stream_8h_source.html">async_stream.h</a>&gt;</code></p>
  74. <table class="memberdecls">
  75. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  76. Public Member Functions</h2></td></tr>
  77. <tr class="memitem:a6471b2baeaad0a1952628c67f948a703"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_async_reader_writer.html#a6471b2baeaad0a1952628c67f948a703">ServerAsyncReaderWriter</a> (<a class="el" href="classgrpc_1_1_server_context.html">ServerContext</a> *ctx)</td></tr>
  78. <tr class="separator:a6471b2baeaad0a1952628c67f948a703"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:a1c8e237a99a177ef68c37ad0de100499"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_async_reader_writer.html#a1c8e237a99a177ef68c37ad0de100499">SendInitialMetadata</a> (void *tag) override</td></tr>
  80. <tr class="memdesc:a1c8e237a99a177ef68c37ad0de100499"><td class="mdescLeft">&#160;</td><td class="mdescRight">See <em>ServerAsyncStreamingInterface::SendInitialMetadata</em> for semantics. <a href="#a1c8e237a99a177ef68c37ad0de100499">More...</a><br /></td></tr>
  81. <tr class="separator:a1c8e237a99a177ef68c37ad0de100499"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:a911d41783f644e170c017bb3032ca5c8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_async_reader_writer.html#a911d41783f644e170c017bb3032ca5c8">Read</a> (R *msg, void *tag) override</td></tr>
  83. <tr class="memdesc:a911d41783f644e170c017bb3032ca5c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read a message of type <em>R</em> into <em>msg</em>. <a href="#a911d41783f644e170c017bb3032ca5c8">More...</a><br /></td></tr>
  84. <tr class="separator:a911d41783f644e170c017bb3032ca5c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:a816fd9065473a24d4ab613ee2ecb19e1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_async_reader_writer.html#a816fd9065473a24d4ab613ee2ecb19e1">Write</a> (const W &amp;msg, void *tag) override</td></tr>
  86. <tr class="memdesc:a816fd9065473a24d4ab613ee2ecb19e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request the writing of <em>msg</em> with identifying tag <em>tag</em>. <a href="#a816fd9065473a24d4ab613ee2ecb19e1">More...</a><br /></td></tr>
  87. <tr class="separator:a816fd9065473a24d4ab613ee2ecb19e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:a325a7fa8669c6212f36da5cf59ffb80c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_async_reader_writer.html#a325a7fa8669c6212f36da5cf59ffb80c">Write</a> (const W &amp;msg, <a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> options, void *tag) override</td></tr>
  89. <tr class="memdesc:a325a7fa8669c6212f36da5cf59ffb80c"><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="#a325a7fa8669c6212f36da5cf59ffb80c">More...</a><br /></td></tr>
  90. <tr class="separator:a325a7fa8669c6212f36da5cf59ffb80c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:a0b682431b5045eb62adff98d33a78f46"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_async_reader_writer.html#a0b682431b5045eb62adff98d33a78f46">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>
  92. <tr class="memdesc:a0b682431b5045eb62adff98d33a78f46"><td class="mdescLeft">&#160;</td><td class="mdescRight">See the <em><a class="el" href="classgrpc_1_1_server_async_reader_writer_interface.html#ae0c34bdc113287e1937f653b8d3c3116" title="Request the writing of msg and coalesce it with trailing metadata which contains status, using WriteOptions options with identifying tag tag. ">ServerAsyncReaderWriterInterface.WriteAndFinish</a></em> method for semantics. <a href="#a0b682431b5045eb62adff98d33a78f46">More...</a><br /></td></tr>
  93. <tr class="separator:a0b682431b5045eb62adff98d33a78f46"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a75342152acd961b7fcf1317bec0b8c3a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_async_reader_writer.html#a75342152acd961b7fcf1317bec0b8c3a">Finish</a> (const <a class="el" href="classgrpc_1_1_status.html">Status</a> &amp;status, void *tag) override</td></tr>
  95. <tr class="memdesc:a75342152acd961b7fcf1317bec0b8c3a"><td class="mdescLeft">&#160;</td><td class="mdescRight">See the <em><a class="el" href="classgrpc_1_1_server_async_reader_writer_interface.html#a1d890ac278003381d74ae8d29215f349" title="Indicate that the stream is to be finished with a certain status code. ">ServerAsyncReaderWriterInterface.Finish</a></em> method for semantics. <a href="#a75342152acd961b7fcf1317bec0b8c3a">More...</a><br /></td></tr>
  96. <tr class="separator:a75342152acd961b7fcf1317bec0b8c3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <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>
  98. <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>
  99. <tr class="separator:aeace2295f3792ce24975361c300d641a inherit pub_methods_classgrpc_1_1internal_1_1_server_async_streaming_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <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>
  101. <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>
  102. <tr class="separator:a8ad846091252c112c4db0b41965e5a4c inherit pub_methods_classgrpc_1_1internal_1_1_async_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <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>
  104. <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>
  105. <tr class="separator:a02565abb7c6b4a7a49c0b29159194b66 inherit pub_methods_classgrpc_1_1internal_1_1_async_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="inherit_header pub_methods_classgrpc_1_1internal_1_1_async_reader_interface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1internal_1_1_async_reader_interface')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc_1_1internal_1_1_async_reader_interface.html">grpc::internal::AsyncReaderInterface&lt; R &gt;</a></td></tr>
  107. <tr class="memitem:a18fe4235232864c8770a562cc2aa1f3c inherit pub_methods_classgrpc_1_1internal_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_1internal_1_1_async_reader_interface.html#a18fe4235232864c8770a562cc2aa1f3c">~AsyncReaderInterface</a> ()</td></tr>
  108. <tr class="separator:a18fe4235232864c8770a562cc2aa1f3c inherit pub_methods_classgrpc_1_1internal_1_1_async_reader_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. </table><table class="memberdecls">
  110. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  111. Friends</h2></td></tr>
  112. <tr class="memitem:a8c3fa4c066981aae114e41c3f9340144"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_async_reader_writer.html#a8c3fa4c066981aae114e41c3f9340144">::grpc::Server</a></td></tr>
  113. <tr class="separator:a8c3fa4c066981aae114e41c3f9340144"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. </table>
  115. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  116. <div class="textblock"><h3>template&lt;class W, class R&gt;<br />
  117. class grpc::ServerAsyncReaderWriter&lt; W, R &gt;</h3>
  118. <p>Async server-side API for doing bidirectional streaming RPCs, where the incoming message stream coming from the client has messages of type <em>R</em>, and the outgoing message stream coming from the server has messages of type <em>W</em>. </p>
  119. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  120. <a id="a6471b2baeaad0a1952628c67f948a703"></a>
  121. <h2 class="memtitle"><span class="permalink"><a href="#a6471b2baeaad0a1952628c67f948a703">&#9670;&nbsp;</a></span>ServerAsyncReaderWriter()</h2>
  122. <div class="memitem">
  123. <div class="memproto">
  124. <div class="memtemplate">
  125. template&lt;class W , class R &gt; </div>
  126. <table class="mlabels">
  127. <tr>
  128. <td class="mlabels-left">
  129. <table class="memname">
  130. <tr>
  131. <td class="memname"><a class="el" href="classgrpc_1_1_server_async_reader_writer.html">grpc::ServerAsyncReaderWriter</a>&lt; W, R &gt;::<a class="el" href="classgrpc_1_1_server_async_reader_writer.html">ServerAsyncReaderWriter</a> </td>
  132. <td>(</td>
  133. <td class="paramtype"><a class="el" href="classgrpc_1_1_server_context.html">ServerContext</a> *&#160;</td>
  134. <td class="paramname"><em>ctx</em></td><td>)</td>
  135. <td></td>
  136. </tr>
  137. </table>
  138. </td>
  139. <td class="mlabels-right">
  140. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
  141. </tr>
  142. </table>
  143. </div><div class="memdoc">
  144. </div>
  145. </div>
  146. <h2 class="groupheader">Member Function Documentation</h2>
  147. <a id="a75342152acd961b7fcf1317bec0b8c3a"></a>
  148. <h2 class="memtitle"><span class="permalink"><a href="#a75342152acd961b7fcf1317bec0b8c3a">&#9670;&nbsp;</a></span>Finish()</h2>
  149. <div class="memitem">
  150. <div class="memproto">
  151. <div class="memtemplate">
  152. template&lt;class W , class R &gt; </div>
  153. <table class="mlabels">
  154. <tr>
  155. <td class="mlabels-left">
  156. <table class="memname">
  157. <tr>
  158. <td class="memname">void <a class="el" href="classgrpc_1_1_server_async_reader_writer.html">grpc::ServerAsyncReaderWriter</a>&lt; W, R &gt;::Finish </td>
  159. <td>(</td>
  160. <td class="paramtype">const <a class="el" href="classgrpc_1_1_status.html">Status</a> &amp;&#160;</td>
  161. <td class="paramname"><em>status</em>, </td>
  162. </tr>
  163. <tr>
  164. <td class="paramkey"></td>
  165. <td></td>
  166. <td class="paramtype">void *&#160;</td>
  167. <td class="paramname"><em>tag</em>&#160;</td>
  168. </tr>
  169. <tr>
  170. <td></td>
  171. <td>)</td>
  172. <td></td><td></td>
  173. </tr>
  174. </table>
  175. </td>
  176. <td class="mlabels-right">
  177. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  178. </tr>
  179. </table>
  180. </div><div class="memdoc">
  181. <p>See the <em><a class="el" href="classgrpc_1_1_server_async_reader_writer_interface.html#a1d890ac278003381d74ae8d29215f349" title="Indicate that the stream is to be finished with a certain status code. ">ServerAsyncReaderWriterInterface.Finish</a></em> method for semantics. </p>
  182. <p>Implicit input parameter:</p><ul>
  183. <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>
  184. </ul>
  185. <p>Note: there are no restrictions are the code of <em>status</em>, it may be non-OK </p>
  186. <p>Implements <a class="el" href="classgrpc_1_1_server_async_reader_writer_interface.html#a1d890ac278003381d74ae8d29215f349">grpc::ServerAsyncReaderWriterInterface&lt; W, R &gt;</a>.</p>
  187. </div>
  188. </div>
  189. <a id="a911d41783f644e170c017bb3032ca5c8"></a>
  190. <h2 class="memtitle"><span class="permalink"><a href="#a911d41783f644e170c017bb3032ca5c8">&#9670;&nbsp;</a></span>Read()</h2>
  191. <div class="memitem">
  192. <div class="memproto">
  193. <div class="memtemplate">
  194. template&lt;class W , class R &gt; </div>
  195. <table class="mlabels">
  196. <tr>
  197. <td class="mlabels-left">
  198. <table class="memname">
  199. <tr>
  200. <td class="memname">void <a class="el" href="classgrpc_1_1_server_async_reader_writer.html">grpc::ServerAsyncReaderWriter</a>&lt; W, R &gt;::Read </td>
  201. <td>(</td>
  202. <td class="paramtype">R *&#160;</td>
  203. <td class="paramname"><em>msg</em>, </td>
  204. </tr>
  205. <tr>
  206. <td class="paramkey"></td>
  207. <td></td>
  208. <td class="paramtype">void *&#160;</td>
  209. <td class="paramname"><em>tag</em>&#160;</td>
  210. </tr>
  211. <tr>
  212. <td></td>
  213. <td>)</td>
  214. <td></td><td></td>
  215. </tr>
  216. </table>
  217. </td>
  218. <td class="mlabels-right">
  219. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  220. </tr>
  221. </table>
  222. </div><div class="memdoc">
  223. <p>Read a message of type <em>R</em> into <em>msg</em>. </p>
  224. <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>AsyncReaderInterface::Read</em> on the same stream since reads on the same stream are delivered in order.</p>
  225. <dl class="params"><dt>Parameters</dt><dd>
  226. <table class="params">
  227. <tr><td class="paramdir">[out]</td><td class="paramname">msg</td><td>Where to eventually store the read message. </td></tr>
  228. <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The tag identifying the operation.</td></tr>
  229. </table>
  230. </dd>
  231. </dl>
  232. <p>Side effect: note that this method attempt to receive initial metadata for a stream if it hasn't yet been received. </p>
  233. <p>Implements <a class="el" href="classgrpc_1_1internal_1_1_async_reader_interface.html#adf87c602036d69158950b7299d0aae70">grpc::internal::AsyncReaderInterface&lt; R &gt;</a>.</p>
  234. </div>
  235. </div>
  236. <a id="a1c8e237a99a177ef68c37ad0de100499"></a>
  237. <h2 class="memtitle"><span class="permalink"><a href="#a1c8e237a99a177ef68c37ad0de100499">&#9670;&nbsp;</a></span>SendInitialMetadata()</h2>
  238. <div class="memitem">
  239. <div class="memproto">
  240. <div class="memtemplate">
  241. template&lt;class W , class R &gt; </div>
  242. <table class="mlabels">
  243. <tr>
  244. <td class="mlabels-left">
  245. <table class="memname">
  246. <tr>
  247. <td class="memname">void <a class="el" href="classgrpc_1_1_server_async_reader_writer.html">grpc::ServerAsyncReaderWriter</a>&lt; W, R &gt;::SendInitialMetadata </td>
  248. <td>(</td>
  249. <td class="paramtype">void *&#160;</td>
  250. <td class="paramname"><em>tag</em></td><td>)</td>
  251. <td></td>
  252. </tr>
  253. </table>
  254. </td>
  255. <td class="mlabels-right">
  256. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  257. </tr>
  258. </table>
  259. </div><div class="memdoc">
  260. <p>See <em>ServerAsyncStreamingInterface::SendInitialMetadata</em> for semantics. </p>
  261. <p>Implicit input parameter:</p><ul>
  262. <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>
  263. </ul>
  264. <dl class="params"><dt>Parameters</dt><dd>
  265. <table class="params">
  266. <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>Tag identifying this request. </td></tr>
  267. </table>
  268. </dd>
  269. </dl>
  270. <p>Implements <a class="el" href="classgrpc_1_1internal_1_1_server_async_streaming_interface.html#ac55759faf2283db8bf716183881efe01">grpc::internal::ServerAsyncStreamingInterface</a>.</p>
  271. </div>
  272. </div>
  273. <a id="a816fd9065473a24d4ab613ee2ecb19e1"></a>
  274. <h2 class="memtitle"><span class="permalink"><a href="#a816fd9065473a24d4ab613ee2ecb19e1">&#9670;&nbsp;</a></span>Write() <span class="overload">[1/2]</span></h2>
  275. <div class="memitem">
  276. <div class="memproto">
  277. <div class="memtemplate">
  278. template&lt;class W , class R &gt; </div>
  279. <table class="mlabels">
  280. <tr>
  281. <td class="mlabels-left">
  282. <table class="memname">
  283. <tr>
  284. <td class="memname">void <a class="el" href="classgrpc_1_1_server_async_reader_writer.html">grpc::ServerAsyncReaderWriter</a>&lt; W, R &gt;::Write </td>
  285. <td>(</td>
  286. <td class="paramtype">const W &amp;&#160;</td>
  287. <td class="paramname"><em>msg</em>, </td>
  288. </tr>
  289. <tr>
  290. <td class="paramkey"></td>
  291. <td></td>
  292. <td class="paramtype">void *&#160;</td>
  293. <td class="paramname"><em>tag</em>&#160;</td>
  294. </tr>
  295. <tr>
  296. <td></td>
  297. <td>)</td>
  298. <td></td><td></td>
  299. </tr>
  300. </table>
  301. </td>
  302. <td class="mlabels-right">
  303. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  304. </tr>
  305. </table>
  306. </div><div class="memdoc">
  307. <p>Request the writing of <em>msg</em> with identifying tag <em>tag</em>. </p>
  308. <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>
  309. <dl class="params"><dt>Parameters</dt><dd>
  310. <table class="params">
  311. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>The message to be written. </td></tr>
  312. <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The tag identifying the operation. </td></tr>
  313. </table>
  314. </dd>
  315. </dl>
  316. <p>Implements <a class="el" href="classgrpc_1_1internal_1_1_async_writer_interface.html#aa61e21fdfef0a4fb34f595bef767e6a8">grpc::internal::AsyncWriterInterface&lt; W &gt;</a>.</p>
  317. </div>
  318. </div>
  319. <a id="a325a7fa8669c6212f36da5cf59ffb80c"></a>
  320. <h2 class="memtitle"><span class="permalink"><a href="#a325a7fa8669c6212f36da5cf59ffb80c">&#9670;&nbsp;</a></span>Write() <span class="overload">[2/2]</span></h2>
  321. <div class="memitem">
  322. <div class="memproto">
  323. <div class="memtemplate">
  324. template&lt;class W , class R &gt; </div>
  325. <table class="mlabels">
  326. <tr>
  327. <td class="mlabels-left">
  328. <table class="memname">
  329. <tr>
  330. <td class="memname">void <a class="el" href="classgrpc_1_1_server_async_reader_writer.html">grpc::ServerAsyncReaderWriter</a>&lt; W, R &gt;::Write </td>
  331. <td>(</td>
  332. <td class="paramtype">const W &amp;&#160;</td>
  333. <td class="paramname"><em>msg</em>, </td>
  334. </tr>
  335. <tr>
  336. <td class="paramkey"></td>
  337. <td></td>
  338. <td class="paramtype"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&#160;</td>
  339. <td class="paramname"><em>options</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>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>
  360. <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>
  361. <dl class="params"><dt>Parameters</dt><dd>
  362. <table class="params">
  363. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>The message to be written. </td></tr>
  364. <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>
  365. <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The tag identifying the operation. </td></tr>
  366. </table>
  367. </dd>
  368. </dl>
  369. <p>Implements <a class="el" href="classgrpc_1_1internal_1_1_async_writer_interface.html#a5745991911afa0fb12646a5f79738a0d">grpc::internal::AsyncWriterInterface&lt; W &gt;</a>.</p>
  370. </div>
  371. </div>
  372. <a id="a0b682431b5045eb62adff98d33a78f46"></a>
  373. <h2 class="memtitle"><span class="permalink"><a href="#a0b682431b5045eb62adff98d33a78f46">&#9670;&nbsp;</a></span>WriteAndFinish()</h2>
  374. <div class="memitem">
  375. <div class="memproto">
  376. <div class="memtemplate">
  377. template&lt;class W , class R &gt; </div>
  378. <table class="mlabels">
  379. <tr>
  380. <td class="mlabels-left">
  381. <table class="memname">
  382. <tr>
  383. <td class="memname">void <a class="el" href="classgrpc_1_1_server_async_reader_writer.html">grpc::ServerAsyncReaderWriter</a>&lt; W, R &gt;::WriteAndFinish </td>
  384. <td>(</td>
  385. <td class="paramtype">const W &amp;&#160;</td>
  386. <td class="paramname"><em>msg</em>, </td>
  387. </tr>
  388. <tr>
  389. <td class="paramkey"></td>
  390. <td></td>
  391. <td class="paramtype"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&#160;</td>
  392. <td class="paramname"><em>options</em>, </td>
  393. </tr>
  394. <tr>
  395. <td class="paramkey"></td>
  396. <td></td>
  397. <td class="paramtype">const <a class="el" href="classgrpc_1_1_status.html">Status</a> &amp;&#160;</td>
  398. <td class="paramname"><em>status</em>, </td>
  399. </tr>
  400. <tr>
  401. <td class="paramkey"></td>
  402. <td></td>
  403. <td class="paramtype">void *&#160;</td>
  404. <td class="paramname"><em>tag</em>&#160;</td>
  405. </tr>
  406. <tr>
  407. <td></td>
  408. <td>)</td>
  409. <td></td><td></td>
  410. </tr>
  411. </table>
  412. </td>
  413. <td class="mlabels-right">
  414. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  415. </tr>
  416. </table>
  417. </div><div class="memdoc">
  418. <p>See the <em><a class="el" href="classgrpc_1_1_server_async_reader_writer_interface.html#ae0c34bdc113287e1937f653b8d3c3116" title="Request the writing of msg and coalesce it with trailing metadata which contains status, using WriteOptions options with identifying tag tag. ">ServerAsyncReaderWriterInterface.WriteAndFinish</a></em> method for semantics. </p>
  419. <p>Implicit input parameter:</p><ul>
  420. <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>
  421. </ul>
  422. <p>Note: <em>status</em> must have an OK code. </p>
  423. <p>Implements <a class="el" href="classgrpc_1_1_server_async_reader_writer_interface.html#ae0c34bdc113287e1937f653b8d3c3116">grpc::ServerAsyncReaderWriterInterface&lt; W, R &gt;</a>.</p>
  424. </div>
  425. </div>
  426. <h2 class="groupheader">Friends And Related Function Documentation</h2>
  427. <a id="a8c3fa4c066981aae114e41c3f9340144"></a>
  428. <h2 class="memtitle"><span class="permalink"><a href="#a8c3fa4c066981aae114e41c3f9340144">&#9670;&nbsp;</a></span>::grpc::Server</h2>
  429. <div class="memitem">
  430. <div class="memproto">
  431. <div class="memtemplate">
  432. template&lt;class W , class R &gt; </div>
  433. <table class="mlabels">
  434. <tr>
  435. <td class="mlabels-left">
  436. <table class="memname">
  437. <tr>
  438. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1_server.html">grpc::Server</a></td>
  439. </tr>
  440. </table>
  441. </td>
  442. <td class="mlabels-right">
  443. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  444. </tr>
  445. </table>
  446. </div><div class="memdoc">
  447. </div>
  448. </div>
  449. <hr/>The documentation for this class was generated from the following file:<ul>
  450. <li>include/grpcpp/impl/codegen/<a class="el" href="grpcpp_2impl_2codegen_2async__stream_8h_source.html">async_stream.h</a></li>
  451. </ul>
  452. </div><!-- contents -->
  453. <!-- start footer part -->
  454. <hr class="footer"/><address class="footer"><small>
  455. Generated on Tue May 15 2018 17:01:01 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  456. <img class="footer" src="doxygen.png" alt="doxygen"/>
  457. </a> 1.8.13
  458. </small></address>
  459. </body>
  460. </html>