classgrpc_1_1_server_bidi_reactor.html 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.17"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>GRPC C++: grpc::ServerBidiReactor&lt; Request, Response &gt; Class Template Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">GRPC C++
  25. &#160;<span id="projectnumber">1.36.1</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.17 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */</script>
  48. <div id="main-nav"></div>
  49. <!-- window showing the filter options -->
  50. <div id="MSearchSelectWindow"
  51. onmouseover="return searchBox.OnSearchSelectShow()"
  52. onmouseout="return searchBox.OnSearchSelectHide()"
  53. onkeydown="return searchBox.OnSearchSelectKey(event)">
  54. </div>
  55. <!-- iframe showing the search results (closed by default) -->
  56. <div id="MSearchResultsWindow">
  57. <iframe src="javascript:void(0)" frameborder="0"
  58. name="MSearchResults" id="MSearchResults">
  59. </iframe>
  60. </div>
  61. <div id="nav-path" class="navpath">
  62. <ul>
  63. <li class="navelem"><a class="el" href="namespacegrpc.html">grpc</a></li><li class="navelem"><a class="el" href="classgrpc_1_1_server_bidi_reactor.html">ServerBidiReactor</a></li> </ul>
  64. </div>
  65. </div><!-- top -->
  66. <div class="header">
  67. <div class="summary">
  68. <a href="#nested-classes">Data Structures</a> &#124;
  69. <a href="#pub-methods">Public Member Functions</a> &#124;
  70. <a href="#friends">Friends</a> </div>
  71. <div class="headertitle">
  72. <div class="title">grpc::ServerBidiReactor&lt; Request, Response &gt; Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
  73. </div><!--header-->
  74. <div class="contents">
  75. <p><em><a class="el" href="classgrpc_1_1_server_bidi_reactor.html" title="ServerBidiReactor is the interface for a bidirectional streaming RPC.">ServerBidiReactor</a></em> is the interface for a bidirectional streaming RPC.
  76. <a href="classgrpc_1_1_server_bidi_reactor.html#details">More...</a></p>
  77. <p><code>#include &lt;<a class="el" href="impl_2codegen_2server__callback_8h_source.html">server_callback.h</a>&gt;</code></p>
  78. <table class="memberdecls">
  79. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  80. Public Member Functions</h2></td></tr>
  81. <tr class="memitem:a9f459e7f53d66b5c8e61d8930053811b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_bidi_reactor.html#a9f459e7f53d66b5c8e61d8930053811b">ServerBidiReactor</a> ()</td></tr>
  82. <tr class="separator:a9f459e7f53d66b5c8e61d8930053811b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:aa9ee4a518fb5f5f7b7a8993bd5cb9df5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_bidi_reactor.html#aa9ee4a518fb5f5f7b7a8993bd5cb9df5">~ServerBidiReactor</a> () override=default</td></tr>
  84. <tr class="separator:aa9ee4a518fb5f5f7b7a8993bd5cb9df5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:aa8f942d4375367946595110f6b0b37ca"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_bidi_reactor.html#aa8f942d4375367946595110f6b0b37ca">StartSendInitialMetadata</a> ()</td></tr>
  86. <tr class="memdesc:aa8f942d4375367946595110f6b0b37ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send any initial metadata stored in the RPC context. <a href="classgrpc_1_1_server_bidi_reactor.html#aa8f942d4375367946595110f6b0b37ca">More...</a><br /></td></tr>
  87. <tr class="separator:aa8f942d4375367946595110f6b0b37ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:a65817119c11c9ee862a1514e87bb3585"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_bidi_reactor.html#a65817119c11c9ee862a1514e87bb3585">StartRead</a> (Request *req)</td></tr>
  89. <tr class="memdesc:a65817119c11c9ee862a1514e87bb3585"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initiate a read operation. <a href="classgrpc_1_1_server_bidi_reactor.html#a65817119c11c9ee862a1514e87bb3585">More...</a><br /></td></tr>
  90. <tr class="separator:a65817119c11c9ee862a1514e87bb3585"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:a7b457aceeb312472835007c289c711e8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_bidi_reactor.html#a7b457aceeb312472835007c289c711e8">StartWrite</a> (const Response *resp)</td></tr>
  92. <tr class="memdesc:a7b457aceeb312472835007c289c711e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initiate a write operation. <a href="classgrpc_1_1_server_bidi_reactor.html#a7b457aceeb312472835007c289c711e8">More...</a><br /></td></tr>
  93. <tr class="separator:a7b457aceeb312472835007c289c711e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:ad5c34a7b67278156a514456df0754c9e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_bidi_reactor.html#ad5c34a7b67278156a514456df0754c9e">StartWrite</a> (const Response *resp, ::<a class="el" href="classgrpc_1_1_write_options.html">grpc::WriteOptions</a> options)</td></tr>
  95. <tr class="memdesc:ad5c34a7b67278156a514456df0754c9e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initiate a write operation with specified options. <a href="classgrpc_1_1_server_bidi_reactor.html#ad5c34a7b67278156a514456df0754c9e">More...</a><br /></td></tr>
  96. <tr class="separator:ad5c34a7b67278156a514456df0754c9e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:a737391a379201de65a7708ae465121ef"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_bidi_reactor.html#a737391a379201de65a7708ae465121ef">StartWriteAndFinish</a> (const Response *resp, ::<a class="el" href="classgrpc_1_1_write_options.html">grpc::WriteOptions</a> options, ::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> s)</td></tr>
  98. <tr class="memdesc:a737391a379201de65a7708ae465121ef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initiate a write operation with specified options and final RPC <a class="el" href="classgrpc_1_1_status.html" title="Did it work? If it didn&#39;t, why?">Status</a>, which also causes any trailing metadata for this RPC to be sent out. <a href="classgrpc_1_1_server_bidi_reactor.html#a737391a379201de65a7708ae465121ef">More...</a><br /></td></tr>
  99. <tr class="separator:a737391a379201de65a7708ae465121ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:a5667f4a7f70cda0351f50ebae665dded"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_bidi_reactor.html#a5667f4a7f70cda0351f50ebae665dded">StartWriteLast</a> (const Response *resp, ::<a class="el" href="classgrpc_1_1_write_options.html">grpc::WriteOptions</a> options)</td></tr>
  101. <tr class="memdesc:a5667f4a7f70cda0351f50ebae665dded"><td class="mdescLeft">&#160;</td><td class="mdescRight">Inform system of a planned write operation with specified options, but allow the library to schedule the actual write coalesced with the writing of trailing metadata (which takes place on a Finish call). <a href="classgrpc_1_1_server_bidi_reactor.html#a5667f4a7f70cda0351f50ebae665dded">More...</a><br /></td></tr>
  102. <tr class="separator:a5667f4a7f70cda0351f50ebae665dded"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:a60edb96ee2d9796739c0c4590dff0d29"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_bidi_reactor.html#a60edb96ee2d9796739c0c4590dff0d29">Finish</a> (::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> s)</td></tr>
  104. <tr class="memdesc:a60edb96ee2d9796739c0c4590dff0d29"><td class="mdescLeft">&#160;</td><td class="mdescRight">Indicate that the stream is to be finished and the trailing metadata and RPC status are to be sent. <a href="classgrpc_1_1_server_bidi_reactor.html#a60edb96ee2d9796739c0c4590dff0d29">More...</a><br /></td></tr>
  105. <tr class="separator:a60edb96ee2d9796739c0c4590dff0d29"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a0715604ca94115aa164c8955bfe04649"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_bidi_reactor.html#a0715604ca94115aa164c8955bfe04649">OnSendInitialMetadataDone</a> (bool)</td></tr>
  107. <tr class="memdesc:a0715604ca94115aa164c8955bfe04649"><td class="mdescLeft">&#160;</td><td class="mdescRight">Notifies the application that an explicit StartSendInitialMetadata operation completed. <a href="classgrpc_1_1_server_bidi_reactor.html#a0715604ca94115aa164c8955bfe04649">More...</a><br /></td></tr>
  108. <tr class="separator:a0715604ca94115aa164c8955bfe04649"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:a8aafe86ec3fa67767fe1aeeb7f52f92a"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_bidi_reactor.html#a8aafe86ec3fa67767fe1aeeb7f52f92a">OnReadDone</a> (bool)</td></tr>
  110. <tr class="memdesc:a8aafe86ec3fa67767fe1aeeb7f52f92a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Notifies the application that a StartRead operation completed. <a href="classgrpc_1_1_server_bidi_reactor.html#a8aafe86ec3fa67767fe1aeeb7f52f92a">More...</a><br /></td></tr>
  111. <tr class="separator:a8aafe86ec3fa67767fe1aeeb7f52f92a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:a1fac7eca83effdeef8893486a45e58a0"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_bidi_reactor.html#a1fac7eca83effdeef8893486a45e58a0">OnWriteDone</a> (bool)</td></tr>
  113. <tr class="memdesc:a1fac7eca83effdeef8893486a45e58a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Notifies the application that a StartWrite (or StartWriteLast) operation completed. <a href="classgrpc_1_1_server_bidi_reactor.html#a1fac7eca83effdeef8893486a45e58a0">More...</a><br /></td></tr>
  114. <tr class="separator:a1fac7eca83effdeef8893486a45e58a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:aaf98cc106728f8911acdd2d50574a788"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_bidi_reactor.html#aaf98cc106728f8911acdd2d50574a788">OnDone</a> () override=0</td></tr>
  116. <tr class="memdesc:aaf98cc106728f8911acdd2d50574a788"><td class="mdescLeft">&#160;</td><td class="mdescRight">Notifies the application that all operations associated with this RPC have completed. <a href="classgrpc_1_1_server_bidi_reactor.html#aaf98cc106728f8911acdd2d50574a788">More...</a><br /></td></tr>
  117. <tr class="separator:aaf98cc106728f8911acdd2d50574a788"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:abb21a6abd4c50d76b1037b329a8aa721"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_bidi_reactor.html#abb21a6abd4c50d76b1037b329a8aa721">OnCancel</a> () override</td></tr>
  119. <tr class="memdesc:abb21a6abd4c50d76b1037b329a8aa721"><td class="mdescLeft">&#160;</td><td class="mdescRight">Notifies the application that this RPC has been cancelled. <a href="classgrpc_1_1_server_bidi_reactor.html#abb21a6abd4c50d76b1037b329a8aa721">More...</a><br /></td></tr>
  120. <tr class="separator:abb21a6abd4c50d76b1037b329a8aa721"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. </table><table class="memberdecls">
  122. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  123. Friends</h2></td></tr>
  124. <tr class="memitem:a7c37735f41590c54ad5948d348e63864"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_bidi_reactor.html#a7c37735f41590c54ad5948d348e63864">ServerCallbackReaderWriter&lt; Request, Response &gt;</a></td></tr>
  125. <tr class="separator:a7c37735f41590c54ad5948d348e63864"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. </table>
  127. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  128. <div class="textblock"><h3>template&lt;class Request, class Response&gt;<br />
  129. class grpc::ServerBidiReactor&lt; Request, Response &gt;</h3>
  130. <p><em><a class="el" href="classgrpc_1_1_server_bidi_reactor.html" title="ServerBidiReactor is the interface for a bidirectional streaming RPC.">ServerBidiReactor</a></em> is the interface for a bidirectional streaming RPC. </p>
  131. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  132. <a id="a9f459e7f53d66b5c8e61d8930053811b"></a>
  133. <h2 class="memtitle"><span class="permalink"><a href="#a9f459e7f53d66b5c8e61d8930053811b">&#9670;&nbsp;</a></span>ServerBidiReactor()</h2>
  134. <div class="memitem">
  135. <div class="memproto">
  136. <div class="memtemplate">
  137. template&lt;class Request , class Response &gt; </div>
  138. <table class="mlabels">
  139. <tr>
  140. <td class="mlabels-left">
  141. <table class="memname">
  142. <tr>
  143. <td class="memname"><a class="el" href="classgrpc_1_1_server_bidi_reactor.html">grpc::ServerBidiReactor</a>&lt; Request, Response &gt;::<a class="el" href="classgrpc_1_1_server_bidi_reactor.html">ServerBidiReactor</a> </td>
  144. <td>(</td>
  145. <td class="paramname"></td><td>)</td>
  146. <td></td>
  147. </tr>
  148. </table>
  149. </td>
  150. <td class="mlabels-right">
  151. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  152. </tr>
  153. </table>
  154. </div><div class="memdoc">
  155. </div>
  156. </div>
  157. <a id="aa9ee4a518fb5f5f7b7a8993bd5cb9df5"></a>
  158. <h2 class="memtitle"><span class="permalink"><a href="#aa9ee4a518fb5f5f7b7a8993bd5cb9df5">&#9670;&nbsp;</a></span>~ServerBidiReactor()</h2>
  159. <div class="memitem">
  160. <div class="memproto">
  161. <div class="memtemplate">
  162. template&lt;class Request , class Response &gt; </div>
  163. <table class="mlabels">
  164. <tr>
  165. <td class="mlabels-left">
  166. <table class="memname">
  167. <tr>
  168. <td class="memname"><a class="el" href="classgrpc_1_1_server_bidi_reactor.html">grpc::ServerBidiReactor</a>&lt; Request, Response &gt;::~<a class="el" href="classgrpc_1_1_server_bidi_reactor.html">ServerBidiReactor</a> </td>
  169. <td>(</td>
  170. <td class="paramname"></td><td>)</td>
  171. <td></td>
  172. </tr>
  173. </table>
  174. </td>
  175. <td class="mlabels-right">
  176. <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">default</span></span> </td>
  177. </tr>
  178. </table>
  179. </div><div class="memdoc">
  180. </div>
  181. </div>
  182. <h2 class="groupheader">Member Function Documentation</h2>
  183. <a id="a60edb96ee2d9796739c0c4590dff0d29"></a>
  184. <h2 class="memtitle"><span class="permalink"><a href="#a60edb96ee2d9796739c0c4590dff0d29">&#9670;&nbsp;</a></span>Finish()</h2>
  185. <div class="memitem">
  186. <div class="memproto">
  187. <div class="memtemplate">
  188. template&lt;class Request , class Response &gt; </div>
  189. <table class="mlabels">
  190. <tr>
  191. <td class="mlabels-left">
  192. <table class="memname">
  193. <tr>
  194. <td class="memname">void <a class="el" href="classgrpc_1_1_server_bidi_reactor.html">grpc::ServerBidiReactor</a>&lt; Request, Response &gt;::Finish </td>
  195. <td>(</td>
  196. <td class="paramtype">::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a>&#160;</td>
  197. <td class="paramname"><em>s</em></td><td>)</td>
  198. <td></td>
  199. </tr>
  200. </table>
  201. </td>
  202. <td class="mlabels-right">
  203. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  204. </tr>
  205. </table>
  206. </div><div class="memdoc">
  207. <p>Indicate that the stream is to be finished and the trailing metadata and RPC status are to be sent. </p>
  208. <p>Every RPC MUST be finished using either Finish or StartWriteAndFinish (but not both), even if the RPC is already cancelled.</p>
  209. <dl class="params"><dt>Parameters</dt><dd>
  210. <table class="params">
  211. <tr><td class="paramdir">[in]</td><td class="paramname">s</td><td>The status outcome of this RPC </td></tr>
  212. </table>
  213. </dd>
  214. </dl>
  215. </div>
  216. </div>
  217. <a id="abb21a6abd4c50d76b1037b329a8aa721"></a>
  218. <h2 class="memtitle"><span class="permalink"><a href="#abb21a6abd4c50d76b1037b329a8aa721">&#9670;&nbsp;</a></span>OnCancel()</h2>
  219. <div class="memitem">
  220. <div class="memproto">
  221. <div class="memtemplate">
  222. template&lt;class Request , class Response &gt; </div>
  223. <table class="mlabels">
  224. <tr>
  225. <td class="mlabels-left">
  226. <table class="memname">
  227. <tr>
  228. <td class="memname">void <a class="el" href="classgrpc_1_1_server_bidi_reactor.html">grpc::ServerBidiReactor</a>&lt; Request, Response &gt;::OnCancel </td>
  229. <td>(</td>
  230. <td class="paramname"></td><td>)</td>
  231. <td></td>
  232. </tr>
  233. </table>
  234. </td>
  235. <td class="mlabels-right">
  236. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span></span> </td>
  237. </tr>
  238. </table>
  239. </div><div class="memdoc">
  240. <p>Notifies the application that this RPC has been cancelled. </p>
  241. <p>This is an override (from the internal base class) but not final, so derived classes should override it if they want to take action. </p>
  242. </div>
  243. </div>
  244. <a id="aaf98cc106728f8911acdd2d50574a788"></a>
  245. <h2 class="memtitle"><span class="permalink"><a href="#aaf98cc106728f8911acdd2d50574a788">&#9670;&nbsp;</a></span>OnDone()</h2>
  246. <div class="memitem">
  247. <div class="memproto">
  248. <div class="memtemplate">
  249. template&lt;class Request , class Response &gt; </div>
  250. <table class="mlabels">
  251. <tr>
  252. <td class="mlabels-left">
  253. <table class="memname">
  254. <tr>
  255. <td class="memname">void <a class="el" href="classgrpc_1_1_server_bidi_reactor.html">grpc::ServerBidiReactor</a>&lt; Request, Response &gt;::OnDone </td>
  256. <td>(</td>
  257. <td class="paramname"></td><td>)</td>
  258. <td></td>
  259. </tr>
  260. </table>
  261. </td>
  262. <td class="mlabels-right">
  263. <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">pure virtual</span></span> </td>
  264. </tr>
  265. </table>
  266. </div><div class="memdoc">
  267. <p>Notifies the application that all operations associated with this RPC have completed. </p>
  268. <p>This is an override (from the internal base class) but still abstract, so derived classes MUST override it to be instantiated. </p>
  269. </div>
  270. </div>
  271. <a id="a8aafe86ec3fa67767fe1aeeb7f52f92a"></a>
  272. <h2 class="memtitle"><span class="permalink"><a href="#a8aafe86ec3fa67767fe1aeeb7f52f92a">&#9670;&nbsp;</a></span>OnReadDone()</h2>
  273. <div class="memitem">
  274. <div class="memproto">
  275. <div class="memtemplate">
  276. template&lt;class Request , class Response &gt; </div>
  277. <table class="mlabels">
  278. <tr>
  279. <td class="mlabels-left">
  280. <table class="memname">
  281. <tr>
  282. <td class="memname">virtual void <a class="el" href="classgrpc_1_1_server_bidi_reactor.html">grpc::ServerBidiReactor</a>&lt; Request, Response &gt;::OnReadDone </td>
  283. <td>(</td>
  284. <td class="paramtype">bool&#160;</td>
  285. <td class="paramname"></td><td>)</td>
  286. <td></td>
  287. </tr>
  288. </table>
  289. </td>
  290. <td class="mlabels-right">
  291. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  292. </tr>
  293. </table>
  294. </div><div class="memdoc">
  295. <p>Notifies the application that a StartRead operation completed. </p>
  296. <dl class="params"><dt>Parameters</dt><dd>
  297. <table class="params">
  298. <tr><td class="paramdir">[in]</td><td class="paramname">ok</td><td>Was it successful? If false, no further read-side operation will succeed. </td></tr>
  299. </table>
  300. </dd>
  301. </dl>
  302. </div>
  303. </div>
  304. <a id="a0715604ca94115aa164c8955bfe04649"></a>
  305. <h2 class="memtitle"><span class="permalink"><a href="#a0715604ca94115aa164c8955bfe04649">&#9670;&nbsp;</a></span>OnSendInitialMetadataDone()</h2>
  306. <div class="memitem">
  307. <div class="memproto">
  308. <div class="memtemplate">
  309. template&lt;class Request , class Response &gt; </div>
  310. <table class="mlabels">
  311. <tr>
  312. <td class="mlabels-left">
  313. <table class="memname">
  314. <tr>
  315. <td class="memname">virtual void <a class="el" href="classgrpc_1_1_server_bidi_reactor.html">grpc::ServerBidiReactor</a>&lt; Request, Response &gt;::OnSendInitialMetadataDone </td>
  316. <td>(</td>
  317. <td class="paramtype">bool&#160;</td>
  318. <td class="paramname"></td><td>)</td>
  319. <td></td>
  320. </tr>
  321. </table>
  322. </td>
  323. <td class="mlabels-right">
  324. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  325. </tr>
  326. </table>
  327. </div><div class="memdoc">
  328. <p>Notifies the application that an explicit StartSendInitialMetadata operation completed. </p>
  329. <p>Not used when the sending of initial metadata piggybacks onto the first write.</p>
  330. <dl class="params"><dt>Parameters</dt><dd>
  331. <table class="params">
  332. <tr><td class="paramdir">[in]</td><td class="paramname">ok</td><td>Was it successful? If false, no further write-side operation will succeed. </td></tr>
  333. </table>
  334. </dd>
  335. </dl>
  336. </div>
  337. </div>
  338. <a id="a1fac7eca83effdeef8893486a45e58a0"></a>
  339. <h2 class="memtitle"><span class="permalink"><a href="#a1fac7eca83effdeef8893486a45e58a0">&#9670;&nbsp;</a></span>OnWriteDone()</h2>
  340. <div class="memitem">
  341. <div class="memproto">
  342. <div class="memtemplate">
  343. template&lt;class Request , class Response &gt; </div>
  344. <table class="mlabels">
  345. <tr>
  346. <td class="mlabels-left">
  347. <table class="memname">
  348. <tr>
  349. <td class="memname">virtual void <a class="el" href="classgrpc_1_1_server_bidi_reactor.html">grpc::ServerBidiReactor</a>&lt; Request, Response &gt;::OnWriteDone </td>
  350. <td>(</td>
  351. <td class="paramtype">bool&#160;</td>
  352. <td class="paramname"></td><td>)</td>
  353. <td></td>
  354. </tr>
  355. </table>
  356. </td>
  357. <td class="mlabels-right">
  358. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  359. </tr>
  360. </table>
  361. </div><div class="memdoc">
  362. <p>Notifies the application that a StartWrite (or StartWriteLast) operation completed. </p>
  363. <dl class="params"><dt>Parameters</dt><dd>
  364. <table class="params">
  365. <tr><td class="paramdir">[in]</td><td class="paramname">ok</td><td>Was it successful? If false, no further write-side operation will succeed. </td></tr>
  366. </table>
  367. </dd>
  368. </dl>
  369. </div>
  370. </div>
  371. <a id="a65817119c11c9ee862a1514e87bb3585"></a>
  372. <h2 class="memtitle"><span class="permalink"><a href="#a65817119c11c9ee862a1514e87bb3585">&#9670;&nbsp;</a></span>StartRead()</h2>
  373. <div class="memitem">
  374. <div class="memproto">
  375. <div class="memtemplate">
  376. template&lt;class Request , class Response &gt; </div>
  377. <table class="mlabels">
  378. <tr>
  379. <td class="mlabels-left">
  380. <table class="memname">
  381. <tr>
  382. <td class="memname">void <a class="el" href="classgrpc_1_1_server_bidi_reactor.html">grpc::ServerBidiReactor</a>&lt; Request, Response &gt;::StartRead </td>
  383. <td>(</td>
  384. <td class="paramtype">Request *&#160;</td>
  385. <td class="paramname"><em>req</em></td><td>)</td>
  386. <td></td>
  387. </tr>
  388. </table>
  389. </td>
  390. <td class="mlabels-right">
  391. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  392. </tr>
  393. </table>
  394. </div><div class="memdoc">
  395. <p>Initiate a read operation. </p>
  396. <dl class="params"><dt>Parameters</dt><dd>
  397. <table class="params">
  398. <tr><td class="paramdir">[out]</td><td class="paramname">req</td><td>Where to eventually store the read message. Valid when the library calls OnReadDone </td></tr>
  399. </table>
  400. </dd>
  401. </dl>
  402. </div>
  403. </div>
  404. <a id="aa8f942d4375367946595110f6b0b37ca"></a>
  405. <h2 class="memtitle"><span class="permalink"><a href="#aa8f942d4375367946595110f6b0b37ca">&#9670;&nbsp;</a></span>StartSendInitialMetadata()</h2>
  406. <div class="memitem">
  407. <div class="memproto">
  408. <div class="memtemplate">
  409. template&lt;class Request , class Response &gt; </div>
  410. <table class="mlabels">
  411. <tr>
  412. <td class="mlabels-left">
  413. <table class="memname">
  414. <tr>
  415. <td class="memname">void <a class="el" href="classgrpc_1_1_server_bidi_reactor.html">grpc::ServerBidiReactor</a>&lt; Request, Response &gt;::StartSendInitialMetadata </td>
  416. <td>(</td>
  417. <td class="paramname"></td><td>)</td>
  418. <td></td>
  419. </tr>
  420. </table>
  421. </td>
  422. <td class="mlabels-right">
  423. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  424. </tr>
  425. </table>
  426. </div><div class="memdoc">
  427. <p>Send any initial metadata stored in the RPC context. </p>
  428. <p>If not invoked, any initial metadata will be passed along with the first Write or the Finish (if there are no writes). </p>
  429. </div>
  430. </div>
  431. <a id="a7b457aceeb312472835007c289c711e8"></a>
  432. <h2 class="memtitle"><span class="permalink"><a href="#a7b457aceeb312472835007c289c711e8">&#9670;&nbsp;</a></span>StartWrite() <span class="overload">[1/2]</span></h2>
  433. <div class="memitem">
  434. <div class="memproto">
  435. <div class="memtemplate">
  436. template&lt;class Request , class Response &gt; </div>
  437. <table class="mlabels">
  438. <tr>
  439. <td class="mlabels-left">
  440. <table class="memname">
  441. <tr>
  442. <td class="memname">void <a class="el" href="classgrpc_1_1_server_bidi_reactor.html">grpc::ServerBidiReactor</a>&lt; Request, Response &gt;::StartWrite </td>
  443. <td>(</td>
  444. <td class="paramtype">const Response *&#160;</td>
  445. <td class="paramname"><em>resp</em></td><td>)</td>
  446. <td></td>
  447. </tr>
  448. </table>
  449. </td>
  450. <td class="mlabels-right">
  451. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  452. </tr>
  453. </table>
  454. </div><div class="memdoc">
  455. <p>Initiate a write operation. </p>
  456. <dl class="params"><dt>Parameters</dt><dd>
  457. <table class="params">
  458. <tr><td class="paramdir">[in]</td><td class="paramname">resp</td><td>The message to be written. The library does not take ownership but the caller must ensure that the message is not deleted or modified until OnWriteDone is called. </td></tr>
  459. </table>
  460. </dd>
  461. </dl>
  462. </div>
  463. </div>
  464. <a id="ad5c34a7b67278156a514456df0754c9e"></a>
  465. <h2 class="memtitle"><span class="permalink"><a href="#ad5c34a7b67278156a514456df0754c9e">&#9670;&nbsp;</a></span>StartWrite() <span class="overload">[2/2]</span></h2>
  466. <div class="memitem">
  467. <div class="memproto">
  468. <div class="memtemplate">
  469. template&lt;class Request , class Response &gt; </div>
  470. <table class="mlabels">
  471. <tr>
  472. <td class="mlabels-left">
  473. <table class="memname">
  474. <tr>
  475. <td class="memname">void <a class="el" href="classgrpc_1_1_server_bidi_reactor.html">grpc::ServerBidiReactor</a>&lt; Request, Response &gt;::StartWrite </td>
  476. <td>(</td>
  477. <td class="paramtype">const Response *&#160;</td>
  478. <td class="paramname"><em>resp</em>, </td>
  479. </tr>
  480. <tr>
  481. <td class="paramkey"></td>
  482. <td></td>
  483. <td class="paramtype">::<a class="el" href="classgrpc_1_1_write_options.html">grpc::WriteOptions</a>&#160;</td>
  484. <td class="paramname"><em>options</em>&#160;</td>
  485. </tr>
  486. <tr>
  487. <td></td>
  488. <td>)</td>
  489. <td></td><td></td>
  490. </tr>
  491. </table>
  492. </td>
  493. <td class="mlabels-right">
  494. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  495. </tr>
  496. </table>
  497. </div><div class="memdoc">
  498. <p>Initiate a write operation with specified options. </p>
  499. <dl class="params"><dt>Parameters</dt><dd>
  500. <table class="params">
  501. <tr><td class="paramdir">[in]</td><td class="paramname">resp</td><td>The message to be written. The library does not take ownership but the caller must ensure that the message is not deleted or modified until OnWriteDone is called. </td></tr>
  502. <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 use for writing this message </td></tr>
  503. </table>
  504. </dd>
  505. </dl>
  506. </div>
  507. </div>
  508. <a id="a737391a379201de65a7708ae465121ef"></a>
  509. <h2 class="memtitle"><span class="permalink"><a href="#a737391a379201de65a7708ae465121ef">&#9670;&nbsp;</a></span>StartWriteAndFinish()</h2>
  510. <div class="memitem">
  511. <div class="memproto">
  512. <div class="memtemplate">
  513. template&lt;class Request , class Response &gt; </div>
  514. <table class="mlabels">
  515. <tr>
  516. <td class="mlabels-left">
  517. <table class="memname">
  518. <tr>
  519. <td class="memname">void <a class="el" href="classgrpc_1_1_server_bidi_reactor.html">grpc::ServerBidiReactor</a>&lt; Request, Response &gt;::StartWriteAndFinish </td>
  520. <td>(</td>
  521. <td class="paramtype">const Response *&#160;</td>
  522. <td class="paramname"><em>resp</em>, </td>
  523. </tr>
  524. <tr>
  525. <td class="paramkey"></td>
  526. <td></td>
  527. <td class="paramtype">::<a class="el" href="classgrpc_1_1_write_options.html">grpc::WriteOptions</a>&#160;</td>
  528. <td class="paramname"><em>options</em>, </td>
  529. </tr>
  530. <tr>
  531. <td class="paramkey"></td>
  532. <td></td>
  533. <td class="paramtype">::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a>&#160;</td>
  534. <td class="paramname"><em>s</em>&#160;</td>
  535. </tr>
  536. <tr>
  537. <td></td>
  538. <td>)</td>
  539. <td></td><td></td>
  540. </tr>
  541. </table>
  542. </td>
  543. <td class="mlabels-right">
  544. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  545. </tr>
  546. </table>
  547. </div><div class="memdoc">
  548. <p>Initiate a write operation with specified options and final RPC <a class="el" href="classgrpc_1_1_status.html" title="Did it work? If it didn&#39;t, why?">Status</a>, which also causes any trailing metadata for this RPC to be sent out. </p>
  549. <p>StartWriteAndFinish is like merging StartWriteLast and Finish into a single step. A key difference, though, is that this operation doesn't have an OnWriteDone reaction - it is considered complete only when OnDone is available. An RPC can either have StartWriteAndFinish or Finish, but not both.</p>
  550. <dl class="params"><dt>Parameters</dt><dd>
  551. <table class="params">
  552. <tr><td class="paramdir">[in]</td><td class="paramname">resp</td><td>The message to be written. The library does not take ownership but the caller must ensure that the message is not deleted or modified until OnDone is called. </td></tr>
  553. <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 use for writing this message </td></tr>
  554. <tr><td class="paramdir">[in]</td><td class="paramname">s</td><td>The status outcome of this RPC </td></tr>
  555. </table>
  556. </dd>
  557. </dl>
  558. </div>
  559. </div>
  560. <a id="a5667f4a7f70cda0351f50ebae665dded"></a>
  561. <h2 class="memtitle"><span class="permalink"><a href="#a5667f4a7f70cda0351f50ebae665dded">&#9670;&nbsp;</a></span>StartWriteLast()</h2>
  562. <div class="memitem">
  563. <div class="memproto">
  564. <div class="memtemplate">
  565. template&lt;class Request , class Response &gt; </div>
  566. <table class="mlabels">
  567. <tr>
  568. <td class="mlabels-left">
  569. <table class="memname">
  570. <tr>
  571. <td class="memname">void <a class="el" href="classgrpc_1_1_server_bidi_reactor.html">grpc::ServerBidiReactor</a>&lt; Request, Response &gt;::StartWriteLast </td>
  572. <td>(</td>
  573. <td class="paramtype">const Response *&#160;</td>
  574. <td class="paramname"><em>resp</em>, </td>
  575. </tr>
  576. <tr>
  577. <td class="paramkey"></td>
  578. <td></td>
  579. <td class="paramtype">::<a class="el" href="classgrpc_1_1_write_options.html">grpc::WriteOptions</a>&#160;</td>
  580. <td class="paramname"><em>options</em>&#160;</td>
  581. </tr>
  582. <tr>
  583. <td></td>
  584. <td>)</td>
  585. <td></td><td></td>
  586. </tr>
  587. </table>
  588. </td>
  589. <td class="mlabels-right">
  590. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  591. </tr>
  592. </table>
  593. </div><div class="memdoc">
  594. <p>Inform system of a planned write operation with specified options, but allow the library to schedule the actual write coalesced with the writing of trailing metadata (which takes place on a Finish call). </p>
  595. <dl class="params"><dt>Parameters</dt><dd>
  596. <table class="params">
  597. <tr><td class="paramdir">[in]</td><td class="paramname">resp</td><td>The message to be written. The library does not take ownership but the caller must ensure that the message is not deleted or modified until OnWriteDone is called. </td></tr>
  598. <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 use for writing this message </td></tr>
  599. </table>
  600. </dd>
  601. </dl>
  602. </div>
  603. </div>
  604. <h2 class="groupheader">Friends And Related Function Documentation</h2>
  605. <a id="a7c37735f41590c54ad5948d348e63864"></a>
  606. <h2 class="memtitle"><span class="permalink"><a href="#a7c37735f41590c54ad5948d348e63864">&#9670;&nbsp;</a></span>ServerCallbackReaderWriter&lt; Request, Response &gt;</h2>
  607. <div class="memitem">
  608. <div class="memproto">
  609. <div class="memtemplate">
  610. template&lt;class Request , class Response &gt; </div>
  611. <table class="mlabels">
  612. <tr>
  613. <td class="mlabels-left">
  614. <table class="memname">
  615. <tr>
  616. <td class="memname">friend class <a class="el" href="classgrpc_1_1_server_callback_reader_writer.html">ServerCallbackReaderWriter</a>&lt; Request, Response &gt;</td>
  617. </tr>
  618. </table>
  619. </td>
  620. <td class="mlabels-right">
  621. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  622. </tr>
  623. </table>
  624. </div><div class="memdoc">
  625. </div>
  626. </div>
  627. <hr/>The documentation for this class was generated from the following file:<ul>
  628. <li>include/grpcpp/impl/codegen/<a class="el" href="impl_2codegen_2server__callback_8h_source.html">server_callback.h</a></li>
  629. </ul>
  630. </div><!-- contents -->
  631. <!-- start footer part -->
  632. <hr class="footer"/><address class="footer"><small>
  633. Generated on Wed Mar 3 2021 19:17:25 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  634. <img class="footer" src="doxygen.png" alt="doxygen"/>
  635. </a> 1.8.17
  636. </small></address>
  637. </body>
  638. </html>