123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255 |
- <!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::ClientUnaryReactor Class 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_unary_reactor.html">ClientUnaryReactor</a></li> </ul>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="#friends">Friends</a> </div>
- <div class="headertitle">
- <div class="title">grpc::ClientUnaryReactor Class Reference</div> </div>
- </div><!--header-->
- <div class="contents">
- <p><em><a class="el" href="classgrpc_1_1_client_unary_reactor.html" title="ClientUnaryReactor is a reactor-style interface for a unary RPC.">ClientUnaryReactor</a></em> is a reactor-style interface for a unary RPC.
- <a href="classgrpc_1_1_client_unary_reactor.html#details">More...</a></p>
- <p><code>#include <<a class="el" href="impl_2codegen_2client__callback_8h_source.html">client_callback.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:a6fd4895bca596cd6f631f4fa66acefb7"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_unary_reactor.html#a6fd4895bca596cd6f631f4fa66acefb7">~ClientUnaryReactor</a> ()</td></tr>
- <tr class="separator:a6fd4895bca596cd6f631f4fa66acefb7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a13d27ebc1a0949588cca00da6a394f62"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_unary_reactor.html#a13d27ebc1a0949588cca00da6a394f62">StartCall</a> ()</td></tr>
- <tr class="separator:a13d27ebc1a0949588cca00da6a394f62"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae60b5e629dacfec84a481deda1fc5665"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_unary_reactor.html#ae60b5e629dacfec84a481deda1fc5665">OnDone</a> (const ::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> &) override</td></tr>
- <tr class="memdesc:ae60b5e629dacfec84a481deda1fc5665"><td class="mdescLeft"> </td><td class="mdescRight">Called by the library when all operations associated with this RPC have completed and all Holds have been removed. <a href="classgrpc_1_1_client_unary_reactor.html#ae60b5e629dacfec84a481deda1fc5665">More...</a><br /></td></tr>
- <tr class="separator:ae60b5e629dacfec84a481deda1fc5665"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a99cdcbd44c07bc416d58e62e776e8206"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_unary_reactor.html#a99cdcbd44c07bc416d58e62e776e8206">OnReadInitialMetadataDone</a> (bool)</td></tr>
- <tr class="separator:a99cdcbd44c07bc416d58e62e776e8206"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_methods_classgrpc_1_1internal_1_1_client_reactor"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1internal_1_1_client_reactor')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="classgrpc_1_1internal_1_1_client_reactor.html">grpc::internal::ClientReactor</a></td></tr>
- <tr class="memitem:a5792110850aea7d7a6694a9e81dc0894 inherit pub_methods_classgrpc_1_1internal_1_1_client_reactor"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_client_reactor.html#a5792110850aea7d7a6694a9e81dc0894">InternalScheduleOnDone</a> (::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> s)</td></tr>
- <tr class="memdesc:a5792110850aea7d7a6694a9e81dc0894 inherit pub_methods_classgrpc_1_1internal_1_1_client_reactor"><td class="mdescLeft"> </td><td class="mdescRight">InternalScheduleOnDone is not part of the API and is not meant to be overridden. <a href="classgrpc_1_1internal_1_1_client_reactor.html#a5792110850aea7d7a6694a9e81dc0894">More...</a><br /></td></tr>
- <tr class="separator:a5792110850aea7d7a6694a9e81dc0894 inherit pub_methods_classgrpc_1_1internal_1_1_client_reactor"><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:a17f5a31869ecd91f7378b86c16c9af21"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_client_unary_reactor.html#a17f5a31869ecd91f7378b86c16c9af21">ClientCallbackUnary</a></td></tr>
- <tr class="separator:a17f5a31869ecd91f7378b86c16c9af21"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p><em><a class="el" href="classgrpc_1_1_client_unary_reactor.html" title="ClientUnaryReactor is a reactor-style interface for a unary RPC.">ClientUnaryReactor</a></em> is a reactor-style interface for a unary RPC. </p>
- <p>This is <em>not</em> a common way of invoking a unary RPC. In practice, this option should be used only if the unary RPC wants to receive initial metadata without waiting for the response to complete. Most deployments of RPC systems do not use this option, but it is needed for generality. All public methods behave as in <a class="el" href="classgrpc_1_1_client_bidi_reactor.html" title="ClientBidiReactor is the interface for a bidirectional streaming RPC.">ClientBidiReactor</a>. StartCall is included for consistency with the other reactor flavors: even though there are no StartRead or StartWrite operations to queue before the call (that is part of the unary call itself) and there is no reactor object being created as a result of this call, we keep a consistent 2-phase initiation API among all the reactor flavors. </p>
- </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
- <a id="a6fd4895bca596cd6f631f4fa66acefb7"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a6fd4895bca596cd6f631f4fa66acefb7">◆ </a></span>~ClientUnaryReactor()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual grpc::ClientUnaryReactor::~ClientUnaryReactor </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">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a id="ae60b5e629dacfec84a481deda1fc5665"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ae60b5e629dacfec84a481deda1fc5665">◆ </a></span>OnDone()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ClientUnaryReactor::OnDone </td>
- <td>(</td>
- <td class="paramtype">const ::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> & </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 class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Called by the library when all operations associated with this RPC have completed and all Holds have been removed. </p>
- <p>OnDone provides the RPC status outcome for both successful and failed RPCs. If it is never called on an RPC, it indicates an application-level problem (like failure to remove a hold).</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">s</td><td>The status outcome of this RPC </td></tr>
- </table>
- </dd>
- </dl>
- <p>Implements <a class="el" href="classgrpc_1_1internal_1_1_client_reactor.html#a5424de48788072f0752996d8729c0968">grpc::internal::ClientReactor</a>.</p>
- </div>
- </div>
- <a id="a99cdcbd44c07bc416d58e62e776e8206"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a99cdcbd44c07bc416d58e62e776e8206">◆ </a></span>OnReadInitialMetadataDone()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual void grpc::ClientUnaryReactor::OnReadInitialMetadataDone </td>
- <td>(</td>
- <td class="paramtype">bool </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">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a13d27ebc1a0949588cca00da6a394f62"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a13d27ebc1a0949588cca00da6a394f62">◆ </a></span>StartCall()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ClientUnaryReactor::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> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <h2 class="groupheader">Friends And Related Function Documentation</h2>
- <a id="a17f5a31869ecd91f7378b86c16c9af21"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a17f5a31869ecd91f7378b86c16c9af21">◆ </a></span>ClientCallbackUnary</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class <a class="el" href="classgrpc_1_1_client_callback_unary.html">ClientCallbackUnary</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="impl_2codegen_2client__callback_8h_source.html">client_callback.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>
|