classgrpc_1_1_client_async_response_reader.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333
  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::ClientAsyncResponseReader&lt; R &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_async_response_reader.html">ClientAsyncResponseReader</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="#pub-static-methods">Static Public Member Functions</a> &#124;
  70. <a href="#friends">Friends</a> </div>
  71. <div class="headertitle">
  72. <div class="title">grpc::ClientAsyncResponseReader&lt; R &gt; Class Template Reference</div> </div>
  73. </div><!--header-->
  74. <div class="contents">
  75. <p>Async API for client-side unary RPCs, where the message response received from the server is of type <em>R</em>.
  76. <a href="classgrpc_1_1_client_async_response_reader.html#details">More...</a></p>
  77. <p><code>#include &lt;<a class="el" href="grpcpp_2impl_2codegen_2async__unary__call_8h_source.html">async_unary_call.h</a>&gt;</code></p>
  78. <table class="memberdecls">
  79. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  80. Public Member Functions</h2></td></tr>
  81. <tr class="memitem:aa6bb324b380b1389e38f89f7a0b85c64"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_async_response_reader.html#aa6bb324b380b1389e38f89f7a0b85c64">StartCall</a> () override</td></tr>
  82. <tr class="separator:aa6bb324b380b1389e38f89f7a0b85c64"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:ab45261c3dee4f7b34080593cc899b40d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_async_response_reader.html#ab45261c3dee4f7b34080593cc899b40d">ReadInitialMetadata</a> (void *tag) override</td></tr>
  84. <tr class="memdesc:ab45261c3dee4f7b34080593cc899b40d"><td class="mdescLeft">&#160;</td><td class="mdescRight">See <em><a class="el" href="classgrpc_1_1_client_async_response_reader_interface.html#a676e3a03a61c49a82b630d85bbfd366c" title="Request notification of the reading of initial metadata.">ClientAsyncResponseReaderInterface::ReadInitialMetadata</a></em> for semantics. <a href="classgrpc_1_1_client_async_response_reader.html#ab45261c3dee4f7b34080593cc899b40d">More...</a><br /></td></tr>
  85. <tr class="separator:ab45261c3dee4f7b34080593cc899b40d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:ae0805433fe5d3193b5e8c506688e2cff"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_async_response_reader.html#ae0805433fe5d3193b5e8c506688e2cff">Finish</a> (R *msg, ::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> *status, void *tag) override</td></tr>
  87. <tr class="memdesc:ae0805433fe5d3193b5e8c506688e2cff"><td class="mdescLeft">&#160;</td><td class="mdescRight">See <em><a class="el" href="classgrpc_1_1_client_async_response_reader_interface.html#ac5f504f3e6b6c867933c8465414aa1a4" title="Request to receive the server&#39;s response msg and final status for the call, and to notify tag on this...">ClientAsyncResponseReaderInterface::Finish</a></em> for semantics. <a href="classgrpc_1_1_client_async_response_reader.html#ae0805433fe5d3193b5e8c506688e2cff">More...</a><br /></td></tr>
  88. <tr class="separator:ae0805433fe5d3193b5e8c506688e2cff"><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="pub-static-methods"></a>
  91. Static Public Member Functions</h2></td></tr>
  92. <tr class="memitem:a4f3139ae1e3d25d10af4419473412c97"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_async_response_reader.html#a4f3139ae1e3d25d10af4419473412c97">operator delete</a> (void *, std::size_t size)</td></tr>
  93. <tr class="separator:a4f3139ae1e3d25d10af4419473412c97"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:a019c71f3bc7d352b3dab7a2ef18a2751"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_async_response_reader.html#a019c71f3bc7d352b3dab7a2ef18a2751">operator delete</a> (void *, void *)</td></tr>
  95. <tr class="separator:a019c71f3bc7d352b3dab7a2ef18a2751"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. </table><table class="memberdecls">
  97. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  98. Friends</h2></td></tr>
  99. <tr class="memitem:a6c2003b65ac78e330ef93d916055bb68"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_async_response_reader.html#a6c2003b65ac78e330ef93d916055bb68">internal::ClientAsyncResponseReaderHelper</a></td></tr>
  100. <tr class="separator:a6c2003b65ac78e330ef93d916055bb68"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. </table>
  102. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  103. <div class="textblock"><h3>template&lt;class R&gt;<br />
  104. class grpc::ClientAsyncResponseReader&lt; R &gt;</h3>
  105. <p>Async API for client-side unary RPCs, where the message response received from the server is of type <em>R</em>. </p>
  106. </div><h2 class="groupheader">Member Function Documentation</h2>
  107. <a id="ae0805433fe5d3193b5e8c506688e2cff"></a>
  108. <h2 class="memtitle"><span class="permalink"><a href="#ae0805433fe5d3193b5e8c506688e2cff">&#9670;&nbsp;</a></span>Finish()</h2>
  109. <div class="memitem">
  110. <div class="memproto">
  111. <div class="memtemplate">
  112. template&lt;class R &gt; </div>
  113. <table class="mlabels">
  114. <tr>
  115. <td class="mlabels-left">
  116. <table class="memname">
  117. <tr>
  118. <td class="memname">void <a class="el" href="classgrpc_1_1_client_async_response_reader.html">grpc::ClientAsyncResponseReader</a>&lt; R &gt;::Finish </td>
  119. <td>(</td>
  120. <td class="paramtype">R *&#160;</td>
  121. <td class="paramname"><em>msg</em>, </td>
  122. </tr>
  123. <tr>
  124. <td class="paramkey"></td>
  125. <td></td>
  126. <td class="paramtype">::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> *&#160;</td>
  127. <td class="paramname"><em>status</em>, </td>
  128. </tr>
  129. <tr>
  130. <td class="paramkey"></td>
  131. <td></td>
  132. <td class="paramtype">void *&#160;</td>
  133. <td class="paramname"><em>tag</em>&#160;</td>
  134. </tr>
  135. <tr>
  136. <td></td>
  137. <td>)</td>
  138. <td></td><td></td>
  139. </tr>
  140. </table>
  141. </td>
  142. <td class="mlabels-right">
  143. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span></span> </td>
  144. </tr>
  145. </table>
  146. </div><div class="memdoc">
  147. <p>See <em><a class="el" href="classgrpc_1_1_client_async_response_reader_interface.html#ac5f504f3e6b6c867933c8465414aa1a4" title="Request to receive the server&#39;s response msg and final status for the call, and to notify tag on this...">ClientAsyncResponseReaderInterface::Finish</a></em> for semantics. </p>
  148. <p>Side effect:</p><ul>
  149. <li>the <em><a class="el" href="classgrpc_1_1_client_context.html" title="A ClientContext allows the person implementing a service client to:">ClientContext</a></em> associated with this call is updated with possible initial and trailing metadata sent from the server. </li>
  150. </ul>
  151. </div>
  152. </div>
  153. <a id="a4f3139ae1e3d25d10af4419473412c97"></a>
  154. <h2 class="memtitle"><span class="permalink"><a href="#a4f3139ae1e3d25d10af4419473412c97">&#9670;&nbsp;</a></span>operator delete() <span class="overload">[1/2]</span></h2>
  155. <div class="memitem">
  156. <div class="memproto">
  157. <div class="memtemplate">
  158. template&lt;class R &gt; </div>
  159. <table class="mlabels">
  160. <tr>
  161. <td class="mlabels-left">
  162. <table class="memname">
  163. <tr>
  164. <td class="memname">static void <a class="el" href="classgrpc_1_1_client_async_response_reader.html">grpc::ClientAsyncResponseReader</a>&lt; R &gt;::operator delete </td>
  165. <td>(</td>
  166. <td class="paramtype">void *&#160;</td>
  167. <td class="paramname">, </td>
  168. </tr>
  169. <tr>
  170. <td class="paramkey"></td>
  171. <td></td>
  172. <td class="paramtype">std::size_t&#160;</td>
  173. <td class="paramname"><em>size</em>&#160;</td>
  174. </tr>
  175. <tr>
  176. <td></td>
  177. <td>)</td>
  178. <td></td><td></td>
  179. </tr>
  180. </table>
  181. </td>
  182. <td class="mlabels-right">
  183. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  184. </tr>
  185. </table>
  186. </div><div class="memdoc">
  187. </div>
  188. </div>
  189. <a id="a019c71f3bc7d352b3dab7a2ef18a2751"></a>
  190. <h2 class="memtitle"><span class="permalink"><a href="#a019c71f3bc7d352b3dab7a2ef18a2751">&#9670;&nbsp;</a></span>operator delete() <span class="overload">[2/2]</span></h2>
  191. <div class="memitem">
  192. <div class="memproto">
  193. <div class="memtemplate">
  194. template&lt;class R &gt; </div>
  195. <table class="mlabels">
  196. <tr>
  197. <td class="mlabels-left">
  198. <table class="memname">
  199. <tr>
  200. <td class="memname">static void <a class="el" href="classgrpc_1_1_client_async_response_reader.html">grpc::ClientAsyncResponseReader</a>&lt; R &gt;::operator delete </td>
  201. <td>(</td>
  202. <td class="paramtype">void *&#160;</td>
  203. <td class="paramname">, </td>
  204. </tr>
  205. <tr>
  206. <td class="paramkey"></td>
  207. <td></td>
  208. <td class="paramtype">void *&#160;</td>
  209. <td class="paramname">&#160;</td>
  210. </tr>
  211. <tr>
  212. <td></td>
  213. <td>)</td>
  214. <td></td><td></td>
  215. </tr>
  216. </table>
  217. </td>
  218. <td class="mlabels-right">
  219. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
  220. </tr>
  221. </table>
  222. </div><div class="memdoc">
  223. </div>
  224. </div>
  225. <a id="ab45261c3dee4f7b34080593cc899b40d"></a>
  226. <h2 class="memtitle"><span class="permalink"><a href="#ab45261c3dee4f7b34080593cc899b40d">&#9670;&nbsp;</a></span>ReadInitialMetadata()</h2>
  227. <div class="memitem">
  228. <div class="memproto">
  229. <div class="memtemplate">
  230. template&lt;class R &gt; </div>
  231. <table class="mlabels">
  232. <tr>
  233. <td class="mlabels-left">
  234. <table class="memname">
  235. <tr>
  236. <td class="memname">void <a class="el" href="classgrpc_1_1_client_async_response_reader.html">grpc::ClientAsyncResponseReader</a>&lt; R &gt;::ReadInitialMetadata </td>
  237. <td>(</td>
  238. <td class="paramtype">void *&#160;</td>
  239. <td class="paramname"><em>tag</em></td><td>)</td>
  240. <td></td>
  241. </tr>
  242. </table>
  243. </td>
  244. <td class="mlabels-right">
  245. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span></span> </td>
  246. </tr>
  247. </table>
  248. </div><div class="memdoc">
  249. <p>See <em><a class="el" href="classgrpc_1_1_client_async_response_reader_interface.html#a676e3a03a61c49a82b630d85bbfd366c" title="Request notification of the reading of initial metadata.">ClientAsyncResponseReaderInterface::ReadInitialMetadata</a></em> for semantics. </p>
  250. <p>Side effect:</p><ul>
  251. <li>the <em><a class="el" href="classgrpc_1_1_client_context.html" title="A ClientContext allows the person implementing a service client to:">ClientContext</a></em> associated with this call is updated with possible initial and trailing metadata sent from the server. </li>
  252. </ul>
  253. </div>
  254. </div>
  255. <a id="aa6bb324b380b1389e38f89f7a0b85c64"></a>
  256. <h2 class="memtitle"><span class="permalink"><a href="#aa6bb324b380b1389e38f89f7a0b85c64">&#9670;&nbsp;</a></span>StartCall()</h2>
  257. <div class="memitem">
  258. <div class="memproto">
  259. <div class="memtemplate">
  260. template&lt;class R &gt; </div>
  261. <table class="mlabels">
  262. <tr>
  263. <td class="mlabels-left">
  264. <table class="memname">
  265. <tr>
  266. <td class="memname">void <a class="el" href="classgrpc_1_1_client_async_response_reader.html">grpc::ClientAsyncResponseReader</a>&lt; R &gt;::StartCall </td>
  267. <td>(</td>
  268. <td class="paramname"></td><td>)</td>
  269. <td></td>
  270. </tr>
  271. </table>
  272. </td>
  273. <td class="mlabels-right">
  274. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span></span> </td>
  275. </tr>
  276. </table>
  277. </div><div class="memdoc">
  278. </div>
  279. </div>
  280. <h2 class="groupheader">Friends And Related Function Documentation</h2>
  281. <a id="a6c2003b65ac78e330ef93d916055bb68"></a>
  282. <h2 class="memtitle"><span class="permalink"><a href="#a6c2003b65ac78e330ef93d916055bb68">&#9670;&nbsp;</a></span>internal::ClientAsyncResponseReaderHelper</h2>
  283. <div class="memitem">
  284. <div class="memproto">
  285. <div class="memtemplate">
  286. template&lt;class R &gt; </div>
  287. <table class="mlabels">
  288. <tr>
  289. <td class="mlabels-left">
  290. <table class="memname">
  291. <tr>
  292. <td class="memname">friend class <a class="el" href="classgrpc_1_1internal_1_1_client_async_response_reader_helper.html">internal::ClientAsyncResponseReaderHelper</a></td>
  293. </tr>
  294. </table>
  295. </td>
  296. <td class="mlabels-right">
  297. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  298. </tr>
  299. </table>
  300. </div><div class="memdoc">
  301. </div>
  302. </div>
  303. <hr/>The documentation for this class was generated from the following file:<ul>
  304. <li>include/grpcpp/impl/codegen/<a class="el" href="grpcpp_2impl_2codegen_2async__unary__call_8h_source.html">async_unary_call.h</a></li>
  305. </ul>
  306. </div><!-- contents -->
  307. <!-- start footer part -->
  308. <hr class="footer"/><address class="footer"><small>
  309. Generated on Wed Mar 3 2021 19:17:24 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  310. <img class="footer" src="doxygen.png" alt="doxygen"/>
  311. </a> 1.8.17
  312. </small></address>
  313. </body>
  314. </html>