classgrpc_1_1internal_1_1_client_reactor.html 8.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165
  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::internal::ClientReactor Class 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="namespacegrpc_1_1internal.html">internal</a></li><li class="navelem"><a class="el" href="classgrpc_1_1internal_1_1_client_reactor.html">ClientReactor</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> </div>
  69. <div class="headertitle">
  70. <div class="title">grpc::internal::ClientReactor Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
  71. </div><!--header-->
  72. <div class="contents">
  73. <p><code>#include &lt;<a class="el" href="impl_2codegen_2client__callback_8h_source.html">client_callback.h</a>&gt;</code></p>
  74. <table class="memberdecls">
  75. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  76. Public Member Functions</h2></td></tr>
  77. <tr class="memitem:a5424de48788072f0752996d8729c0968"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_client_reactor.html#a5424de48788072f0752996d8729c0968">OnDone</a> (const ::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> &amp;)=0</td></tr>
  78. <tr class="memdesc:a5424de48788072f0752996d8729c0968"><td class="mdescLeft">&#160;</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_1internal_1_1_client_reactor.html#a5424de48788072f0752996d8729c0968">More...</a><br /></td></tr>
  79. <tr class="separator:a5424de48788072f0752996d8729c0968"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:a5792110850aea7d7a6694a9e81dc0894"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</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>
  81. <tr class="memdesc:a5792110850aea7d7a6694a9e81dc0894"><td class="mdescLeft">&#160;</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>
  82. <tr class="separator:a5792110850aea7d7a6694a9e81dc0894"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. </table>
  84. <h2 class="groupheader">Member Function Documentation</h2>
  85. <a id="a5792110850aea7d7a6694a9e81dc0894"></a>
  86. <h2 class="memtitle"><span class="permalink"><a href="#a5792110850aea7d7a6694a9e81dc0894">&#9670;&nbsp;</a></span>InternalScheduleOnDone()</h2>
  87. <div class="memitem">
  88. <div class="memproto">
  89. <table class="mlabels">
  90. <tr>
  91. <td class="mlabels-left">
  92. <table class="memname">
  93. <tr>
  94. <td class="memname">virtual void grpc::internal::ClientReactor::InternalScheduleOnDone </td>
  95. <td>(</td>
  96. <td class="paramtype">::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a>&#160;</td>
  97. <td class="paramname"><em>s</em></td><td>)</td>
  98. <td></td>
  99. </tr>
  100. </table>
  101. </td>
  102. <td class="mlabels-right">
  103. <span class="mlabels"><span class="mlabel">virtual</span></span> </td>
  104. </tr>
  105. </table>
  106. </div><div class="memdoc">
  107. <p>InternalScheduleOnDone is not part of the API and is not meant to be overridden. </p>
  108. <p>It is virtual to allow successful builds for certain bazel build users that only want to depend on gRPC codegen headers and not the full library (although this is not a generally-supported option). Although the virtual call is slower than a direct call, this function is heavyweight and the cost of the virtual call is not much in comparison. This function may be removed or devirtualized in the future. </p>
  109. </div>
  110. </div>
  111. <a id="a5424de48788072f0752996d8729c0968"></a>
  112. <h2 class="memtitle"><span class="permalink"><a href="#a5424de48788072f0752996d8729c0968">&#9670;&nbsp;</a></span>OnDone()</h2>
  113. <div class="memitem">
  114. <div class="memproto">
  115. <table class="mlabels">
  116. <tr>
  117. <td class="mlabels-left">
  118. <table class="memname">
  119. <tr>
  120. <td class="memname">virtual void grpc::internal::ClientReactor::OnDone </td>
  121. <td>(</td>
  122. <td class="paramtype">const ::<a class="el" href="classgrpc_1_1_status.html">grpc::Status</a> &amp;&#160;</td>
  123. <td class="paramname"></td><td>)</td>
  124. <td></td>
  125. </tr>
  126. </table>
  127. </td>
  128. <td class="mlabels-right">
  129. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  130. </tr>
  131. </table>
  132. </div><div class="memdoc">
  133. <p>Called by the library when all operations associated with this RPC have completed and all Holds have been removed. </p>
  134. <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>
  135. <dl class="params"><dt>Parameters</dt><dd>
  136. <table class="params">
  137. <tr><td class="paramdir">[in]</td><td class="paramname">s</td><td>The status outcome of this RPC </td></tr>
  138. </table>
  139. </dd>
  140. </dl>
  141. <p>Implemented in <a class="el" href="classgrpc_1_1_client_unary_reactor.html#ae60b5e629dacfec84a481deda1fc5665">grpc::ClientUnaryReactor</a>.</p>
  142. </div>
  143. </div>
  144. <hr/>The documentation for this class was generated from the following file:<ul>
  145. <li>include/grpcpp/impl/codegen/<a class="el" href="impl_2codegen_2client__callback_8h_source.html">client_callback.h</a></li>
  146. </ul>
  147. </div><!-- contents -->
  148. <!-- start footer part -->
  149. <hr class="footer"/><address class="footer"><small>
  150. Generated on Wed Mar 3 2021 19:17:26 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  151. <img class="footer" src="doxygen.png" alt="doxygen"/>
  152. </a> 1.8.17
  153. </small></address>
  154. </body>
  155. </html>