classgrpc_1_1_server_unary_reactor.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334
  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::ServerUnaryReactor Class 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_unary_reactor.html">ServerUnaryReactor</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::ServerUnaryReactor Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
  73. </div><!--header-->
  74. <div class="contents">
  75. <p><code>#include &lt;<a class="el" href="impl_2codegen_2server__callback_8h_source.html">server_callback.h</a>&gt;</code></p>
  76. <table class="memberdecls">
  77. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  78. Public Member Functions</h2></td></tr>
  79. <tr class="memitem:a01f99775e347fa750056814a8aa8b810"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_unary_reactor.html#a01f99775e347fa750056814a8aa8b810">ServerUnaryReactor</a> ()</td></tr>
  80. <tr class="separator:a01f99775e347fa750056814a8aa8b810"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:a6eb0f1f6f8affa87e6d7b59c612aaf85"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_unary_reactor.html#a6eb0f1f6f8affa87e6d7b59c612aaf85">~ServerUnaryReactor</a> () override=default</td></tr>
  82. <tr class="separator:a6eb0f1f6f8affa87e6d7b59c612aaf85"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:a2791ae2c24cb39e25d757e05806a9032"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_unary_reactor.html#a2791ae2c24cb39e25d757e05806a9032">StartSendInitialMetadata</a> ()</td></tr>
  84. <tr class="memdesc:a2791ae2c24cb39e25d757e05806a9032"><td class="mdescLeft">&#160;</td><td class="mdescRight">StartSendInitialMetadata is exactly like <a class="el" href="classgrpc_1_1_server_bidi_reactor.html" title="ServerBidiReactor is the interface for a bidirectional streaming RPC.">ServerBidiReactor</a>. <a href="classgrpc_1_1_server_unary_reactor.html#a2791ae2c24cb39e25d757e05806a9032">More...</a><br /></td></tr>
  85. <tr class="separator:a2791ae2c24cb39e25d757e05806a9032"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:aceabceb62593bd8de8bbfaba41d57d86"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_unary_reactor.html#aceabceb62593bd8de8bbfaba41d57d86">Finish</a> (::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> s)</td></tr>
  87. <tr class="memdesc:aceabceb62593bd8de8bbfaba41d57d86"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finish is similar to <a class="el" href="classgrpc_1_1_server_bidi_reactor.html" title="ServerBidiReactor is the interface for a bidirectional streaming RPC.">ServerBidiReactor</a> except for one detail. <a href="classgrpc_1_1_server_unary_reactor.html#aceabceb62593bd8de8bbfaba41d57d86">More...</a><br /></td></tr>
  88. <tr class="separator:aceabceb62593bd8de8bbfaba41d57d86"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:a2664153e7ee31b30f99b2753c42d591b"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_unary_reactor.html#a2664153e7ee31b30f99b2753c42d591b">OnSendInitialMetadataDone</a> (bool)</td></tr>
  90. <tr class="memdesc:a2664153e7ee31b30f99b2753c42d591b"><td class="mdescLeft">&#160;</td><td class="mdescRight">The following notifications are exactly like <a class="el" href="classgrpc_1_1_server_bidi_reactor.html" title="ServerBidiReactor is the interface for a bidirectional streaming RPC.">ServerBidiReactor</a>. <a href="classgrpc_1_1_server_unary_reactor.html#a2664153e7ee31b30f99b2753c42d591b">More...</a><br /></td></tr>
  91. <tr class="separator:a2664153e7ee31b30f99b2753c42d591b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:a028c1e364c9abf5fcbb7c577172edfb3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_unary_reactor.html#a028c1e364c9abf5fcbb7c577172edfb3">OnDone</a> () override=0</td></tr>
  93. <tr class="separator:a028c1e364c9abf5fcbb7c577172edfb3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a720f22381ddb6d273451e446e31797ce"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_unary_reactor.html#a720f22381ddb6d273451e446e31797ce">OnCancel</a> () override</td></tr>
  95. <tr class="separator:a720f22381ddb6d273451e446e31797ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="inherit_header pub_methods_classgrpc_1_1internal_1_1_server_reactor"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1internal_1_1_server_reactor')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc_1_1internal_1_1_server_reactor.html">grpc::internal::ServerReactor</a></td></tr>
  97. <tr class="memitem:ac1fad8a93bd91539593f9c8c293d82c7 inherit pub_methods_classgrpc_1_1internal_1_1_server_reactor"><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_reactor.html#ac1fad8a93bd91539593f9c8c293d82c7">~ServerReactor</a> ()=default</td></tr>
  98. <tr class="separator:ac1fad8a93bd91539593f9c8c293d82c7 inherit pub_methods_classgrpc_1_1internal_1_1_server_reactor"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. <tr class="memitem:aed030ad260f18b6673b6d768329ae0bd inherit pub_methods_classgrpc_1_1internal_1_1_server_reactor"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_server_reactor.html#aed030ad260f18b6673b6d768329ae0bd">InternalInlineable</a> ()</td></tr>
  100. <tr class="separator:aed030ad260f18b6673b6d768329ae0bd inherit pub_methods_classgrpc_1_1internal_1_1_server_reactor"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. </table><table class="memberdecls">
  102. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  103. Friends</h2></td></tr>
  104. <tr class="memitem:ae5d8451f33d09b510f7c769b74d5d434"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_unary_reactor.html#ae5d8451f33d09b510f7c769b74d5d434">ServerCallbackUnary</a></td></tr>
  105. <tr class="separator:ae5d8451f33d09b510f7c769b74d5d434"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. </table>
  107. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  108. <a id="a01f99775e347fa750056814a8aa8b810"></a>
  109. <h2 class="memtitle"><span class="permalink"><a href="#a01f99775e347fa750056814a8aa8b810">&#9670;&nbsp;</a></span>ServerUnaryReactor()</h2>
  110. <div class="memitem">
  111. <div class="memproto">
  112. <table class="mlabels">
  113. <tr>
  114. <td class="mlabels-left">
  115. <table class="memname">
  116. <tr>
  117. <td class="memname">grpc::ServerUnaryReactor::ServerUnaryReactor </td>
  118. <td>(</td>
  119. <td class="paramname"></td><td>)</td>
  120. <td></td>
  121. </tr>
  122. </table>
  123. </td>
  124. <td class="mlabels-right">
  125. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  126. </tr>
  127. </table>
  128. </div><div class="memdoc">
  129. </div>
  130. </div>
  131. <a id="a6eb0f1f6f8affa87e6d7b59c612aaf85"></a>
  132. <h2 class="memtitle"><span class="permalink"><a href="#a6eb0f1f6f8affa87e6d7b59c612aaf85">&#9670;&nbsp;</a></span>~ServerUnaryReactor()</h2>
  133. <div class="memitem">
  134. <div class="memproto">
  135. <table class="mlabels">
  136. <tr>
  137. <td class="mlabels-left">
  138. <table class="memname">
  139. <tr>
  140. <td class="memname">grpc::ServerUnaryReactor::~ServerUnaryReactor </td>
  141. <td>(</td>
  142. <td class="paramname"></td><td>)</td>
  143. <td></td>
  144. </tr>
  145. </table>
  146. </td>
  147. <td class="mlabels-right">
  148. <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">default</span></span> </td>
  149. </tr>
  150. </table>
  151. </div><div class="memdoc">
  152. </div>
  153. </div>
  154. <h2 class="groupheader">Member Function Documentation</h2>
  155. <a id="aceabceb62593bd8de8bbfaba41d57d86"></a>
  156. <h2 class="memtitle"><span class="permalink"><a href="#aceabceb62593bd8de8bbfaba41d57d86">&#9670;&nbsp;</a></span>Finish()</h2>
  157. <div class="memitem">
  158. <div class="memproto">
  159. <table class="mlabels">
  160. <tr>
  161. <td class="mlabels-left">
  162. <table class="memname">
  163. <tr>
  164. <td class="memname">void grpc::ServerUnaryReactor::Finish </td>
  165. <td>(</td>
  166. <td class="paramtype">::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a>&#160;</td>
  167. <td class="paramname"><em>s</em></td><td>)</td>
  168. <td></td>
  169. </tr>
  170. </table>
  171. </td>
  172. <td class="mlabels-right">
  173. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  174. </tr>
  175. </table>
  176. </div><div class="memdoc">
  177. <p>Finish is similar to <a class="el" href="classgrpc_1_1_server_bidi_reactor.html" title="ServerBidiReactor is the interface for a bidirectional streaming RPC.">ServerBidiReactor</a> except for one detail. </p>
  178. <p>If the status is non-OK, any message will not be sent. Instead, the client will only receive the status and any trailing metadata. </p>
  179. </div>
  180. </div>
  181. <a id="a720f22381ddb6d273451e446e31797ce"></a>
  182. <h2 class="memtitle"><span class="permalink"><a href="#a720f22381ddb6d273451e446e31797ce">&#9670;&nbsp;</a></span>OnCancel()</h2>
  183. <div class="memitem">
  184. <div class="memproto">
  185. <table class="mlabels">
  186. <tr>
  187. <td class="mlabels-left">
  188. <table class="memname">
  189. <tr>
  190. <td class="memname">void grpc::ServerUnaryReactor::OnCancel </td>
  191. <td>(</td>
  192. <td class="paramname"></td><td>)</td>
  193. <td></td>
  194. </tr>
  195. </table>
  196. </td>
  197. <td class="mlabels-right">
  198. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
  199. </tr>
  200. </table>
  201. </div><div class="memdoc">
  202. <p>Implements <a class="el" href="classgrpc_1_1internal_1_1_server_reactor.html#ad474a8d237cf749d216a5e1d7626d44f">grpc::internal::ServerReactor</a>.</p>
  203. </div>
  204. </div>
  205. <a id="a028c1e364c9abf5fcbb7c577172edfb3"></a>
  206. <h2 class="memtitle"><span class="permalink"><a href="#a028c1e364c9abf5fcbb7c577172edfb3">&#9670;&nbsp;</a></span>OnDone()</h2>
  207. <div class="memitem">
  208. <div class="memproto">
  209. <table class="mlabels">
  210. <tr>
  211. <td class="mlabels-left">
  212. <table class="memname">
  213. <tr>
  214. <td class="memname">void grpc::ServerUnaryReactor::OnDone </td>
  215. <td>(</td>
  216. <td class="paramname"></td><td>)</td>
  217. <td></td>
  218. </tr>
  219. </table>
  220. </td>
  221. <td class="mlabels-right">
  222. <span class="mlabels"><span class="mlabel">override</span><span class="mlabel">pure virtual</span></span> </td>
  223. </tr>
  224. </table>
  225. </div><div class="memdoc">
  226. <p>Implements <a class="el" href="classgrpc_1_1internal_1_1_server_reactor.html#a9f897ae667ba6d12effef7c280913242">grpc::internal::ServerReactor</a>.</p>
  227. </div>
  228. </div>
  229. <a id="a2664153e7ee31b30f99b2753c42d591b"></a>
  230. <h2 class="memtitle"><span class="permalink"><a href="#a2664153e7ee31b30f99b2753c42d591b">&#9670;&nbsp;</a></span>OnSendInitialMetadataDone()</h2>
  231. <div class="memitem">
  232. <div class="memproto">
  233. <table class="mlabels">
  234. <tr>
  235. <td class="mlabels-left">
  236. <table class="memname">
  237. <tr>
  238. <td class="memname">virtual void grpc::ServerUnaryReactor::OnSendInitialMetadataDone </td>
  239. <td>(</td>
  240. <td class="paramtype">bool&#160;</td>
  241. <td class="paramname"></td><td>)</td>
  242. <td></td>
  243. </tr>
  244. </table>
  245. </td>
  246. <td class="mlabels-right">
  247. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  248. </tr>
  249. </table>
  250. </div><div class="memdoc">
  251. <p>The following notifications are exactly like <a class="el" href="classgrpc_1_1_server_bidi_reactor.html" title="ServerBidiReactor is the interface for a bidirectional streaming RPC.">ServerBidiReactor</a>. </p>
  252. </div>
  253. </div>
  254. <a id="a2791ae2c24cb39e25d757e05806a9032"></a>
  255. <h2 class="memtitle"><span class="permalink"><a href="#a2791ae2c24cb39e25d757e05806a9032">&#9670;&nbsp;</a></span>StartSendInitialMetadata()</h2>
  256. <div class="memitem">
  257. <div class="memproto">
  258. <table class="mlabels">
  259. <tr>
  260. <td class="mlabels-left">
  261. <table class="memname">
  262. <tr>
  263. <td class="memname">void grpc::ServerUnaryReactor::StartSendInitialMetadata </td>
  264. <td>(</td>
  265. <td class="paramname"></td><td>)</td>
  266. <td></td>
  267. </tr>
  268. </table>
  269. </td>
  270. <td class="mlabels-right">
  271. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  272. </tr>
  273. </table>
  274. </div><div class="memdoc">
  275. <p>StartSendInitialMetadata is exactly like <a class="el" href="classgrpc_1_1_server_bidi_reactor.html" title="ServerBidiReactor is the interface for a bidirectional streaming RPC.">ServerBidiReactor</a>. </p>
  276. </div>
  277. </div>
  278. <h2 class="groupheader">Friends And Related Function Documentation</h2>
  279. <a id="ae5d8451f33d09b510f7c769b74d5d434"></a>
  280. <h2 class="memtitle"><span class="permalink"><a href="#ae5d8451f33d09b510f7c769b74d5d434">&#9670;&nbsp;</a></span>ServerCallbackUnary</h2>
  281. <div class="memitem">
  282. <div class="memproto">
  283. <table class="mlabels">
  284. <tr>
  285. <td class="mlabels-left">
  286. <table class="memname">
  287. <tr>
  288. <td class="memname">friend class <a class="el" href="classgrpc_1_1_server_callback_unary.html">ServerCallbackUnary</a></td>
  289. </tr>
  290. </table>
  291. </td>
  292. <td class="mlabels-right">
  293. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  294. </tr>
  295. </table>
  296. </div><div class="memdoc">
  297. </div>
  298. </div>
  299. <hr/>The documentation for this class was generated from the following file:<ul>
  300. <li>include/grpcpp/impl/codegen/<a class="el" href="impl_2codegen_2server__callback_8h_source.html">server_callback.h</a></li>
  301. </ul>
  302. </div><!-- contents -->
  303. <!-- start footer part -->
  304. <hr class="footer"/><address class="footer"><small>
  305. Generated on Wed Mar 3 2021 19:17:25 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  306. <img class="footer" src="doxygen.png" alt="doxygen"/>
  307. </a> 1.8.17
  308. </small></address>
  309. </body>
  310. </html>