classgrpc_1_1_server_callback_reader.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261
  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::ServerCallbackReader&lt; Request &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_reader.html">ServerCallbackReader</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::ServerCallbackReader&lt; Request &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:a2e4b1652046acfe8aa3f883b7b22f44d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_callback_reader.html#a2e4b1652046acfe8aa3f883b7b22f44d">~ServerCallbackReader</a> () override</td></tr>
  79. <tr class="separator:a2e4b1652046acfe8aa3f883b7b22f44d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:ab51dd6f1320b5b9eb8d71ee2d8f72ac1"><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_reader.html#ab51dd6f1320b5b9eb8d71ee2d8f72ac1">Finish</a> (::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> s)=0</td></tr>
  81. <tr class="separator:ab51dd6f1320b5b9eb8d71ee2d8f72ac1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:ac436c0d692702d1e77a4c3ec8e7dd2b6"><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_reader.html#ac436c0d692702d1e77a4c3ec8e7dd2b6">SendInitialMetadata</a> ()=0</td></tr>
  83. <tr class="separator:ac436c0d692702d1e77a4c3ec8e7dd2b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:a0092d67dc1eba2fcf54cec76c09275d0"><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_reader.html#a0092d67dc1eba2fcf54cec76c09275d0">Read</a> (Request *msg)=0</td></tr>
  85. <tr class="separator:a0092d67dc1eba2fcf54cec76c09275d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <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>
  87. <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>
  88. <tr class="separator:afd1da77659ae44af4e4984ce4c615538 inherit pub_methods_classgrpc_1_1internal_1_1_server_callback_call"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <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>
  90. <tr class="separator:a8f5d1ec7fefd1a27aa5928c31f7e38df inherit pub_methods_classgrpc_1_1internal_1_1_server_callback_call"><td class="memSeparator" colspan="2">&#160;</td></tr>
  91. <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>
  92. <tr class="separator:a91963708bf926cc62582440c7fedd051 inherit pub_methods_classgrpc_1_1internal_1_1_server_callback_call"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <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>
  94. <tr class="separator:a81e8341db8a1636364a8a4205114a3fe inherit pub_methods_classgrpc_1_1internal_1_1_server_callback_call"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <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>
  96. <tr class="separator:a1ab23641e1ee96f910f325992c514101 inherit pub_methods_classgrpc_1_1internal_1_1_server_callback_call"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. </table><table class="memberdecls">
  98. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
  99. Protected Member Functions</h2></td></tr>
  100. <tr class="memitem:af3b9135769a9a677046a37c29012ffa7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_server_callback_reader.html#af3b9135769a9a677046a37c29012ffa7">BindReactor</a> (<a class="el" href="classgrpc_1_1_server_read_reactor.html">ServerReadReactor</a>&lt; Request &gt; *reactor)</td></tr>
  101. <tr class="separator:af3b9135769a9a677046a37c29012ffa7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. <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>
  103. <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>
  104. <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>
  105. <tr class="separator:abf7d5b632ff79a688b342b235275be72 inherit pro_methods_classgrpc_1_1internal_1_1_server_callback_call"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. </table>
  107. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  108. <a id="a2e4b1652046acfe8aa3f883b7b22f44d"></a>
  109. <h2 class="memtitle"><span class="permalink"><a href="#a2e4b1652046acfe8aa3f883b7b22f44d">&#9670;&nbsp;</a></span>~ServerCallbackReader()</h2>
  110. <div class="memitem">
  111. <div class="memproto">
  112. <div class="memtemplate">
  113. template&lt;class Request &gt; </div>
  114. <table class="mlabels">
  115. <tr>
  116. <td class="mlabels-left">
  117. <table class="memname">
  118. <tr>
  119. <td class="memname"><a class="el" href="classgrpc_1_1_server_callback_reader.html">grpc::ServerCallbackReader</a>&lt; Request &gt;::~<a class="el" href="classgrpc_1_1_server_callback_reader.html">ServerCallbackReader</a> </td>
  120. <td>(</td>
  121. <td class="paramname"></td><td>)</td>
  122. <td></td>
  123. </tr>
  124. </table>
  125. </td>
  126. <td class="mlabels-right">
  127. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span></span> </td>
  128. </tr>
  129. </table>
  130. </div><div class="memdoc">
  131. </div>
  132. </div>
  133. <h2 class="groupheader">Member Function Documentation</h2>
  134. <a id="af3b9135769a9a677046a37c29012ffa7"></a>
  135. <h2 class="memtitle"><span class="permalink"><a href="#af3b9135769a9a677046a37c29012ffa7">&#9670;&nbsp;</a></span>BindReactor()</h2>
  136. <div class="memitem">
  137. <div class="memproto">
  138. <div class="memtemplate">
  139. template&lt;class Request &gt; </div>
  140. <table class="mlabels">
  141. <tr>
  142. <td class="mlabels-left">
  143. <table class="memname">
  144. <tr>
  145. <td class="memname">void <a class="el" href="classgrpc_1_1_server_callback_reader.html">grpc::ServerCallbackReader</a>&lt; Request &gt;::BindReactor </td>
  146. <td>(</td>
  147. <td class="paramtype"><a class="el" href="classgrpc_1_1_server_read_reactor.html">ServerReadReactor</a>&lt; Request &gt; *&#160;</td>
  148. <td class="paramname"><em>reactor</em></td><td>)</td>
  149. <td></td>
  150. </tr>
  151. </table>
  152. </td>
  153. <td class="mlabels-right">
  154. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
  155. </tr>
  156. </table>
  157. </div><div class="memdoc">
  158. </div>
  159. </div>
  160. <a id="ab51dd6f1320b5b9eb8d71ee2d8f72ac1"></a>
  161. <h2 class="memtitle"><span class="permalink"><a href="#ab51dd6f1320b5b9eb8d71ee2d8f72ac1">&#9670;&nbsp;</a></span>Finish()</h2>
  162. <div class="memitem">
  163. <div class="memproto">
  164. <div class="memtemplate">
  165. template&lt;class Request &gt; </div>
  166. <table class="mlabels">
  167. <tr>
  168. <td class="mlabels-left">
  169. <table class="memname">
  170. <tr>
  171. <td class="memname">virtual void <a class="el" href="classgrpc_1_1_server_callback_reader.html">grpc::ServerCallbackReader</a>&lt; Request &gt;::Finish </td>
  172. <td>(</td>
  173. <td class="paramtype">::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a>&#160;</td>
  174. <td class="paramname"><em>s</em></td><td>)</td>
  175. <td></td>
  176. </tr>
  177. </table>
  178. </td>
  179. <td class="mlabels-right">
  180. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  181. </tr>
  182. </table>
  183. </div><div class="memdoc">
  184. </div>
  185. </div>
  186. <a id="a0092d67dc1eba2fcf54cec76c09275d0"></a>
  187. <h2 class="memtitle"><span class="permalink"><a href="#a0092d67dc1eba2fcf54cec76c09275d0">&#9670;&nbsp;</a></span>Read()</h2>
  188. <div class="memitem">
  189. <div class="memproto">
  190. <div class="memtemplate">
  191. template&lt;class Request &gt; </div>
  192. <table class="mlabels">
  193. <tr>
  194. <td class="mlabels-left">
  195. <table class="memname">
  196. <tr>
  197. <td class="memname">virtual void <a class="el" href="classgrpc_1_1_server_callback_reader.html">grpc::ServerCallbackReader</a>&lt; Request &gt;::Read </td>
  198. <td>(</td>
  199. <td class="paramtype">Request *&#160;</td>
  200. <td class="paramname"><em>msg</em></td><td>)</td>
  201. <td></td>
  202. </tr>
  203. </table>
  204. </td>
  205. <td class="mlabels-right">
  206. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  207. </tr>
  208. </table>
  209. </div><div class="memdoc">
  210. </div>
  211. </div>
  212. <a id="ac436c0d692702d1e77a4c3ec8e7dd2b6"></a>
  213. <h2 class="memtitle"><span class="permalink"><a href="#ac436c0d692702d1e77a4c3ec8e7dd2b6">&#9670;&nbsp;</a></span>SendInitialMetadata()</h2>
  214. <div class="memitem">
  215. <div class="memproto">
  216. <div class="memtemplate">
  217. template&lt;class Request &gt; </div>
  218. <table class="mlabels">
  219. <tr>
  220. <td class="mlabels-left">
  221. <table class="memname">
  222. <tr>
  223. <td class="memname">virtual void <a class="el" href="classgrpc_1_1_server_callback_reader.html">grpc::ServerCallbackReader</a>&lt; Request &gt;::SendInitialMetadata </td>
  224. <td>(</td>
  225. <td class="paramname"></td><td>)</td>
  226. <td></td>
  227. </tr>
  228. </table>
  229. </td>
  230. <td class="mlabels-right">
  231. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  232. </tr>
  233. </table>
  234. </div><div class="memdoc">
  235. </div>
  236. </div>
  237. <hr/>The documentation for this class was generated from the following file:<ul>
  238. <li>include/grpcpp/impl/codegen/<a class="el" href="impl_2codegen_2server__callback_8h_source.html">server_callback.h</a></li>
  239. </ul>
  240. </div><!-- contents -->
  241. <!-- start footer part -->
  242. <hr class="footer"/><address class="footer"><small>
  243. Generated on Wed Mar 3 2021 19:17:25 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  244. <img class="footer" src="doxygen.png" alt="doxygen"/>
  245. </a> 1.8.17
  246. </small></address>
  247. </body>
  248. </html>