classgrpc_1_1experimental_1_1_client_callback_reader_writer.html 17 KB

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