classgrpc_1_1experimental_1_1_server_callback_reader_writer.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.13"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>GRPC C++: grpc::experimental::ServerCallbackReaderWriter&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.22.0</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.13 -->
  34. <script type="text/javascript">
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36. </script>
  37. <script type="text/javascript" src="menudata.js"></script>
  38. <script type="text/javascript" src="menu.js"></script>
  39. <script type="text/javascript">
  40. $(function() {
  41. initMenu('',true,false,'search.php','Search');
  42. $(document).ready(function() { init_search(); });
  43. });
  44. </script>
  45. <div id="main-nav"></div>
  46. <!-- window showing the filter options -->
  47. <div id="MSearchSelectWindow"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. onkeydown="return searchBox.OnSearchSelectKey(event)">
  51. </div>
  52. <!-- iframe showing the search results (closed by default) -->
  53. <div id="MSearchResultsWindow">
  54. <iframe src="javascript:void(0)" frameborder="0"
  55. name="MSearchResults" id="MSearchResults">
  56. </iframe>
  57. </div>
  58. <div id="nav-path" class="navpath">
  59. <ul>
  60. <li class="navelem"><a class="el" href="namespacegrpc.html">grpc</a></li><li class="navelem"><a class="el" href="namespacegrpc_1_1experimental.html">experimental</a></li><li class="navelem"><a class="el" href="classgrpc_1_1experimental_1_1_server_callback_reader_writer.html">ServerCallbackReaderWriter</a></li> </ul>
  61. </div>
  62. </div><!-- top -->
  63. <div class="header">
  64. <div class="summary">
  65. <a href="#pub-methods">Public Member Functions</a> &#124;
  66. <a href="#pro-methods">Protected Member Functions</a> </div>
  67. <div class="headertitle">
  68. <div class="title">grpc::experimental::ServerCallbackReaderWriter&lt; Request, Response &gt; Class Template Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
  69. </div><!--header-->
  70. <div class="contents">
  71. <p><code>#include &lt;<a class="el" href="impl_2codegen_2server__callback_8h_source.html">server_callback.h</a>&gt;</code></p>
  72. <table class="memberdecls">
  73. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  74. Public Member Functions</h2></td></tr>
  75. <tr class="memitem:ae866f87768fbef9180b25b2a933e054d"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_server_callback_reader_writer.html#ae866f87768fbef9180b25b2a933e054d">~ServerCallbackReaderWriter</a> ()</td></tr>
  76. <tr class="separator:ae866f87768fbef9180b25b2a933e054d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:a396c5554fb6e71a5403bd1311c326a9b"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_server_callback_reader_writer.html#a396c5554fb6e71a5403bd1311c326a9b">Finish</a> (<a class="el" href="classgrpc_1_1_status.html">Status</a> s)=0</td></tr>
  78. <tr class="separator:a396c5554fb6e71a5403bd1311c326a9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <tr class="memitem:acab58ec5199508778c010a07aa08c00a"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_server_callback_reader_writer.html#acab58ec5199508778c010a07aa08c00a">SendInitialMetadata</a> ()=0</td></tr>
  80. <tr class="separator:acab58ec5199508778c010a07aa08c00a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  81. <tr class="memitem:a1dce70f0a64fab08f76bf76423edb62d"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_server_callback_reader_writer.html#a1dce70f0a64fab08f76bf76423edb62d">Read</a> (Request *msg)=0</td></tr>
  82. <tr class="separator:a1dce70f0a64fab08f76bf76423edb62d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:a1b5744874ff3a29b85f841dbdddc8780"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_server_callback_reader_writer.html#a1b5744874ff3a29b85f841dbdddc8780">Write</a> (const Response *msg, <a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> options)=0</td></tr>
  84. <tr class="separator:a1b5744874ff3a29b85f841dbdddc8780"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:a9bfa80fbd8f24d2f3d5b9937579aa03b"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_server_callback_reader_writer.html#a9bfa80fbd8f24d2f3d5b9937579aa03b">WriteAndFinish</a> (const Response *msg, <a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a> options, <a class="el" href="classgrpc_1_1_status.html">Status</a> s)</td></tr>
  86. <tr class="separator:a9bfa80fbd8f24d2f3d5b9937579aa03b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. </table><table class="memberdecls">
  88. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
  89. Protected Member Functions</h2></td></tr>
  90. <tr class="memitem:ab7d6ea819e5e6e199e121d0fb980a210"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1experimental_1_1_server_callback_reader_writer.html#ab7d6ea819e5e6e199e121d0fb980a210">BindReactor</a> (<a class="el" href="classgrpc_1_1experimental_1_1_server_bidi_reactor.html">ServerBidiReactor</a>&lt; Request, Response &gt; *reactor)</td></tr>
  91. <tr class="separator:ab7d6ea819e5e6e199e121d0fb980a210"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. </table>
  93. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  94. <a id="ae866f87768fbef9180b25b2a933e054d"></a>
  95. <h2 class="memtitle"><span class="permalink"><a href="#ae866f87768fbef9180b25b2a933e054d">&#9670;&nbsp;</a></span>~ServerCallbackReaderWriter()</h2>
  96. <div class="memitem">
  97. <div class="memproto">
  98. <div class="memtemplate">
  99. template&lt;class Request, class Response&gt; </div>
  100. <table class="mlabels">
  101. <tr>
  102. <td class="mlabels-left">
  103. <table class="memname">
  104. <tr>
  105. <td class="memname">virtual <a class="el" href="classgrpc_1_1experimental_1_1_server_callback_reader_writer.html">grpc::experimental::ServerCallbackReaderWriter</a>&lt; Request, Response &gt;::~<a class="el" href="classgrpc_1_1experimental_1_1_server_callback_reader_writer.html">ServerCallbackReaderWriter</a> </td>
  106. <td>(</td>
  107. <td class="paramname"></td><td>)</td>
  108. <td></td>
  109. </tr>
  110. </table>
  111. </td>
  112. <td class="mlabels-right">
  113. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  114. </tr>
  115. </table>
  116. </div><div class="memdoc">
  117. </div>
  118. </div>
  119. <h2 class="groupheader">Member Function Documentation</h2>
  120. <a id="ab7d6ea819e5e6e199e121d0fb980a210"></a>
  121. <h2 class="memtitle"><span class="permalink"><a href="#ab7d6ea819e5e6e199e121d0fb980a210">&#9670;&nbsp;</a></span>BindReactor()</h2>
  122. <div class="memitem">
  123. <div class="memproto">
  124. <div class="memtemplate">
  125. template&lt;class Request, class Response&gt; </div>
  126. <table class="mlabels">
  127. <tr>
  128. <td class="mlabels-left">
  129. <table class="memname">
  130. <tr>
  131. <td class="memname">void <a class="el" href="classgrpc_1_1experimental_1_1_server_callback_reader_writer.html">grpc::experimental::ServerCallbackReaderWriter</a>&lt; Request, Response &gt;::BindReactor </td>
  132. <td>(</td>
  133. <td class="paramtype"><a class="el" href="classgrpc_1_1experimental_1_1_server_bidi_reactor.html">ServerBidiReactor</a>&lt; Request, Response &gt; *&#160;</td>
  134. <td class="paramname"><em>reactor</em></td><td>)</td>
  135. <td></td>
  136. </tr>
  137. </table>
  138. </td>
  139. <td class="mlabels-right">
  140. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
  141. </tr>
  142. </table>
  143. </div><div class="memdoc">
  144. </div>
  145. </div>
  146. <a id="a396c5554fb6e71a5403bd1311c326a9b"></a>
  147. <h2 class="memtitle"><span class="permalink"><a href="#a396c5554fb6e71a5403bd1311c326a9b">&#9670;&nbsp;</a></span>Finish()</h2>
  148. <div class="memitem">
  149. <div class="memproto">
  150. <div class="memtemplate">
  151. template&lt;class Request, class Response&gt; </div>
  152. <table class="mlabels">
  153. <tr>
  154. <td class="mlabels-left">
  155. <table class="memname">
  156. <tr>
  157. <td class="memname">virtual void <a class="el" href="classgrpc_1_1experimental_1_1_server_callback_reader_writer.html">grpc::experimental::ServerCallbackReaderWriter</a>&lt; Request, Response &gt;::Finish </td>
  158. <td>(</td>
  159. <td class="paramtype"><a class="el" href="classgrpc_1_1_status.html">Status</a>&#160;</td>
  160. <td class="paramname"><em>s</em></td><td>)</td>
  161. <td></td>
  162. </tr>
  163. </table>
  164. </td>
  165. <td class="mlabels-right">
  166. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  167. </tr>
  168. </table>
  169. </div><div class="memdoc">
  170. </div>
  171. </div>
  172. <a id="a1dce70f0a64fab08f76bf76423edb62d"></a>
  173. <h2 class="memtitle"><span class="permalink"><a href="#a1dce70f0a64fab08f76bf76423edb62d">&#9670;&nbsp;</a></span>Read()</h2>
  174. <div class="memitem">
  175. <div class="memproto">
  176. <div class="memtemplate">
  177. template&lt;class Request, class Response&gt; </div>
  178. <table class="mlabels">
  179. <tr>
  180. <td class="mlabels-left">
  181. <table class="memname">
  182. <tr>
  183. <td class="memname">virtual void <a class="el" href="classgrpc_1_1experimental_1_1_server_callback_reader_writer.html">grpc::experimental::ServerCallbackReaderWriter</a>&lt; Request, Response &gt;::Read </td>
  184. <td>(</td>
  185. <td class="paramtype">Request *&#160;</td>
  186. <td class="paramname"><em>msg</em></td><td>)</td>
  187. <td></td>
  188. </tr>
  189. </table>
  190. </td>
  191. <td class="mlabels-right">
  192. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  193. </tr>
  194. </table>
  195. </div><div class="memdoc">
  196. </div>
  197. </div>
  198. <a id="acab58ec5199508778c010a07aa08c00a"></a>
  199. <h2 class="memtitle"><span class="permalink"><a href="#acab58ec5199508778c010a07aa08c00a">&#9670;&nbsp;</a></span>SendInitialMetadata()</h2>
  200. <div class="memitem">
  201. <div class="memproto">
  202. <div class="memtemplate">
  203. template&lt;class Request, class Response&gt; </div>
  204. <table class="mlabels">
  205. <tr>
  206. <td class="mlabels-left">
  207. <table class="memname">
  208. <tr>
  209. <td class="memname">virtual void <a class="el" href="classgrpc_1_1experimental_1_1_server_callback_reader_writer.html">grpc::experimental::ServerCallbackReaderWriter</a>&lt; Request, Response &gt;::SendInitialMetadata </td>
  210. <td>(</td>
  211. <td class="paramname"></td><td>)</td>
  212. <td></td>
  213. </tr>
  214. </table>
  215. </td>
  216. <td class="mlabels-right">
  217. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  218. </tr>
  219. </table>
  220. </div><div class="memdoc">
  221. </div>
  222. </div>
  223. <a id="a1b5744874ff3a29b85f841dbdddc8780"></a>
  224. <h2 class="memtitle"><span class="permalink"><a href="#a1b5744874ff3a29b85f841dbdddc8780">&#9670;&nbsp;</a></span>Write()</h2>
  225. <div class="memitem">
  226. <div class="memproto">
  227. <div class="memtemplate">
  228. template&lt;class Request, class Response&gt; </div>
  229. <table class="mlabels">
  230. <tr>
  231. <td class="mlabels-left">
  232. <table class="memname">
  233. <tr>
  234. <td class="memname">virtual void <a class="el" href="classgrpc_1_1experimental_1_1_server_callback_reader_writer.html">grpc::experimental::ServerCallbackReaderWriter</a>&lt; Request, Response &gt;::Write </td>
  235. <td>(</td>
  236. <td class="paramtype">const Response *&#160;</td>
  237. <td class="paramname"><em>msg</em>, </td>
  238. </tr>
  239. <tr>
  240. <td class="paramkey"></td>
  241. <td></td>
  242. <td class="paramtype"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&#160;</td>
  243. <td class="paramname"><em>options</em>&#160;</td>
  244. </tr>
  245. <tr>
  246. <td></td>
  247. <td>)</td>
  248. <td></td><td></td>
  249. </tr>
  250. </table>
  251. </td>
  252. <td class="mlabels-right">
  253. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  254. </tr>
  255. </table>
  256. </div><div class="memdoc">
  257. </div>
  258. </div>
  259. <a id="a9bfa80fbd8f24d2f3d5b9937579aa03b"></a>
  260. <h2 class="memtitle"><span class="permalink"><a href="#a9bfa80fbd8f24d2f3d5b9937579aa03b">&#9670;&nbsp;</a></span>WriteAndFinish()</h2>
  261. <div class="memitem">
  262. <div class="memproto">
  263. <div class="memtemplate">
  264. template&lt;class Request, class Response&gt; </div>
  265. <table class="mlabels">
  266. <tr>
  267. <td class="mlabels-left">
  268. <table class="memname">
  269. <tr>
  270. <td class="memname">virtual void <a class="el" href="classgrpc_1_1experimental_1_1_server_callback_reader_writer.html">grpc::experimental::ServerCallbackReaderWriter</a>&lt; Request, Response &gt;::WriteAndFinish </td>
  271. <td>(</td>
  272. <td class="paramtype">const Response *&#160;</td>
  273. <td class="paramname"><em>msg</em>, </td>
  274. </tr>
  275. <tr>
  276. <td class="paramkey"></td>
  277. <td></td>
  278. <td class="paramtype"><a class="el" href="classgrpc_1_1_write_options.html">WriteOptions</a>&#160;</td>
  279. <td class="paramname"><em>options</em>, </td>
  280. </tr>
  281. <tr>
  282. <td class="paramkey"></td>
  283. <td></td>
  284. <td class="paramtype"><a class="el" href="classgrpc_1_1_status.html">Status</a>&#160;</td>
  285. <td class="paramname"><em>s</em>&#160;</td>
  286. </tr>
  287. <tr>
  288. <td></td>
  289. <td>)</td>
  290. <td></td><td></td>
  291. </tr>
  292. </table>
  293. </td>
  294. <td class="mlabels-right">
  295. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  296. </tr>
  297. </table>
  298. </div><div class="memdoc">
  299. </div>
  300. </div>
  301. <hr/>The documentation for this class was generated from the following file:<ul>
  302. <li>include/grpcpp/impl/codegen/<a class="el" href="impl_2codegen_2server__callback_8h_source.html">server_callback.h</a></li>
  303. </ul>
  304. </div><!-- contents -->
  305. <!-- start footer part -->
  306. <hr class="footer"/><address class="footer"><small>
  307. Generated on Wed Jul 3 2019 14:51:27 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  308. <img class="footer" src="doxygen.png" alt="doxygen"/>
  309. </a> 1.8.13
  310. </small></address>
  311. </body>
  312. </html>