classgrpc_1_1_server_callback_writer.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317
  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::ServerCallbackWriter&lt; 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_callback_writer.html">ServerCallbackWriter</a></li> </ul>
  64. </div>
  65. </div><!-- top -->
  66. <div class="header">
  67. <div class="summary">
  68. <a href="#pub-methods">Public Member Functions</a> &#124;
  69. <a href="#pro-methods">Protected Member Functions</a> </div>
  70. <div class="headertitle">
  71. <div class="title">grpc::ServerCallbackWriter&lt; Response &gt; Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
  72. </div><!--header-->
  73. <div class="contents">
  74. <p><code>#include &lt;<a class="el" href="impl_2codegen_2server__callback_8h_source.html">server_callback.h</a>&gt;</code></p>
  75. <table class="memberdecls">
  76. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  77. Public Member Functions</h2></td></tr>
  78. <tr class="memitem:abb3225ab435192fca8a3bec7279e6cda"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_callback_writer.html#abb3225ab435192fca8a3bec7279e6cda">~ServerCallbackWriter</a> () override</td></tr>
  79. <tr class="separator:abb3225ab435192fca8a3bec7279e6cda"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:a16aebc7738b682d2df16b58de17857f3"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_callback_writer.html#a16aebc7738b682d2df16b58de17857f3">Finish</a> (::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> s)=0</td></tr>
  81. <tr class="separator:a16aebc7738b682d2df16b58de17857f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:a6a948477ee67c104de7c5157956dac9b"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_callback_writer.html#a6a948477ee67c104de7c5157956dac9b">SendInitialMetadata</a> ()=0</td></tr>
  83. <tr class="separator:a6a948477ee67c104de7c5157956dac9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:ad23b40a9667c88ca72653118dd2b5c8e"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_callback_writer.html#ad23b40a9667c88ca72653118dd2b5c8e">Write</a> (const Response *msg, ::<a class="el" href="classgrpc_1_1_write_options.html">grpc::WriteOptions</a> options)=0</td></tr>
  85. <tr class="separator:ad23b40a9667c88ca72653118dd2b5c8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:a494bfc91a957dc76292a498e1f2bb72d"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_callback_writer.html#a494bfc91a957dc76292a498e1f2bb72d">WriteAndFinish</a> (const Response *msg, ::<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)=0</td></tr>
  87. <tr class="separator:a494bfc91a957dc76292a498e1f2bb72d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="inherit_header pub_methods_classgrpc_1_1internal_1_1_server_callback_call"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1internal_1_1_server_callback_call')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc_1_1internal_1_1_server_callback_call.html">grpc::internal::ServerCallbackCall</a></td></tr>
  89. <tr class="memitem:afd1da77659ae44af4e4984ce4c615538 inherit pub_methods_classgrpc_1_1internal_1_1_server_callback_call"><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_callback_call.html#afd1da77659ae44af4e4984ce4c615538">~ServerCallbackCall</a> ()</td></tr>
  90. <tr class="separator:afd1da77659ae44af4e4984ce4c615538 inherit pub_methods_classgrpc_1_1internal_1_1_server_callback_call"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <tr class="memitem:a8f5d1ec7fefd1a27aa5928c31f7e38df inherit pub_methods_classgrpc_1_1internal_1_1_server_callback_call"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_server_callback_call.html#a8f5d1ec7fefd1a27aa5928c31f7e38df">MaybeDone</a> ()</td></tr>
  92. <tr class="separator:a8f5d1ec7fefd1a27aa5928c31f7e38df inherit pub_methods_classgrpc_1_1internal_1_1_server_callback_call"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:a91963708bf926cc62582440c7fedd051 inherit pub_methods_classgrpc_1_1internal_1_1_server_callback_call"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_server_callback_call.html#a91963708bf926cc62582440c7fedd051">MaybeDone</a> (bool inline_ondone)</td></tr>
  94. <tr class="separator:a91963708bf926cc62582440c7fedd051 inherit pub_methods_classgrpc_1_1internal_1_1_server_callback_call"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:a81e8341db8a1636364a8a4205114a3fe inherit pub_methods_classgrpc_1_1internal_1_1_server_callback_call"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_server_callback_call.html#a81e8341db8a1636364a8a4205114a3fe">MaybeCallOnCancel</a> (<a class="el" href="classgrpc_1_1internal_1_1_server_reactor.html">ServerReactor</a> *reactor)</td></tr>
  96. <tr class="separator:a81e8341db8a1636364a8a4205114a3fe inherit pub_methods_classgrpc_1_1internal_1_1_server_callback_call"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:a1ab23641e1ee96f910f325992c514101 inherit pub_methods_classgrpc_1_1internal_1_1_server_callback_call"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_server_callback_call.html#a1ab23641e1ee96f910f325992c514101">MaybeCallOnCancel</a> ()</td></tr>
  98. <tr class="separator:a1ab23641e1ee96f910f325992c514101 inherit pub_methods_classgrpc_1_1internal_1_1_server_callback_call"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. </table><table class="memberdecls">
  100. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
  101. Protected Member Functions</h2></td></tr>
  102. <tr class="memitem:a51fd80ff8b5bde52bea74dfad6e99452"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_callback_writer.html#a51fd80ff8b5bde52bea74dfad6e99452">BindReactor</a> (<a class="el" href="classgrpc_1_1_server_write_reactor.html">ServerWriteReactor</a>&lt; Response &gt; *reactor)</td></tr>
  103. <tr class="separator:a51fd80ff8b5bde52bea74dfad6e99452"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="inherit_header pro_methods_classgrpc_1_1internal_1_1_server_callback_call"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classgrpc_1_1internal_1_1_server_callback_call')"><img src="closed.png" alt="-"/>&#160;Protected Member Functions inherited from <a class="el" href="classgrpc_1_1internal_1_1_server_callback_call.html">grpc::internal::ServerCallbackCall</a></td></tr>
  105. <tr class="memitem:abf7d5b632ff79a688b342b235275be72 inherit pro_methods_classgrpc_1_1internal_1_1_server_callback_call"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_server_callback_call.html#abf7d5b632ff79a688b342b235275be72">Ref</a> ()</td></tr>
  106. <tr class="memdesc:abf7d5b632ff79a688b342b235275be72 inherit pro_methods_classgrpc_1_1internal_1_1_server_callback_call"><td class="mdescLeft">&#160;</td><td class="mdescRight">Increases the reference count. <a href="classgrpc_1_1internal_1_1_server_callback_call.html#abf7d5b632ff79a688b342b235275be72">More...</a><br /></td></tr>
  107. <tr class="separator:abf7d5b632ff79a688b342b235275be72 inherit pro_methods_classgrpc_1_1internal_1_1_server_callback_call"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. </table>
  109. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  110. <a id="abb3225ab435192fca8a3bec7279e6cda"></a>
  111. <h2 class="memtitle"><span class="permalink"><a href="#abb3225ab435192fca8a3bec7279e6cda">&#9670;&nbsp;</a></span>~ServerCallbackWriter()</h2>
  112. <div class="memitem">
  113. <div class="memproto">
  114. <div class="memtemplate">
  115. template&lt;class Response &gt; </div>
  116. <table class="mlabels">
  117. <tr>
  118. <td class="mlabels-left">
  119. <table class="memname">
  120. <tr>
  121. <td class="memname"><a class="el" href="classgrpc_1_1_server_callback_writer.html">grpc::ServerCallbackWriter</a>&lt; Response &gt;::~<a class="el" href="classgrpc_1_1_server_callback_writer.html">ServerCallbackWriter</a> </td>
  122. <td>(</td>
  123. <td class="paramname"></td><td>)</td>
  124. <td></td>
  125. </tr>
  126. </table>
  127. </td>
  128. <td class="mlabels-right">
  129. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span></span> </td>
  130. </tr>
  131. </table>
  132. </div><div class="memdoc">
  133. </div>
  134. </div>
  135. <h2 class="groupheader">Member Function Documentation</h2>
  136. <a id="a51fd80ff8b5bde52bea74dfad6e99452"></a>
  137. <h2 class="memtitle"><span class="permalink"><a href="#a51fd80ff8b5bde52bea74dfad6e99452">&#9670;&nbsp;</a></span>BindReactor()</h2>
  138. <div class="memitem">
  139. <div class="memproto">
  140. <div class="memtemplate">
  141. template&lt;class Response &gt; </div>
  142. <table class="mlabels">
  143. <tr>
  144. <td class="mlabels-left">
  145. <table class="memname">
  146. <tr>
  147. <td class="memname">void <a class="el" href="classgrpc_1_1_server_callback_writer.html">grpc::ServerCallbackWriter</a>&lt; Response &gt;::BindReactor </td>
  148. <td>(</td>
  149. <td class="paramtype"><a class="el" href="classgrpc_1_1_server_write_reactor.html">ServerWriteReactor</a>&lt; Response &gt; *&#160;</td>
  150. <td class="paramname"><em>reactor</em></td><td>)</td>
  151. <td></td>
  152. </tr>
  153. </table>
  154. </td>
  155. <td class="mlabels-right">
  156. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
  157. </tr>
  158. </table>
  159. </div><div class="memdoc">
  160. </div>
  161. </div>
  162. <a id="a16aebc7738b682d2df16b58de17857f3"></a>
  163. <h2 class="memtitle"><span class="permalink"><a href="#a16aebc7738b682d2df16b58de17857f3">&#9670;&nbsp;</a></span>Finish()</h2>
  164. <div class="memitem">
  165. <div class="memproto">
  166. <div class="memtemplate">
  167. template&lt;class Response &gt; </div>
  168. <table class="mlabels">
  169. <tr>
  170. <td class="mlabels-left">
  171. <table class="memname">
  172. <tr>
  173. <td class="memname">virtual void <a class="el" href="classgrpc_1_1_server_callback_writer.html">grpc::ServerCallbackWriter</a>&lt; Response &gt;::Finish </td>
  174. <td>(</td>
  175. <td class="paramtype">::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a>&#160;</td>
  176. <td class="paramname"><em>s</em></td><td>)</td>
  177. <td></td>
  178. </tr>
  179. </table>
  180. </td>
  181. <td class="mlabels-right">
  182. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  183. </tr>
  184. </table>
  185. </div><div class="memdoc">
  186. </div>
  187. </div>
  188. <a id="a6a948477ee67c104de7c5157956dac9b"></a>
  189. <h2 class="memtitle"><span class="permalink"><a href="#a6a948477ee67c104de7c5157956dac9b">&#9670;&nbsp;</a></span>SendInitialMetadata()</h2>
  190. <div class="memitem">
  191. <div class="memproto">
  192. <div class="memtemplate">
  193. template&lt;class Response &gt; </div>
  194. <table class="mlabels">
  195. <tr>
  196. <td class="mlabels-left">
  197. <table class="memname">
  198. <tr>
  199. <td class="memname">virtual void <a class="el" href="classgrpc_1_1_server_callback_writer.html">grpc::ServerCallbackWriter</a>&lt; Response &gt;::SendInitialMetadata </td>
  200. <td>(</td>
  201. <td class="paramname"></td><td>)</td>
  202. <td></td>
  203. </tr>
  204. </table>
  205. </td>
  206. <td class="mlabels-right">
  207. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  208. </tr>
  209. </table>
  210. </div><div class="memdoc">
  211. </div>
  212. </div>
  213. <a id="ad23b40a9667c88ca72653118dd2b5c8e"></a>
  214. <h2 class="memtitle"><span class="permalink"><a href="#ad23b40a9667c88ca72653118dd2b5c8e">&#9670;&nbsp;</a></span>Write()</h2>
  215. <div class="memitem">
  216. <div class="memproto">
  217. <div class="memtemplate">
  218. template&lt;class Response &gt; </div>
  219. <table class="mlabels">
  220. <tr>
  221. <td class="mlabels-left">
  222. <table class="memname">
  223. <tr>
  224. <td class="memname">virtual void <a class="el" href="classgrpc_1_1_server_callback_writer.html">grpc::ServerCallbackWriter</a>&lt; Response &gt;::Write </td>
  225. <td>(</td>
  226. <td class="paramtype">const Response *&#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">::<a class="el" href="classgrpc_1_1_write_options.html">grpc::WriteOptions</a>&#160;</td>
  233. <td class="paramname"><em>options</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">pure virtual</span></span> </td>
  244. </tr>
  245. </table>
  246. </div><div class="memdoc">
  247. </div>
  248. </div>
  249. <a id="a494bfc91a957dc76292a498e1f2bb72d"></a>
  250. <h2 class="memtitle"><span class="permalink"><a href="#a494bfc91a957dc76292a498e1f2bb72d">&#9670;&nbsp;</a></span>WriteAndFinish()</h2>
  251. <div class="memitem">
  252. <div class="memproto">
  253. <div class="memtemplate">
  254. template&lt;class Response &gt; </div>
  255. <table class="mlabels">
  256. <tr>
  257. <td class="mlabels-left">
  258. <table class="memname">
  259. <tr>
  260. <td class="memname">virtual void <a class="el" href="classgrpc_1_1_server_callback_writer.html">grpc::ServerCallbackWriter</a>&lt; Response &gt;::WriteAndFinish </td>
  261. <td>(</td>
  262. <td class="paramtype">const Response *&#160;</td>
  263. <td class="paramname"><em>msg</em>, </td>
  264. </tr>
  265. <tr>
  266. <td class="paramkey"></td>
  267. <td></td>
  268. <td class="paramtype">::<a class="el" href="classgrpc_1_1_write_options.html">grpc::WriteOptions</a>&#160;</td>
  269. <td class="paramname"><em>options</em>, </td>
  270. </tr>
  271. <tr>
  272. <td class="paramkey"></td>
  273. <td></td>
  274. <td class="paramtype">::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a>&#160;</td>
  275. <td class="paramname"><em>s</em>&#160;</td>
  276. </tr>
  277. <tr>
  278. <td></td>
  279. <td>)</td>
  280. <td></td><td></td>
  281. </tr>
  282. </table>
  283. </td>
  284. <td class="mlabels-right">
  285. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  286. </tr>
  287. </table>
  288. </div><div class="memdoc">
  289. </div>
  290. </div>
  291. <hr/>The documentation for this class was generated from the following file:<ul>
  292. <li>include/grpcpp/impl/codegen/<a class="el" href="impl_2codegen_2server__callback_8h_source.html">server_callback.h</a></li>
  293. </ul>
  294. </div><!-- contents -->
  295. <!-- start footer part -->
  296. <hr class="footer"/><address class="footer"><small>
  297. Generated on Wed Mar 3 2021 19:17:25 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  298. <img class="footer" src="doxygen.png" alt="doxygen"/>
  299. </a> 1.8.17
  300. </small></address>
  301. </body>
  302. </html>