classgrpc_1_1_client_read_reactor.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400
  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::ClientReadReactor&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_client_read_reactor.html">ClientReadReactor</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="#friends">Friends</a> </div>
  70. <div class="headertitle">
  71. <div class="title">grpc::ClientReadReactor&lt; Response &gt; Class Template Reference</div> </div>
  72. </div><!--header-->
  73. <div class="contents">
  74. <p><em><a class="el" href="classgrpc_1_1_client_read_reactor.html" title="ClientReadReactor is the interface for a server-streaming RPC.">ClientReadReactor</a></em> is the interface for a server-streaming RPC.
  75. <a href="classgrpc_1_1_client_read_reactor.html#details">More...</a></p>
  76. <p><code>#include &lt;<a class="el" href="impl_2codegen_2client__callback_8h_source.html">client_callback.h</a>&gt;</code></p>
  77. <table class="memberdecls">
  78. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  79. Public Member Functions</h2></td></tr>
  80. <tr class="memitem:a733dd6173b1dee96fb7a28bdb7f3478c"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_read_reactor.html#a733dd6173b1dee96fb7a28bdb7f3478c">~ClientReadReactor</a> ()</td></tr>
  81. <tr class="separator:a733dd6173b1dee96fb7a28bdb7f3478c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:a42f65b07316a1b9672b34ecf8f5686c2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_read_reactor.html#a42f65b07316a1b9672b34ecf8f5686c2">StartCall</a> ()</td></tr>
  83. <tr class="separator:a42f65b07316a1b9672b34ecf8f5686c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:ab42ab8137395ae6becd37032a95aeb99"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_read_reactor.html#ab42ab8137395ae6becd37032a95aeb99">StartRead</a> (Response *resp)</td></tr>
  85. <tr class="separator:ab42ab8137395ae6becd37032a95aeb99"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:a64840e64f3e174a6f278f2944b9b76b3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_read_reactor.html#a64840e64f3e174a6f278f2944b9b76b3">AddHold</a> ()</td></tr>
  87. <tr class="separator:a64840e64f3e174a6f278f2944b9b76b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:a5a55187f479c2427a156677de3ab5fc5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_read_reactor.html#a5a55187f479c2427a156677de3ab5fc5">AddMultipleHolds</a> (int holds)</td></tr>
  89. <tr class="separator:a5a55187f479c2427a156677de3ab5fc5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:af3df4e412be5ad69ab8310fe7503b52f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_read_reactor.html#af3df4e412be5ad69ab8310fe7503b52f">RemoveHold</a> ()</td></tr>
  91. <tr class="separator:af3df4e412be5ad69ab8310fe7503b52f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:ab3a645f5fc84ee7142ad1e1ecd76baa1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_read_reactor.html#ab3a645f5fc84ee7142ad1e1ecd76baa1">OnDone</a> (const ::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> &amp;) override</td></tr>
  93. <tr class="separator:ab3a645f5fc84ee7142ad1e1ecd76baa1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a066c74b32c8621aaa9588920640f2a44"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_read_reactor.html#a066c74b32c8621aaa9588920640f2a44">OnReadInitialMetadataDone</a> (bool)</td></tr>
  95. <tr class="separator:a066c74b32c8621aaa9588920640f2a44"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:ab1aa9b5ad7988d0b7a34b798fa20691a"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_read_reactor.html#ab1aa9b5ad7988d0b7a34b798fa20691a">OnReadDone</a> (bool)</td></tr>
  97. <tr class="separator:ab1aa9b5ad7988d0b7a34b798fa20691a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. </table><table class="memberdecls">
  99. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  100. Friends</h2></td></tr>
  101. <tr class="memitem:aea195c80cb9809bbc4c6ae8f436cda69"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_read_reactor.html#aea195c80cb9809bbc4c6ae8f436cda69">ClientCallbackReader&lt; Response &gt;</a></td></tr>
  102. <tr class="separator:aea195c80cb9809bbc4c6ae8f436cda69"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. </table>
  104. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  105. <div class="textblock"><h3>template&lt;class Response&gt;<br />
  106. class grpc::ClientReadReactor&lt; Response &gt;</h3>
  107. <p><em><a class="el" href="classgrpc_1_1_client_read_reactor.html" title="ClientReadReactor is the interface for a server-streaming RPC.">ClientReadReactor</a></em> is the interface for a server-streaming RPC. </p>
  108. <p>All public methods behave as in <a class="el" href="classgrpc_1_1_client_bidi_reactor.html" title="ClientBidiReactor is the interface for a bidirectional streaming RPC.">ClientBidiReactor</a>. </p>
  109. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  110. <a id="a733dd6173b1dee96fb7a28bdb7f3478c"></a>
  111. <h2 class="memtitle"><span class="permalink"><a href="#a733dd6173b1dee96fb7a28bdb7f3478c">&#9670;&nbsp;</a></span>~ClientReadReactor()</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">virtual <a class="el" href="classgrpc_1_1_client_read_reactor.html">grpc::ClientReadReactor</a>&lt; Response &gt;::~<a class="el" href="classgrpc_1_1_client_read_reactor.html">ClientReadReactor</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">virtual</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="a64840e64f3e174a6f278f2944b9b76b3"></a>
  137. <h2 class="memtitle"><span class="permalink"><a href="#a64840e64f3e174a6f278f2944b9b76b3">&#9670;&nbsp;</a></span>AddHold()</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_client_read_reactor.html">grpc::ClientReadReactor</a>&lt; Response &gt;::AddHold </td>
  148. <td>(</td>
  149. <td class="paramname"></td><td>)</td>
  150. <td></td>
  151. </tr>
  152. </table>
  153. </td>
  154. <td class="mlabels-right">
  155. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  156. </tr>
  157. </table>
  158. </div><div class="memdoc">
  159. </div>
  160. </div>
  161. <a id="a5a55187f479c2427a156677de3ab5fc5"></a>
  162. <h2 class="memtitle"><span class="permalink"><a href="#a5a55187f479c2427a156677de3ab5fc5">&#9670;&nbsp;</a></span>AddMultipleHolds()</h2>
  163. <div class="memitem">
  164. <div class="memproto">
  165. <div class="memtemplate">
  166. template&lt;class Response &gt; </div>
  167. <table class="mlabels">
  168. <tr>
  169. <td class="mlabels-left">
  170. <table class="memname">
  171. <tr>
  172. <td class="memname">void <a class="el" href="classgrpc_1_1_client_read_reactor.html">grpc::ClientReadReactor</a>&lt; Response &gt;::AddMultipleHolds </td>
  173. <td>(</td>
  174. <td class="paramtype">int&#160;</td>
  175. <td class="paramname"><em>holds</em></td><td>)</td>
  176. <td></td>
  177. </tr>
  178. </table>
  179. </td>
  180. <td class="mlabels-right">
  181. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  182. </tr>
  183. </table>
  184. </div><div class="memdoc">
  185. </div>
  186. </div>
  187. <a id="ab3a645f5fc84ee7142ad1e1ecd76baa1"></a>
  188. <h2 class="memtitle"><span class="permalink"><a href="#ab3a645f5fc84ee7142ad1e1ecd76baa1">&#9670;&nbsp;</a></span>OnDone()</h2>
  189. <div class="memitem">
  190. <div class="memproto">
  191. <div class="memtemplate">
  192. template&lt;class Response &gt; </div>
  193. <table class="mlabels">
  194. <tr>
  195. <td class="mlabels-left">
  196. <table class="memname">
  197. <tr>
  198. <td class="memname">void <a class="el" href="classgrpc_1_1_client_read_reactor.html">grpc::ClientReadReactor</a>&lt; Response &gt;::OnDone </td>
  199. <td>(</td>
  200. <td class="paramtype">const ::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> &amp;&#160;</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">inline</span><span class="mlabel">override</span></span> </td>
  208. </tr>
  209. </table>
  210. </div><div class="memdoc">
  211. </div>
  212. </div>
  213. <a id="ab1aa9b5ad7988d0b7a34b798fa20691a"></a>
  214. <h2 class="memtitle"><span class="permalink"><a href="#ab1aa9b5ad7988d0b7a34b798fa20691a">&#9670;&nbsp;</a></span>OnReadDone()</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_client_read_reactor.html">grpc::ClientReadReactor</a>&lt; Response &gt;::OnReadDone </td>
  225. <td>(</td>
  226. <td class="paramtype">bool&#160;</td>
  227. <td class="paramname"></td><td>)</td>
  228. <td></td>
  229. </tr>
  230. </table>
  231. </td>
  232. <td class="mlabels-right">
  233. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  234. </tr>
  235. </table>
  236. </div><div class="memdoc">
  237. </div>
  238. </div>
  239. <a id="a066c74b32c8621aaa9588920640f2a44"></a>
  240. <h2 class="memtitle"><span class="permalink"><a href="#a066c74b32c8621aaa9588920640f2a44">&#9670;&nbsp;</a></span>OnReadInitialMetadataDone()</h2>
  241. <div class="memitem">
  242. <div class="memproto">
  243. <div class="memtemplate">
  244. template&lt;class Response &gt; </div>
  245. <table class="mlabels">
  246. <tr>
  247. <td class="mlabels-left">
  248. <table class="memname">
  249. <tr>
  250. <td class="memname">virtual void <a class="el" href="classgrpc_1_1_client_read_reactor.html">grpc::ClientReadReactor</a>&lt; Response &gt;::OnReadInitialMetadataDone </td>
  251. <td>(</td>
  252. <td class="paramtype">bool&#160;</td>
  253. <td class="paramname"></td><td>)</td>
  254. <td></td>
  255. </tr>
  256. </table>
  257. </td>
  258. <td class="mlabels-right">
  259. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  260. </tr>
  261. </table>
  262. </div><div class="memdoc">
  263. </div>
  264. </div>
  265. <a id="af3df4e412be5ad69ab8310fe7503b52f"></a>
  266. <h2 class="memtitle"><span class="permalink"><a href="#af3df4e412be5ad69ab8310fe7503b52f">&#9670;&nbsp;</a></span>RemoveHold()</h2>
  267. <div class="memitem">
  268. <div class="memproto">
  269. <div class="memtemplate">
  270. template&lt;class Response &gt; </div>
  271. <table class="mlabels">
  272. <tr>
  273. <td class="mlabels-left">
  274. <table class="memname">
  275. <tr>
  276. <td class="memname">void <a class="el" href="classgrpc_1_1_client_read_reactor.html">grpc::ClientReadReactor</a>&lt; Response &gt;::RemoveHold </td>
  277. <td>(</td>
  278. <td class="paramname"></td><td>)</td>
  279. <td></td>
  280. </tr>
  281. </table>
  282. </td>
  283. <td class="mlabels-right">
  284. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  285. </tr>
  286. </table>
  287. </div><div class="memdoc">
  288. </div>
  289. </div>
  290. <a id="a42f65b07316a1b9672b34ecf8f5686c2"></a>
  291. <h2 class="memtitle"><span class="permalink"><a href="#a42f65b07316a1b9672b34ecf8f5686c2">&#9670;&nbsp;</a></span>StartCall()</h2>
  292. <div class="memitem">
  293. <div class="memproto">
  294. <div class="memtemplate">
  295. template&lt;class Response &gt; </div>
  296. <table class="mlabels">
  297. <tr>
  298. <td class="mlabels-left">
  299. <table class="memname">
  300. <tr>
  301. <td class="memname">void <a class="el" href="classgrpc_1_1_client_read_reactor.html">grpc::ClientReadReactor</a>&lt; Response &gt;::StartCall </td>
  302. <td>(</td>
  303. <td class="paramname"></td><td>)</td>
  304. <td></td>
  305. </tr>
  306. </table>
  307. </td>
  308. <td class="mlabels-right">
  309. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  310. </tr>
  311. </table>
  312. </div><div class="memdoc">
  313. </div>
  314. </div>
  315. <a id="ab42ab8137395ae6becd37032a95aeb99"></a>
  316. <h2 class="memtitle"><span class="permalink"><a href="#ab42ab8137395ae6becd37032a95aeb99">&#9670;&nbsp;</a></span>StartRead()</h2>
  317. <div class="memitem">
  318. <div class="memproto">
  319. <div class="memtemplate">
  320. template&lt;class Response &gt; </div>
  321. <table class="mlabels">
  322. <tr>
  323. <td class="mlabels-left">
  324. <table class="memname">
  325. <tr>
  326. <td class="memname">void <a class="el" href="classgrpc_1_1_client_read_reactor.html">grpc::ClientReadReactor</a>&lt; Response &gt;::StartRead </td>
  327. <td>(</td>
  328. <td class="paramtype">Response *&#160;</td>
  329. <td class="paramname"><em>resp</em></td><td>)</td>
  330. <td></td>
  331. </tr>
  332. </table>
  333. </td>
  334. <td class="mlabels-right">
  335. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  336. </tr>
  337. </table>
  338. </div><div class="memdoc">
  339. </div>
  340. </div>
  341. <h2 class="groupheader">Friends And Related Function Documentation</h2>
  342. <a id="aea195c80cb9809bbc4c6ae8f436cda69"></a>
  343. <h2 class="memtitle"><span class="permalink"><a href="#aea195c80cb9809bbc4c6ae8f436cda69">&#9670;&nbsp;</a></span>ClientCallbackReader&lt; Response &gt;</h2>
  344. <div class="memitem">
  345. <div class="memproto">
  346. <div class="memtemplate">
  347. template&lt;class Response &gt; </div>
  348. <table class="mlabels">
  349. <tr>
  350. <td class="mlabels-left">
  351. <table class="memname">
  352. <tr>
  353. <td class="memname">friend class <a class="el" href="classgrpc_1_1_client_callback_reader.html">ClientCallbackReader</a>&lt; Response &gt;</td>
  354. </tr>
  355. </table>
  356. </td>
  357. <td class="mlabels-right">
  358. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  359. </tr>
  360. </table>
  361. </div><div class="memdoc">
  362. </div>
  363. </div>
  364. <hr/>The documentation for this class was generated from the following file:<ul>
  365. <li>include/grpcpp/impl/codegen/<a class="el" href="impl_2codegen_2client__callback_8h_source.html">client_callback.h</a></li>
  366. </ul>
  367. </div><!-- contents -->
  368. <!-- start footer part -->
  369. <hr class="footer"/><address class="footer"><small>
  370. Generated on Wed Mar 3 2021 19:17:24 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  371. <img class="footer" src="doxygen.png" alt="doxygen"/>
  372. </a> 1.8.17
  373. </small></address>
  374. </body>
  375. </html>