classgrpc__impl_1_1experimental_1_1_client_callback_writer.html 18 KB

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