classgrpc_1_1_server_async_reader_writer.html 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506
  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.6"/>
  7. <title>GRPC C++: grpc::ServerAsyncReaderWriter&lt; W, R &gt; Class Template Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="search/search.js"></script>
  13. <script type="text/javascript">
  14. $(document).ready(function() { searchBox.OnSelectItem(0); });
  15. </script>
  16. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr style="height: 56px;">
  24. <td style="padding-left: 0.5em;">
  25. <div id="projectname">GRPC C++
  26. &#160;<span id="projectnumber">1.8.0</span>
  27. </div>
  28. </td>
  29. </tr>
  30. </tbody>
  31. </table>
  32. </div>
  33. <!-- end header part -->
  34. <!-- Generated by Doxygen 1.8.6 -->
  35. <script type="text/javascript">
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. </script>
  38. <div id="navrow1" class="tabs">
  39. <ul class="tablist">
  40. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  41. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  42. <li><a href="modules.html"><span>Modules</span></a></li>
  43. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  44. <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  45. <li><a href="files.html"><span>Files</span></a></li>
  46. <li>
  47. <div id="MSearchBox" class="MSearchBoxInactive">
  48. <span class="left">
  49. <img id="MSearchSelect" src="search/mag_sel.png"
  50. onmouseover="return searchBox.OnSearchSelectShow()"
  51. onmouseout="return searchBox.OnSearchSelectHide()"
  52. alt=""/>
  53. <input type="text" id="MSearchField" value="Search" accesskey="S"
  54. onfocus="searchBox.OnSearchFieldFocus(true)"
  55. onblur="searchBox.OnSearchFieldFocus(false)"
  56. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  57. </span><span class="right">
  58. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  59. </span>
  60. </div>
  61. </li>
  62. </ul>
  63. </div>
  64. <div id="navrow2" class="tabs2">
  65. <ul class="tablist">
  66. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  67. <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
  68. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  69. <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
  70. </ul>
  71. </div>
  72. <!-- window showing the filter options -->
  73. <div id="MSearchSelectWindow"
  74. onmouseover="return searchBox.OnSearchSelectShow()"
  75. onmouseout="return searchBox.OnSearchSelectHide()"
  76. onkeydown="return searchBox.OnSearchSelectKey(event)">
  77. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(12)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  78. <!-- iframe showing the search results (closed by default) -->
  79. <div id="MSearchResultsWindow">
  80. <iframe src="javascript:void(0)" frameborder="0"
  81. name="MSearchResults" id="MSearchResults">
  82. </iframe>
  83. </div>
  84. <div id="nav-path" class="navpath">
  85. <ul>
  86. <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>
  87. </div>
  88. </div><!-- top -->
  89. <div class="header">
  90. <div class="summary">
  91. <a href="#pub-methods">Public Member Functions</a> &#124;
  92. <a href="#friends">Friends</a> </div>
  93. <div class="headertitle">
  94. <div class="title">grpc::ServerAsyncReaderWriter&lt; W, R &gt; Class Template Reference<span class="mlabels"><span class="mlabel">final</span></span></div> </div>
  95. </div><!--header-->
  96. <div class="contents">
  97. <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>.
  98. <a href="classgrpc_1_1_server_async_reader_writer.html#details">More...</a></p>
  99. <p><code>#include &lt;<a class="el" href="impl_2codegen_2async__stream_8h_source.html">async_stream.h</a>&gt;</code></p>
  100. <table class="memberdecls">
  101. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  102. Public Member Functions</h2></td></tr>
  103. <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>
  104. <tr class="separator:a6471b2baeaad0a1952628c67f948a703"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <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>
  106. <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>
  107. <tr class="separator:a1c8e237a99a177ef68c37ad0de100499"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <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>
  109. <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>
  110. <tr class="separator:a911d41783f644e170c017bb3032ca5c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <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>
  112. <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>
  113. <tr class="separator:a816fd9065473a24d4ab613ee2ecb19e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <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>
  115. <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>
  116. <tr class="separator:a325a7fa8669c6212f36da5cf59ffb80c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <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>
  118. <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>
  119. <tr class="separator:a0b682431b5045eb62adff98d33a78f46"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <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>
  121. <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>
  122. <tr class="separator:a75342152acd961b7fcf1317bec0b8c3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <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>
  124. <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>
  125. <tr class="separator:aeace2295f3792ce24975361c300d641a inherit pub_methods_classgrpc_1_1internal_1_1_server_async_streaming_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <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>
  127. <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>
  128. <tr class="separator:a8ad846091252c112c4db0b41965e5a4c inherit pub_methods_classgrpc_1_1internal_1_1_async_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <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>
  130. <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="#a02565abb7c6b4a7a49c0b29159194b66">More...</a><br/></td></tr>
  131. <tr class="separator:a02565abb7c6b4a7a49c0b29159194b66 inherit pub_methods_classgrpc_1_1internal_1_1_async_writer_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <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>
  133. <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>
  134. <tr class="separator:a18fe4235232864c8770a562cc2aa1f3c inherit pub_methods_classgrpc_1_1internal_1_1_async_reader_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. </table><table class="memberdecls">
  136. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  137. Friends</h2></td></tr>
  138. <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>
  139. <tr class="separator:a8c3fa4c066981aae114e41c3f9340144"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. </table>
  141. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  142. <div class="textblock"><h3>template&lt;class W, class R&gt;<br/>
  143. class grpc::ServerAsyncReaderWriter&lt; W, R &gt;</h3>
  144. <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>
  145. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  146. <a class="anchor" id="a6471b2baeaad0a1952628c67f948a703"></a>
  147. <div class="memitem">
  148. <div class="memproto">
  149. <div class="memtemplate">
  150. template&lt;class W , class R &gt; </div>
  151. <table class="mlabels">
  152. <tr>
  153. <td class="mlabels-left">
  154. <table class="memname">
  155. <tr>
  156. <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>
  157. <td>(</td>
  158. <td class="paramtype"><a class="el" href="classgrpc_1_1_server_context.html">ServerContext</a> *&#160;</td>
  159. <td class="paramname"><em>ctx</em></td><td>)</td>
  160. <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">explicit</span></span> </td>
  166. </tr>
  167. </table>
  168. </div><div class="memdoc">
  169. </div>
  170. </div>
  171. <h2 class="groupheader">Member Function Documentation</h2>
  172. <a class="anchor" id="a75342152acd961b7fcf1317bec0b8c3a"></a>
  173. <div class="memitem">
  174. <div class="memproto">
  175. <div class="memtemplate">
  176. template&lt;class W , class R &gt; </div>
  177. <table class="mlabels">
  178. <tr>
  179. <td class="mlabels-left">
  180. <table class="memname">
  181. <tr>
  182. <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>
  183. <td>(</td>
  184. <td class="paramtype">const <a class="el" href="classgrpc_1_1_status.html">Status</a> &amp;&#160;</td>
  185. <td class="paramname"><em>status</em>, </td>
  186. </tr>
  187. <tr>
  188. <td class="paramkey"></td>
  189. <td></td>
  190. <td class="paramtype">void *&#160;</td>
  191. <td class="paramname"><em>tag</em>&#160;</td>
  192. </tr>
  193. <tr>
  194. <td></td>
  195. <td>)</td>
  196. <td></td><td></td>
  197. </tr>
  198. </table>
  199. </td>
  200. <td class="mlabels-right">
  201. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  202. </tr>
  203. </table>
  204. </div><div class="memdoc">
  205. <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>
  206. <p>Implicit input parameter:</p>
  207. <ul>
  208. <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>
  209. </ul>
  210. <p>Note: there are no restrictions are the code of <em>status</em>, it may be non-OK </p>
  211. <p>Implements <a class="el" href="classgrpc_1_1_server_async_reader_writer_interface.html#a1d890ac278003381d74ae8d29215f349">grpc::ServerAsyncReaderWriterInterface&lt; W, R &gt;</a>.</p>
  212. </div>
  213. </div>
  214. <a class="anchor" id="a911d41783f644e170c017bb3032ca5c8"></a>
  215. <div class="memitem">
  216. <div class="memproto">
  217. <div class="memtemplate">
  218. template&lt;class W , class R &gt; </div>
  219. <table class="mlabels">
  220. <tr>
  221. <td class="mlabels-left">
  222. <table class="memname">
  223. <tr>
  224. <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>
  225. <td>(</td>
  226. <td class="paramtype">R *&#160;</td>
  227. <td class="paramname"><em>msg</em>, </td>
  228. </tr>
  229. <tr>
  230. <td class="paramkey"></td>
  231. <td></td>
  232. <td class="paramtype">void *&#160;</td>
  233. <td class="paramname"><em>tag</em>&#160;</td>
  234. </tr>
  235. <tr>
  236. <td></td>
  237. <td>)</td>
  238. <td></td><td></td>
  239. </tr>
  240. </table>
  241. </td>
  242. <td class="mlabels-right">
  243. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  244. </tr>
  245. </table>
  246. </div><div class="memdoc">
  247. <p>Read a message of type <em>R</em> into <em>msg</em>. </p>
  248. <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>
  249. <dl class="params"><dt>Parameters</dt><dd>
  250. <table class="params">
  251. <tr><td class="paramdir">[out]</td><td class="paramname">msg</td><td>Where to eventually store the read message. </td></tr>
  252. <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The tag identifying the operation.</td></tr>
  253. </table>
  254. </dd>
  255. </dl>
  256. <p>Side effect: note that this method attempt to receive initial metadata for a stream if it hasn't yet been received. </p>
  257. <p>Implements <a class="el" href="classgrpc_1_1internal_1_1_async_reader_interface.html#adf87c602036d69158950b7299d0aae70">grpc::internal::AsyncReaderInterface&lt; R &gt;</a>.</p>
  258. </div>
  259. </div>
  260. <a class="anchor" id="a1c8e237a99a177ef68c37ad0de100499"></a>
  261. <div class="memitem">
  262. <div class="memproto">
  263. <div class="memtemplate">
  264. template&lt;class W , class R &gt; </div>
  265. <table class="mlabels">
  266. <tr>
  267. <td class="mlabels-left">
  268. <table class="memname">
  269. <tr>
  270. <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>
  271. <td>(</td>
  272. <td class="paramtype">void *&#160;</td>
  273. <td class="paramname"><em>tag</em></td><td>)</td>
  274. <td></td>
  275. </tr>
  276. </table>
  277. </td>
  278. <td class="mlabels-right">
  279. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  280. </tr>
  281. </table>
  282. </div><div class="memdoc">
  283. <p>See <em>ServerAsyncStreamingInterface::SendInitialMetadata</em> for semantics. </p>
  284. <p>Implicit input parameter:</p>
  285. <ul>
  286. <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>
  287. </ul>
  288. <dl class="params"><dt>Parameters</dt><dd>
  289. <table class="params">
  290. <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>Tag identifying this request. </td></tr>
  291. </table>
  292. </dd>
  293. </dl>
  294. <p>Implements <a class="el" href="classgrpc_1_1internal_1_1_server_async_streaming_interface.html#ac55759faf2283db8bf716183881efe01">grpc::internal::ServerAsyncStreamingInterface</a>.</p>
  295. </div>
  296. </div>
  297. <a class="anchor" id="a816fd9065473a24d4ab613ee2ecb19e1"></a>
  298. <div class="memitem">
  299. <div class="memproto">
  300. <div class="memtemplate">
  301. template&lt;class W , class R &gt; </div>
  302. <table class="mlabels">
  303. <tr>
  304. <td class="mlabels-left">
  305. <table class="memname">
  306. <tr>
  307. <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>
  308. <td>(</td>
  309. <td class="paramtype">const W &amp;&#160;</td>
  310. <td class="paramname"><em>msg</em>, </td>
  311. </tr>
  312. <tr>
  313. <td class="paramkey"></td>
  314. <td></td>
  315. <td class="paramtype">void *&#160;</td>
  316. <td class="paramname"><em>tag</em>&#160;</td>
  317. </tr>
  318. <tr>
  319. <td></td>
  320. <td>)</td>
  321. <td></td><td></td>
  322. </tr>
  323. </table>
  324. </td>
  325. <td class="mlabels-right">
  326. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  327. </tr>
  328. </table>
  329. </div><div class="memdoc">
  330. <p>Request the writing of <em>msg</em> with identifying tag <em>tag</em>. </p>
  331. <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>
  332. <dl class="params"><dt>Parameters</dt><dd>
  333. <table class="params">
  334. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>The message to be written. </td></tr>
  335. <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The tag identifying the operation. </td></tr>
  336. </table>
  337. </dd>
  338. </dl>
  339. <p>Implements <a class="el" href="classgrpc_1_1internal_1_1_async_writer_interface.html#aa61e21fdfef0a4fb34f595bef767e6a8">grpc::internal::AsyncWriterInterface&lt; W &gt;</a>.</p>
  340. </div>
  341. </div>
  342. <a class="anchor" id="a325a7fa8669c6212f36da5cf59ffb80c"></a>
  343. <div class="memitem">
  344. <div class="memproto">
  345. <div class="memtemplate">
  346. template&lt;class W , class R &gt; </div>
  347. <table class="mlabels">
  348. <tr>
  349. <td class="mlabels-left">
  350. <table class="memname">
  351. <tr>
  352. <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>
  353. <td>(</td>
  354. <td class="paramtype">const W &amp;&#160;</td>
  355. <td class="paramname"><em>msg</em>, </td>
  356. </tr>
  357. <tr>
  358. <td class="paramkey"></td>
  359. <td></td>
  360. <td class="paramtype"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&#160;</td>
  361. <td class="paramname"><em>options</em>, </td>
  362. </tr>
  363. <tr>
  364. <td class="paramkey"></td>
  365. <td></td>
  366. <td class="paramtype">void *&#160;</td>
  367. <td class="paramname"><em>tag</em>&#160;</td>
  368. </tr>
  369. <tr>
  370. <td></td>
  371. <td>)</td>
  372. <td></td><td></td>
  373. </tr>
  374. </table>
  375. </td>
  376. <td class="mlabels-right">
  377. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  378. </tr>
  379. </table>
  380. </div><div class="memdoc">
  381. <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>
  382. <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>
  383. <dl class="params"><dt>Parameters</dt><dd>
  384. <table class="params">
  385. <tr><td class="paramdir">[in]</td><td class="paramname">msg</td><td>The message to be written. </td></tr>
  386. <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>
  387. <tr><td class="paramdir">[in]</td><td class="paramname">tag</td><td>The tag identifying the operation. </td></tr>
  388. </table>
  389. </dd>
  390. </dl>
  391. <p>Implements <a class="el" href="classgrpc_1_1internal_1_1_async_writer_interface.html#a5745991911afa0fb12646a5f79738a0d">grpc::internal::AsyncWriterInterface&lt; W &gt;</a>.</p>
  392. </div>
  393. </div>
  394. <a class="anchor" id="a0b682431b5045eb62adff98d33a78f46"></a>
  395. <div class="memitem">
  396. <div class="memproto">
  397. <div class="memtemplate">
  398. template&lt;class W , class R &gt; </div>
  399. <table class="mlabels">
  400. <tr>
  401. <td class="mlabels-left">
  402. <table class="memname">
  403. <tr>
  404. <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>
  405. <td>(</td>
  406. <td class="paramtype">const W &amp;&#160;</td>
  407. <td class="paramname"><em>msg</em>, </td>
  408. </tr>
  409. <tr>
  410. <td class="paramkey"></td>
  411. <td></td>
  412. <td class="paramtype"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&#160;</td>
  413. <td class="paramname"><em>options</em>, </td>
  414. </tr>
  415. <tr>
  416. <td class="paramkey"></td>
  417. <td></td>
  418. <td class="paramtype">const <a class="el" href="classgrpc_1_1_status.html">Status</a> &amp;&#160;</td>
  419. <td class="paramname"><em>status</em>, </td>
  420. </tr>
  421. <tr>
  422. <td class="paramkey"></td>
  423. <td></td>
  424. <td class="paramtype">void *&#160;</td>
  425. <td class="paramname"><em>tag</em>&#160;</td>
  426. </tr>
  427. <tr>
  428. <td></td>
  429. <td>)</td>
  430. <td></td><td></td>
  431. </tr>
  432. </table>
  433. </td>
  434. <td class="mlabels-right">
  435. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  436. </tr>
  437. </table>
  438. </div><div class="memdoc">
  439. <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>
  440. <p>Implicit input parameter:</p>
  441. <ul>
  442. <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>
  443. </ul>
  444. <p>Note: <em>status</em> must have an OK code. </p>
  445. <p>Implements <a class="el" href="classgrpc_1_1_server_async_reader_writer_interface.html#ae0c34bdc113287e1937f653b8d3c3116">grpc::ServerAsyncReaderWriterInterface&lt; W, R &gt;</a>.</p>
  446. </div>
  447. </div>
  448. <h2 class="groupheader">Friends And Related Function Documentation</h2>
  449. <a class="anchor" id="a8c3fa4c066981aae114e41c3f9340144"></a>
  450. <div class="memitem">
  451. <div class="memproto">
  452. <div class="memtemplate">
  453. template&lt;class W , class R &gt; </div>
  454. <table class="mlabels">
  455. <tr>
  456. <td class="mlabels-left">
  457. <table class="memname">
  458. <tr>
  459. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1_server.html">grpc::Server</a></td>
  460. </tr>
  461. </table>
  462. </td>
  463. <td class="mlabels-right">
  464. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  465. </tr>
  466. </table>
  467. </div><div class="memdoc">
  468. </div>
  469. </div>
  470. <hr/>The documentation for this class was generated from the following file:<ul>
  471. <li>include/grpc++/impl/codegen/<a class="el" href="impl_2codegen_2async__stream_8h_source.html">async_stream.h</a></li>
  472. </ul>
  473. </div><!-- contents -->
  474. <!-- start footer part -->
  475. <hr class="footer"/><address class="footer"><small>
  476. Generated on Tue Dec 12 2017 18:36:13 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  477. <img class="footer" src="doxygen.png" alt="doxygen"/>
  478. </a> 1.8.6
  479. </small></address>
  480. </body>
  481. </html>