classgrpc_1_1_client_callback_reader_writer.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356
  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::ClientCallbackReaderWriter&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.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_callback_reader_writer.html">ClientCallbackReaderWriter</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::ClientCallbackReaderWriter&lt; Request, 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_2client__callback_8h_source.html">client_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:aa9ba72f47c3b16abe061b61d76cf05f6"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_callback_reader_writer.html#aa9ba72f47c3b16abe061b61d76cf05f6">~ClientCallbackReaderWriter</a> ()</td></tr>
  79. <tr class="separator:aa9ba72f47c3b16abe061b61d76cf05f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:a70a53d905deff6f2e26fa907c9755efe"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_callback_reader_writer.html#a70a53d905deff6f2e26fa907c9755efe">StartCall</a> ()=0</td></tr>
  81. <tr class="separator:a70a53d905deff6f2e26fa907c9755efe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:a31d9b960dc6ef6d89f5f48d1468d3d14"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_callback_reader_writer.html#a31d9b960dc6ef6d89f5f48d1468d3d14">Write</a> (const Request *req, ::<a class="el" href="classgrpc_1_1_write_options.html">grpc::WriteOptions</a> options)=0</td></tr>
  83. <tr class="separator:a31d9b960dc6ef6d89f5f48d1468d3d14"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:aa5d2704b98c50228a5f1eb196ea9df0b"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_callback_reader_writer.html#aa5d2704b98c50228a5f1eb196ea9df0b">WritesDone</a> ()=0</td></tr>
  85. <tr class="separator:aa5d2704b98c50228a5f1eb196ea9df0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:a62e0cca3a9232b040964134828f7c304"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_callback_reader_writer.html#a62e0cca3a9232b040964134828f7c304">Read</a> (Response *resp)=0</td></tr>
  87. <tr class="separator:a62e0cca3a9232b040964134828f7c304"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:a91bc5f726c434a2601f47193a758b5f5"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_callback_reader_writer.html#a91bc5f726c434a2601f47193a758b5f5">AddHold</a> (int holds)=0</td></tr>
  89. <tr class="separator:a91bc5f726c434a2601f47193a758b5f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a1a68eddd8e28f837ca749cf08ac3cdfb"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_callback_reader_writer.html#a1a68eddd8e28f837ca749cf08ac3cdfb">RemoveHold</a> ()=0</td></tr>
  91. <tr class="separator:a1a68eddd8e28f837ca749cf08ac3cdfb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. </table><table class="memberdecls">
  93. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
  94. Protected Member Functions</h2></td></tr>
  95. <tr class="memitem:aef74ebca4bb8c5b6a883b495346bbaba"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_callback_reader_writer.html#aef74ebca4bb8c5b6a883b495346bbaba">BindReactor</a> (<a class="el" href="classgrpc_1_1_client_bidi_reactor.html">ClientBidiReactor</a>&lt; Request, Response &gt; *reactor)</td></tr>
  96. <tr class="separator:aef74ebca4bb8c5b6a883b495346bbaba"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. </table>
  98. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  99. <a id="aa9ba72f47c3b16abe061b61d76cf05f6"></a>
  100. <h2 class="memtitle"><span class="permalink"><a href="#aa9ba72f47c3b16abe061b61d76cf05f6">&#9670;&nbsp;</a></span>~ClientCallbackReaderWriter()</h2>
  101. <div class="memitem">
  102. <div class="memproto">
  103. <div class="memtemplate">
  104. template&lt;class Request , class Response &gt; </div>
  105. <table class="mlabels">
  106. <tr>
  107. <td class="mlabels-left">
  108. <table class="memname">
  109. <tr>
  110. <td class="memname">virtual <a class="el" href="classgrpc_1_1_client_callback_reader_writer.html">grpc::ClientCallbackReaderWriter</a>&lt; Request, Response &gt;::~<a class="el" href="classgrpc_1_1_client_callback_reader_writer.html">ClientCallbackReaderWriter</a> </td>
  111. <td>(</td>
  112. <td class="paramname"></td><td>)</td>
  113. <td></td>
  114. </tr>
  115. </table>
  116. </td>
  117. <td class="mlabels-right">
  118. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  119. </tr>
  120. </table>
  121. </div><div class="memdoc">
  122. </div>
  123. </div>
  124. <h2 class="groupheader">Member Function Documentation</h2>
  125. <a id="a91bc5f726c434a2601f47193a758b5f5"></a>
  126. <h2 class="memtitle"><span class="permalink"><a href="#a91bc5f726c434a2601f47193a758b5f5">&#9670;&nbsp;</a></span>AddHold()</h2>
  127. <div class="memitem">
  128. <div class="memproto">
  129. <div class="memtemplate">
  130. template&lt;class Request , class Response &gt; </div>
  131. <table class="mlabels">
  132. <tr>
  133. <td class="mlabels-left">
  134. <table class="memname">
  135. <tr>
  136. <td class="memname">virtual void <a class="el" href="classgrpc_1_1_client_callback_reader_writer.html">grpc::ClientCallbackReaderWriter</a>&lt; Request, Response &gt;::AddHold </td>
  137. <td>(</td>
  138. <td class="paramtype">int&#160;</td>
  139. <td class="paramname"><em>holds</em></td><td>)</td>
  140. <td></td>
  141. </tr>
  142. </table>
  143. </td>
  144. <td class="mlabels-right">
  145. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  146. </tr>
  147. </table>
  148. </div><div class="memdoc">
  149. <p>Implemented in <a class="el" href="classgrpc_1_1internal_1_1_client_callback_reader_writer_impl.html#ad27f95865c673a8302e3bac88a0466b1">grpc::internal::ClientCallbackReaderWriterImpl&lt; Request, Response &gt;</a>.</p>
  150. </div>
  151. </div>
  152. <a id="aef74ebca4bb8c5b6a883b495346bbaba"></a>
  153. <h2 class="memtitle"><span class="permalink"><a href="#aef74ebca4bb8c5b6a883b495346bbaba">&#9670;&nbsp;</a></span>BindReactor()</h2>
  154. <div class="memitem">
  155. <div class="memproto">
  156. <div class="memtemplate">
  157. template&lt;class Request , class Response &gt; </div>
  158. <table class="mlabels">
  159. <tr>
  160. <td class="mlabels-left">
  161. <table class="memname">
  162. <tr>
  163. <td class="memname">void <a class="el" href="classgrpc_1_1_client_callback_reader_writer.html">grpc::ClientCallbackReaderWriter</a>&lt; Request, Response &gt;::BindReactor </td>
  164. <td>(</td>
  165. <td class="paramtype"><a class="el" href="classgrpc_1_1_client_bidi_reactor.html">ClientBidiReactor</a>&lt; Request, Response &gt; *&#160;</td>
  166. <td class="paramname"><em>reactor</em></td><td>)</td>
  167. <td></td>
  168. </tr>
  169. </table>
  170. </td>
  171. <td class="mlabels-right">
  172. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span> </td>
  173. </tr>
  174. </table>
  175. </div><div class="memdoc">
  176. </div>
  177. </div>
  178. <a id="a62e0cca3a9232b040964134828f7c304"></a>
  179. <h2 class="memtitle"><span class="permalink"><a href="#a62e0cca3a9232b040964134828f7c304">&#9670;&nbsp;</a></span>Read()</h2>
  180. <div class="memitem">
  181. <div class="memproto">
  182. <div class="memtemplate">
  183. template&lt;class Request , class Response &gt; </div>
  184. <table class="mlabels">
  185. <tr>
  186. <td class="mlabels-left">
  187. <table class="memname">
  188. <tr>
  189. <td class="memname">virtual void <a class="el" href="classgrpc_1_1_client_callback_reader_writer.html">grpc::ClientCallbackReaderWriter</a>&lt; Request, Response &gt;::Read </td>
  190. <td>(</td>
  191. <td class="paramtype">Response *&#160;</td>
  192. <td class="paramname"><em>resp</em></td><td>)</td>
  193. <td></td>
  194. </tr>
  195. </table>
  196. </td>
  197. <td class="mlabels-right">
  198. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  199. </tr>
  200. </table>
  201. </div><div class="memdoc">
  202. <p>Implemented in <a class="el" href="classgrpc_1_1internal_1_1_client_callback_reader_writer_impl.html#ab5596220b111029b8f215237634921f3">grpc::internal::ClientCallbackReaderWriterImpl&lt; Request, Response &gt;</a>.</p>
  203. </div>
  204. </div>
  205. <a id="a1a68eddd8e28f837ca749cf08ac3cdfb"></a>
  206. <h2 class="memtitle"><span class="permalink"><a href="#a1a68eddd8e28f837ca749cf08ac3cdfb">&#9670;&nbsp;</a></span>RemoveHold()</h2>
  207. <div class="memitem">
  208. <div class="memproto">
  209. <div class="memtemplate">
  210. template&lt;class Request , class Response &gt; </div>
  211. <table class="mlabels">
  212. <tr>
  213. <td class="mlabels-left">
  214. <table class="memname">
  215. <tr>
  216. <td class="memname">virtual void <a class="el" href="classgrpc_1_1_client_callback_reader_writer.html">grpc::ClientCallbackReaderWriter</a>&lt; Request, Response &gt;::RemoveHold </td>
  217. <td>(</td>
  218. <td class="paramname"></td><td>)</td>
  219. <td></td>
  220. </tr>
  221. </table>
  222. </td>
  223. <td class="mlabels-right">
  224. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  225. </tr>
  226. </table>
  227. </div><div class="memdoc">
  228. <p>Implemented in <a class="el" href="classgrpc_1_1internal_1_1_client_callback_reader_writer_impl.html#afce5cca8736fda5ec142d610e451e00e">grpc::internal::ClientCallbackReaderWriterImpl&lt; Request, Response &gt;</a>.</p>
  229. </div>
  230. </div>
  231. <a id="a70a53d905deff6f2e26fa907c9755efe"></a>
  232. <h2 class="memtitle"><span class="permalink"><a href="#a70a53d905deff6f2e26fa907c9755efe">&#9670;&nbsp;</a></span>StartCall()</h2>
  233. <div class="memitem">
  234. <div class="memproto">
  235. <div class="memtemplate">
  236. template&lt;class Request , class Response &gt; </div>
  237. <table class="mlabels">
  238. <tr>
  239. <td class="mlabels-left">
  240. <table class="memname">
  241. <tr>
  242. <td class="memname">virtual void <a class="el" href="classgrpc_1_1_client_callback_reader_writer.html">grpc::ClientCallbackReaderWriter</a>&lt; Request, Response &gt;::StartCall </td>
  243. <td>(</td>
  244. <td class="paramname"></td><td>)</td>
  245. <td></td>
  246. </tr>
  247. </table>
  248. </td>
  249. <td class="mlabels-right">
  250. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  251. </tr>
  252. </table>
  253. </div><div class="memdoc">
  254. <p>Implemented in <a class="el" href="classgrpc_1_1internal_1_1_client_callback_reader_writer_impl.html#a280b84393872fc41fad3bdd44dade1c8">grpc::internal::ClientCallbackReaderWriterImpl&lt; Request, Response &gt;</a>.</p>
  255. </div>
  256. </div>
  257. <a id="a31d9b960dc6ef6d89f5f48d1468d3d14"></a>
  258. <h2 class="memtitle"><span class="permalink"><a href="#a31d9b960dc6ef6d89f5f48d1468d3d14">&#9670;&nbsp;</a></span>Write()</h2>
  259. <div class="memitem">
  260. <div class="memproto">
  261. <div class="memtemplate">
  262. template&lt;class Request , class Response &gt; </div>
  263. <table class="mlabels">
  264. <tr>
  265. <td class="mlabels-left">
  266. <table class="memname">
  267. <tr>
  268. <td class="memname">virtual void <a class="el" href="classgrpc_1_1_client_callback_reader_writer.html">grpc::ClientCallbackReaderWriter</a>&lt; Request, Response &gt;::Write </td>
  269. <td>(</td>
  270. <td class="paramtype">const Request *&#160;</td>
  271. <td class="paramname"><em>req</em>, </td>
  272. </tr>
  273. <tr>
  274. <td class="paramkey"></td>
  275. <td></td>
  276. <td class="paramtype">::<a class="el" href="classgrpc_1_1_write_options.html">grpc::WriteOptions</a>&#160;</td>
  277. <td class="paramname"><em>options</em>&#160;</td>
  278. </tr>
  279. <tr>
  280. <td></td>
  281. <td>)</td>
  282. <td></td><td></td>
  283. </tr>
  284. </table>
  285. </td>
  286. <td class="mlabels-right">
  287. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  288. </tr>
  289. </table>
  290. </div><div class="memdoc">
  291. <p>Implemented in <a class="el" href="classgrpc_1_1internal_1_1_client_callback_reader_writer_impl.html#ab3303ada2c53e159e6f1f1969a4f0b24">grpc::internal::ClientCallbackReaderWriterImpl&lt; Request, Response &gt;</a>.</p>
  292. </div>
  293. </div>
  294. <a id="aa5d2704b98c50228a5f1eb196ea9df0b"></a>
  295. <h2 class="memtitle"><span class="permalink"><a href="#aa5d2704b98c50228a5f1eb196ea9df0b">&#9670;&nbsp;</a></span>WritesDone()</h2>
  296. <div class="memitem">
  297. <div class="memproto">
  298. <div class="memtemplate">
  299. template&lt;class Request , class Response &gt; </div>
  300. <table class="mlabels">
  301. <tr>
  302. <td class="mlabels-left">
  303. <table class="memname">
  304. <tr>
  305. <td class="memname">virtual void <a class="el" href="classgrpc_1_1_client_callback_reader_writer.html">grpc::ClientCallbackReaderWriter</a>&lt; Request, Response &gt;::WritesDone </td>
  306. <td>(</td>
  307. <td class="paramname"></td><td>)</td>
  308. <td></td>
  309. </tr>
  310. </table>
  311. </td>
  312. <td class="mlabels-right">
  313. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  314. </tr>
  315. </table>
  316. </div><div class="memdoc">
  317. <p>Implemented in <a class="el" href="classgrpc_1_1internal_1_1_client_callback_reader_writer_impl.html#a618bf8ffa888846a489431fd4bded2db">grpc::internal::ClientCallbackReaderWriterImpl&lt; Request, Response &gt;</a>.</p>
  318. </div>
  319. </div>
  320. <hr/>The documentation for this class was generated from the following file:<ul>
  321. <li>include/grpcpp/impl/codegen/<a class="el" href="impl_2codegen_2client__callback_8h_source.html">client_callback.h</a></li>
  322. </ul>
  323. </div><!-- contents -->
  324. <!-- start footer part -->
  325. <hr class="footer"/><address class="footer"><small>
  326. Generated on Wed Mar 3 2021 19:17:24 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  327. <img class="footer" src="doxygen.png" alt="doxygen"/>
  328. </a> 1.8.17
  329. </small></address>
  330. </body>
  331. </html>