123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=9"/>
- <meta name="generator" content="Doxygen 1.8.17"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>GRPC C++: grpc::ClientAsyncResponseReader< R > Class Template Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="search/searchdata.js"></script>
- <script type="text/javascript" src="search/search.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
- <td id="projectalign" style="padding-left: 0.5em;">
- <div id="projectname">GRPC C++
-  <span id="projectnumber">1.36.1</span>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.17 -->
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
- var searchBox = new SearchBox("searchBox", "search",false,'Search');
- /* @license-end */
- </script>
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
- $(function() {
- initMenu('',true,false,'search.php','Search');
- $(document).ready(function() { init_search(); });
- });
- /* @license-end */</script>
- <div id="main-nav"></div>
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- </div>
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <iframe src="javascript:void(0)" frameborder="0"
- name="MSearchResults" id="MSearchResults">
- </iframe>
- </div>
- <div id="nav-path" class="navpath">
- <ul>
- <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>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="#pub-static-methods">Static Public Member Functions</a> |
- <a href="#friends">Friends</a> </div>
- <div class="headertitle">
- <div class="title">grpc::ClientAsyncResponseReader< R > Class Template Reference</div> </div>
- </div><!--header-->
- <div class="contents">
- <p>Async API for client-side unary RPCs, where the message response received from the server is of type <em>R</em>.
- <a href="classgrpc_1_1_client_async_response_reader.html#details">More...</a></p>
- <p><code>#include <<a class="el" href="grpcpp_2impl_2codegen_2async__unary__call_8h_source.html">async_unary_call.h</a>></code></p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:aa6bb324b380b1389e38f89f7a0b85c64"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_async_response_reader.html#aa6bb324b380b1389e38f89f7a0b85c64">StartCall</a> () override</td></tr>
- <tr class="separator:aa6bb324b380b1389e38f89f7a0b85c64"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab45261c3dee4f7b34080593cc899b40d"><td class="memItemLeft" align="right" valign="top">void </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>
- <tr class="memdesc:ab45261c3dee4f7b34080593cc899b40d"><td class="mdescLeft"> </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>
- <tr class="separator:ab45261c3dee4f7b34080593cc899b40d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae0805433fe5d3193b5e8c506688e2cff"><td class="memItemLeft" align="right" valign="top">void </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>
- <tr class="memdesc:ae0805433fe5d3193b5e8c506688e2cff"><td class="mdescLeft"> </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'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>
- <tr class="separator:ae0805433fe5d3193b5e8c506688e2cff"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
- Static Public Member Functions</h2></td></tr>
- <tr class="memitem:a4f3139ae1e3d25d10af4419473412c97"><td class="memItemLeft" align="right" valign="top">static void </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>
- <tr class="separator:a4f3139ae1e3d25d10af4419473412c97"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a019c71f3bc7d352b3dab7a2ef18a2751"><td class="memItemLeft" align="right" valign="top">static void </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>
- <tr class="separator:a019c71f3bc7d352b3dab7a2ef18a2751"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
- Friends</h2></td></tr>
- <tr class="memitem:a6c2003b65ac78e330ef93d916055bb68"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_async_response_reader.html#a6c2003b65ac78e330ef93d916055bb68">internal::ClientAsyncResponseReaderHelper</a></td></tr>
- <tr class="separator:a6c2003b65ac78e330ef93d916055bb68"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><h3>template<class R><br />
- class grpc::ClientAsyncResponseReader< R ></h3>
- <p>Async API for client-side unary RPCs, where the message response received from the server is of type <em>R</em>. </p>
- </div><h2 class="groupheader">Member Function Documentation</h2>
- <a id="ae0805433fe5d3193b5e8c506688e2cff"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ae0805433fe5d3193b5e8c506688e2cff">◆ </a></span>Finish()</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class R > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void <a class="el" href="classgrpc_1_1_client_async_response_reader.html">grpc::ClientAsyncResponseReader</a>< R >::Finish </td>
- <td>(</td>
- <td class="paramtype">R * </td>
- <td class="paramname"><em>msg</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> * </td>
- <td class="paramname"><em>status</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">void * </td>
- <td class="paramname"><em>tag</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>See <em><a class="el" href="classgrpc_1_1_client_async_response_reader_interface.html#ac5f504f3e6b6c867933c8465414aa1a4" title="Request to receive the server's response msg and final status for the call, and to notify tag on this...">ClientAsyncResponseReaderInterface::Finish</a></em> for semantics. </p>
- <p>Side effect:</p><ul>
- <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>
- </ul>
- </div>
- </div>
- <a id="a4f3139ae1e3d25d10af4419473412c97"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a4f3139ae1e3d25d10af4419473412c97">◆ </a></span>operator delete() <span class="overload">[1/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class R > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static void <a class="el" href="classgrpc_1_1_client_async_response_reader.html">grpc::ClientAsyncResponseReader</a>< R >::operator delete </td>
- <td>(</td>
- <td class="paramtype">void * </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">std::size_t </td>
- <td class="paramname"><em>size</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a019c71f3bc7d352b3dab7a2ef18a2751"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a019c71f3bc7d352b3dab7a2ef18a2751">◆ </a></span>operator delete() <span class="overload">[2/2]</span></h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class R > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static void <a class="el" href="classgrpc_1_1_client_async_response_reader.html">grpc::ClientAsyncResponseReader</a>< R >::operator delete </td>
- <td>(</td>
- <td class="paramtype">void * </td>
- <td class="paramname">, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">void * </td>
- <td class="paramname"> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="ab45261c3dee4f7b34080593cc899b40d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ab45261c3dee4f7b34080593cc899b40d">◆ </a></span>ReadInitialMetadata()</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class R > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void <a class="el" href="classgrpc_1_1_client_async_response_reader.html">grpc::ClientAsyncResponseReader</a>< R >::ReadInitialMetadata </td>
- <td>(</td>
- <td class="paramtype">void * </td>
- <td class="paramname"><em>tag</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- <p>Side effect:</p><ul>
- <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>
- </ul>
- </div>
- </div>
- <a id="aa6bb324b380b1389e38f89f7a0b85c64"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aa6bb324b380b1389e38f89f7a0b85c64">◆ </a></span>StartCall()</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class R > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void <a class="el" href="classgrpc_1_1_client_async_response_reader.html">grpc::ClientAsyncResponseReader</a>< R >::StartCall </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <h2 class="groupheader">Friends And Related Function Documentation</h2>
- <a id="a6c2003b65ac78e330ef93d916055bb68"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a6c2003b65ac78e330ef93d916055bb68">◆ </a></span>internal::ClientAsyncResponseReaderHelper</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class R > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class <a class="el" href="classgrpc_1_1internal_1_1_client_async_response_reader_helper.html">internal::ClientAsyncResponseReaderHelper</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following file:<ul>
- <li>include/grpcpp/impl/codegen/<a class="el" href="grpcpp_2impl_2codegen_2async__unary__call_8h_source.html">async_unary_call.h</a></li>
- </ul>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated on Wed Mar 3 2021 19:17:24 for GRPC C++ by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.17
- </small></address>
- </body>
- </html>
|