classgrpc_1_1_client_callback_writer.html 18 KB

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