classgrpc_1_1_channel_interface.html 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718
  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::ChannelInterface 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="classgrpc_1_1_channel_interface.html">ChannelInterface</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="#friends">Friends</a> </div>
  70. <div class="headertitle">
  71. <div class="title">grpc::ChannelInterface Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
  72. </div><!--header-->
  73. <div class="contents">
  74. <p>Codegen interface for <em><a class="el" href="classgrpc_1_1_channel.html" title="Channels represent a connection to an endpoint. Created by CreateChannel.">grpc::Channel</a></em>.
  75. <a href="classgrpc_1_1_channel_interface.html#details">More...</a></p>
  76. <p><code>#include &lt;<a class="el" href="grpcpp_2impl_2codegen_2channel__interface_8h_source.html">channel_interface.h</a>&gt;</code></p>
  77. <table class="memberdecls">
  78. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  79. Public Member Functions</h2></td></tr>
  80. <tr class="memitem:a3f5145d4778aa952540dc9983cefe13f"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#a3f5145d4778aa952540dc9983cefe13f">~ChannelInterface</a> ()</td></tr>
  81. <tr class="separator:a3f5145d4778aa952540dc9983cefe13f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:a68e987e7b87ca5a2668419736f9ee9b1"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="connectivity__state_8h.html#a065b65f5cdd062a67d82e2b6bcf68cf2">grpc_connectivity_state</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#a68e987e7b87ca5a2668419736f9ee9b1">GetState</a> (bool try_to_connect)=0</td></tr>
  83. <tr class="memdesc:a68e987e7b87ca5a2668419736f9ee9b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current channel state. <a href="classgrpc_1_1_channel_interface.html#a68e987e7b87ca5a2668419736f9ee9b1">More...</a><br /></td></tr>
  84. <tr class="separator:a68e987e7b87ca5a2668419736f9ee9b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:ad2ffa0dffc84f1fe38084c0993c4ca50"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  86. <tr class="memitem:ad2ffa0dffc84f1fe38084c0993c4ca50"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#ad2ffa0dffc84f1fe38084c0993c4ca50">NotifyOnStateChange</a> (<a class="el" href="connectivity__state_8h.html#a065b65f5cdd062a67d82e2b6bcf68cf2">grpc_connectivity_state</a> last_observed, T deadline, ::<a class="el" href="classgrpc_1_1_completion_queue.html">grpc::CompletionQueue</a> *cq, void *tag)</td></tr>
  87. <tr class="memdesc:ad2ffa0dffc84f1fe38084c0993c4ca50"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the <em>tag</em> on <em>cq</em> when the channel state is changed or <em>deadline</em> expires. <a href="classgrpc_1_1_channel_interface.html#ad2ffa0dffc84f1fe38084c0993c4ca50">More...</a><br /></td></tr>
  88. <tr class="separator:ad2ffa0dffc84f1fe38084c0993c4ca50"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:a70567e7ea3d1a967ecf5ecdc220ac27e"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  90. <tr class="memitem:a70567e7ea3d1a967ecf5ecdc220ac27e"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#a70567e7ea3d1a967ecf5ecdc220ac27e">WaitForStateChange</a> (<a class="el" href="connectivity__state_8h.html#a065b65f5cdd062a67d82e2b6bcf68cf2">grpc_connectivity_state</a> last_observed, T deadline)</td></tr>
  91. <tr class="memdesc:a70567e7ea3d1a967ecf5ecdc220ac27e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Blocking wait for channel state change or <em>deadline</em> expiration. <a href="classgrpc_1_1_channel_interface.html#a70567e7ea3d1a967ecf5ecdc220ac27e">More...</a><br /></td></tr>
  92. <tr class="separator:a70567e7ea3d1a967ecf5ecdc220ac27e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:a31d360cd218614814d68e01e07ce55cc"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  94. <tr class="memitem:a31d360cd218614814d68e01e07ce55cc"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#a31d360cd218614814d68e01e07ce55cc">WaitForConnected</a> (T deadline)</td></tr>
  95. <tr class="memdesc:a31d360cd218614814d68e01e07ce55cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait for this channel to be connected. <a href="classgrpc_1_1_channel_interface.html#a31d360cd218614814d68e01e07ce55cc">More...</a><br /></td></tr>
  96. <tr class="separator:a31d360cd218614814d68e01e07ce55cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. </table><table class="memberdecls">
  98. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  99. Friends</h2></td></tr>
  100. <tr class="memitem:ade499098cc91745c1c87147d7a7fb7bf"><td class="memTemplParams" colspan="2">template&lt;class R &gt; </td></tr>
  101. <tr class="memitem:ade499098cc91745c1c87147d7a7fb7bf"><td class="memTemplItemLeft" align="right" valign="top">class&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#ade499098cc91745c1c87147d7a7fb7bf">::grpc::ClientReader</a></td></tr>
  102. <tr class="separator:ade499098cc91745c1c87147d7a7fb7bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:a4498fada67d531d99a8642f47d746544"><td class="memTemplParams" colspan="2">template&lt;class W &gt; </td></tr>
  104. <tr class="memitem:a4498fada67d531d99a8642f47d746544"><td class="memTemplItemLeft" align="right" valign="top">class&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#a4498fada67d531d99a8642f47d746544">::grpc::ClientWriter</a></td></tr>
  105. <tr class="separator:a4498fada67d531d99a8642f47d746544"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a6d5659aa24edba057895be774e2752ec"><td class="memTemplParams" colspan="2">template&lt;class W , class R &gt; </td></tr>
  107. <tr class="memitem:a6d5659aa24edba057895be774e2752ec"><td class="memTemplItemLeft" align="right" valign="top">class&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#a6d5659aa24edba057895be774e2752ec">::grpc::ClientReaderWriter</a></td></tr>
  108. <tr class="separator:a6d5659aa24edba057895be774e2752ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:a2175726e9cbee09a493f40e1c3b5b088"><td class="memTemplParams" colspan="2">template&lt;class R &gt; </td></tr>
  110. <tr class="memitem:a2175726e9cbee09a493f40e1c3b5b088"><td class="memTemplItemLeft" align="right" valign="top">class&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#a2175726e9cbee09a493f40e1c3b5b088">::grpc::internal::ClientAsyncReaderFactory</a></td></tr>
  111. <tr class="separator:a2175726e9cbee09a493f40e1c3b5b088"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:aa160cb54356482ee5c40511fe76b4c9d"><td class="memTemplParams" colspan="2">template&lt;class W &gt; </td></tr>
  113. <tr class="memitem:aa160cb54356482ee5c40511fe76b4c9d"><td class="memTemplItemLeft" align="right" valign="top">class&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#aa160cb54356482ee5c40511fe76b4c9d">::grpc::internal::ClientAsyncWriterFactory</a></td></tr>
  114. <tr class="separator:aa160cb54356482ee5c40511fe76b4c9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:a7c87e7adb535c485a4bc8e7215fab4a4"><td class="memTemplParams" colspan="2">template&lt;class W , class R &gt; </td></tr>
  116. <tr class="memitem:a7c87e7adb535c485a4bc8e7215fab4a4"><td class="memTemplItemLeft" align="right" valign="top">class&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#a7c87e7adb535c485a4bc8e7215fab4a4">::grpc::internal::ClientAsyncReaderWriterFactory</a></td></tr>
  117. <tr class="separator:a7c87e7adb535c485a4bc8e7215fab4a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:a1276dd3b0504721eced67f15c36ac888"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#a1276dd3b0504721eced67f15c36ac888">::grpc::internal::ClientAsyncResponseReaderHelper</a></td></tr>
  119. <tr class="separator:a1276dd3b0504721eced67f15c36ac888"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:a12a368febde8b86808b24295c04c7b34"><td class="memTemplParams" colspan="2">template&lt;class W , class R &gt; </td></tr>
  121. <tr class="memitem:a12a368febde8b86808b24295c04c7b34"><td class="memTemplItemLeft" align="right" valign="top">class&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#a12a368febde8b86808b24295c04c7b34">::grpc::internal::ClientCallbackReaderWriterFactory</a></td></tr>
  122. <tr class="separator:a12a368febde8b86808b24295c04c7b34"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:aac76a68caa02d284d9352eb3b8ed04fe"><td class="memTemplParams" colspan="2">template&lt;class R &gt; </td></tr>
  124. <tr class="memitem:aac76a68caa02d284d9352eb3b8ed04fe"><td class="memTemplItemLeft" align="right" valign="top">class&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#aac76a68caa02d284d9352eb3b8ed04fe">::grpc::internal::ClientCallbackReaderFactory</a></td></tr>
  125. <tr class="separator:aac76a68caa02d284d9352eb3b8ed04fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:abe439612681a46aabf8cb5c1c8f0a170"><td class="memTemplParams" colspan="2">template&lt;class W &gt; </td></tr>
  127. <tr class="memitem:abe439612681a46aabf8cb5c1c8f0a170"><td class="memTemplItemLeft" align="right" valign="top">class&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#abe439612681a46aabf8cb5c1c8f0a170">::grpc::internal::ClientCallbackWriterFactory</a></td></tr>
  128. <tr class="separator:abe439612681a46aabf8cb5c1c8f0a170"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:aee23b219653dea5f3fef55176aca3509"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#aee23b219653dea5f3fef55176aca3509">::grpc::internal::ClientCallbackUnaryFactory</a></td></tr>
  130. <tr class="separator:aee23b219653dea5f3fef55176aca3509"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:ad26a823fee699f97244d581f400fe39a"><td class="memTemplParams" colspan="2">template&lt;class InputMessage , class OutputMessage &gt; </td></tr>
  132. <tr class="memitem:ad26a823fee699f97244d581f400fe39a"><td class="memTemplItemLeft" align="right" valign="top">class&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#ad26a823fee699f97244d581f400fe39a">::grpc::internal::BlockingUnaryCallImpl</a></td></tr>
  133. <tr class="separator:ad26a823fee699f97244d581f400fe39a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:a039f3a4023eccbecbb5c9925722e9ef7"><td class="memTemplParams" colspan="2">template&lt;class InputMessage , class OutputMessage &gt; </td></tr>
  135. <tr class="memitem:a039f3a4023eccbecbb5c9925722e9ef7"><td class="memTemplItemLeft" align="right" valign="top">class&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#a039f3a4023eccbecbb5c9925722e9ef7">::grpc::internal::CallbackUnaryCallImpl</a></td></tr>
  136. <tr class="separator:a039f3a4023eccbecbb5c9925722e9ef7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:afdfab4a69fd00ee5bffe02b9fd2718a2"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#afdfab4a69fd00ee5bffe02b9fd2718a2">::grpc::internal::RpcMethod</a></td></tr>
  138. <tr class="separator:afdfab4a69fd00ee5bffe02b9fd2718a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:ac8c9786b36d074059b306ff1d1d90453"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#ac8c9786b36d074059b306ff1d1d90453">::grpc::experimental::DelegatingChannel</a></td></tr>
  140. <tr class="separator:ac8c9786b36d074059b306ff1d1d90453"><td class="memSeparator" colspan="2">&#160;</td></tr>
  141. <tr class="memitem:a9a23a8cfcee9fd9658ecd8bb1a3193ac"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#a9a23a8cfcee9fd9658ecd8bb1a3193ac">::grpc::internal::InterceptedChannel</a></td></tr>
  142. <tr class="separator:a9a23a8cfcee9fd9658ecd8bb1a3193ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. </table>
  144. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  145. <div class="textblock"><p>Codegen interface for <em><a class="el" href="classgrpc_1_1_channel.html" title="Channels represent a connection to an endpoint. Created by CreateChannel.">grpc::Channel</a></em>. </p>
  146. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  147. <a id="a3f5145d4778aa952540dc9983cefe13f"></a>
  148. <h2 class="memtitle"><span class="permalink"><a href="#a3f5145d4778aa952540dc9983cefe13f">&#9670;&nbsp;</a></span>~ChannelInterface()</h2>
  149. <div class="memitem">
  150. <div class="memproto">
  151. <table class="mlabels">
  152. <tr>
  153. <td class="mlabels-left">
  154. <table class="memname">
  155. <tr>
  156. <td class="memname">virtual grpc::ChannelInterface::~ChannelInterface </td>
  157. <td>(</td>
  158. <td class="paramname"></td><td>)</td>
  159. <td></td>
  160. </tr>
  161. </table>
  162. </td>
  163. <td class="mlabels-right">
  164. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  165. </tr>
  166. </table>
  167. </div><div class="memdoc">
  168. </div>
  169. </div>
  170. <h2 class="groupheader">Member Function Documentation</h2>
  171. <a id="a68e987e7b87ca5a2668419736f9ee9b1"></a>
  172. <h2 class="memtitle"><span class="permalink"><a href="#a68e987e7b87ca5a2668419736f9ee9b1">&#9670;&nbsp;</a></span>GetState()</h2>
  173. <div class="memitem">
  174. <div class="memproto">
  175. <table class="mlabels">
  176. <tr>
  177. <td class="mlabels-left">
  178. <table class="memname">
  179. <tr>
  180. <td class="memname">virtual <a class="el" href="connectivity__state_8h.html#a065b65f5cdd062a67d82e2b6bcf68cf2">grpc_connectivity_state</a> grpc::ChannelInterface::GetState </td>
  181. <td>(</td>
  182. <td class="paramtype">bool&#160;</td>
  183. <td class="paramname"><em>try_to_connect</em></td><td>)</td>
  184. <td></td>
  185. </tr>
  186. </table>
  187. </td>
  188. <td class="mlabels-right">
  189. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  190. </tr>
  191. </table>
  192. </div><div class="memdoc">
  193. <p>Get the current channel state. </p>
  194. <p>If the channel is in IDLE and <em>try_to_connect</em> is set to true, try to connect. </p>
  195. <p>Implemented in <a class="el" href="classgrpc_1_1_channel.html#a646d7a9d01f22037a72092d3a0bf159c">grpc::Channel</a>, <a class="el" href="classgrpc_1_1internal_1_1_intercepted_channel.html#ab7073fa3f0de1369f7201c1ce1630970">grpc::internal::InterceptedChannel</a>, and <a class="el" href="classgrpc_1_1experimental_1_1_delegating_channel.html#ade542e52407601f790dba8ebf4aaa6e3">grpc::experimental::DelegatingChannel</a>.</p>
  196. </div>
  197. </div>
  198. <a id="ad2ffa0dffc84f1fe38084c0993c4ca50"></a>
  199. <h2 class="memtitle"><span class="permalink"><a href="#ad2ffa0dffc84f1fe38084c0993c4ca50">&#9670;&nbsp;</a></span>NotifyOnStateChange()</h2>
  200. <div class="memitem">
  201. <div class="memproto">
  202. <div class="memtemplate">
  203. template&lt;typename T &gt; </div>
  204. <table class="mlabels">
  205. <tr>
  206. <td class="mlabels-left">
  207. <table class="memname">
  208. <tr>
  209. <td class="memname">void grpc::ChannelInterface::NotifyOnStateChange </td>
  210. <td>(</td>
  211. <td class="paramtype"><a class="el" href="connectivity__state_8h.html#a065b65f5cdd062a67d82e2b6bcf68cf2">grpc_connectivity_state</a>&#160;</td>
  212. <td class="paramname"><em>last_observed</em>, </td>
  213. </tr>
  214. <tr>
  215. <td class="paramkey"></td>
  216. <td></td>
  217. <td class="paramtype">T&#160;</td>
  218. <td class="paramname"><em>deadline</em>, </td>
  219. </tr>
  220. <tr>
  221. <td class="paramkey"></td>
  222. <td></td>
  223. <td class="paramtype">::<a class="el" href="classgrpc_1_1_completion_queue.html">grpc::CompletionQueue</a> *&#160;</td>
  224. <td class="paramname"><em>cq</em>, </td>
  225. </tr>
  226. <tr>
  227. <td class="paramkey"></td>
  228. <td></td>
  229. <td class="paramtype">void *&#160;</td>
  230. <td class="paramname"><em>tag</em>&#160;</td>
  231. </tr>
  232. <tr>
  233. <td></td>
  234. <td>)</td>
  235. <td></td><td></td>
  236. </tr>
  237. </table>
  238. </td>
  239. <td class="mlabels-right">
  240. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  241. </tr>
  242. </table>
  243. </div><div class="memdoc">
  244. <p>Return the <em>tag</em> on <em>cq</em> when the channel state is changed or <em>deadline</em> expires. </p>
  245. <p><em>GetState</em> needs to called to get the current state. </p>
  246. </div>
  247. </div>
  248. <a id="a31d360cd218614814d68e01e07ce55cc"></a>
  249. <h2 class="memtitle"><span class="permalink"><a href="#a31d360cd218614814d68e01e07ce55cc">&#9670;&nbsp;</a></span>WaitForConnected()</h2>
  250. <div class="memitem">
  251. <div class="memproto">
  252. <div class="memtemplate">
  253. template&lt;typename T &gt; </div>
  254. <table class="mlabels">
  255. <tr>
  256. <td class="mlabels-left">
  257. <table class="memname">
  258. <tr>
  259. <td class="memname">bool grpc::ChannelInterface::WaitForConnected </td>
  260. <td>(</td>
  261. <td class="paramtype">T&#160;</td>
  262. <td class="paramname"><em>deadline</em></td><td>)</td>
  263. <td></td>
  264. </tr>
  265. </table>
  266. </td>
  267. <td class="mlabels-right">
  268. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  269. </tr>
  270. </table>
  271. </div><div class="memdoc">
  272. <p>Wait for this channel to be connected. </p>
  273. </div>
  274. </div>
  275. <a id="a70567e7ea3d1a967ecf5ecdc220ac27e"></a>
  276. <h2 class="memtitle"><span class="permalink"><a href="#a70567e7ea3d1a967ecf5ecdc220ac27e">&#9670;&nbsp;</a></span>WaitForStateChange()</h2>
  277. <div class="memitem">
  278. <div class="memproto">
  279. <div class="memtemplate">
  280. template&lt;typename T &gt; </div>
  281. <table class="mlabels">
  282. <tr>
  283. <td class="mlabels-left">
  284. <table class="memname">
  285. <tr>
  286. <td class="memname">bool grpc::ChannelInterface::WaitForStateChange </td>
  287. <td>(</td>
  288. <td class="paramtype"><a class="el" href="connectivity__state_8h.html#a065b65f5cdd062a67d82e2b6bcf68cf2">grpc_connectivity_state</a>&#160;</td>
  289. <td class="paramname"><em>last_observed</em>, </td>
  290. </tr>
  291. <tr>
  292. <td class="paramkey"></td>
  293. <td></td>
  294. <td class="paramtype">T&#160;</td>
  295. <td class="paramname"><em>deadline</em>&#160;</td>
  296. </tr>
  297. <tr>
  298. <td></td>
  299. <td>)</td>
  300. <td></td><td></td>
  301. </tr>
  302. </table>
  303. </td>
  304. <td class="mlabels-right">
  305. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  306. </tr>
  307. </table>
  308. </div><div class="memdoc">
  309. <p>Blocking wait for channel state change or <em>deadline</em> expiration. </p>
  310. <p><em>GetState</em> needs to called to get the current state. </p>
  311. </div>
  312. </div>
  313. <h2 class="groupheader">Friends And Related Function Documentation</h2>
  314. <a id="ade499098cc91745c1c87147d7a7fb7bf"></a>
  315. <h2 class="memtitle"><span class="permalink"><a href="#ade499098cc91745c1c87147d7a7fb7bf">&#9670;&nbsp;</a></span>::grpc::ClientReader</h2>
  316. <div class="memitem">
  317. <div class="memproto">
  318. <div class="memtemplate">
  319. template&lt;class R &gt; </div>
  320. <table class="mlabels">
  321. <tr>
  322. <td class="mlabels-left">
  323. <table class="memname">
  324. <tr>
  325. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1_client_reader.html">grpc::ClientReader</a></td>
  326. </tr>
  327. </table>
  328. </td>
  329. <td class="mlabels-right">
  330. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  331. </tr>
  332. </table>
  333. </div><div class="memdoc">
  334. </div>
  335. </div>
  336. <a id="a6d5659aa24edba057895be774e2752ec"></a>
  337. <h2 class="memtitle"><span class="permalink"><a href="#a6d5659aa24edba057895be774e2752ec">&#9670;&nbsp;</a></span>::grpc::ClientReaderWriter</h2>
  338. <div class="memitem">
  339. <div class="memproto">
  340. <div class="memtemplate">
  341. template&lt;class W , class R &gt; </div>
  342. <table class="mlabels">
  343. <tr>
  344. <td class="mlabels-left">
  345. <table class="memname">
  346. <tr>
  347. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1_client_reader_writer.html">grpc::ClientReaderWriter</a></td>
  348. </tr>
  349. </table>
  350. </td>
  351. <td class="mlabels-right">
  352. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  353. </tr>
  354. </table>
  355. </div><div class="memdoc">
  356. </div>
  357. </div>
  358. <a id="a4498fada67d531d99a8642f47d746544"></a>
  359. <h2 class="memtitle"><span class="permalink"><a href="#a4498fada67d531d99a8642f47d746544">&#9670;&nbsp;</a></span>::grpc::ClientWriter</h2>
  360. <div class="memitem">
  361. <div class="memproto">
  362. <div class="memtemplate">
  363. template&lt;class W &gt; </div>
  364. <table class="mlabels">
  365. <tr>
  366. <td class="mlabels-left">
  367. <table class="memname">
  368. <tr>
  369. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1_client_writer.html">grpc::ClientWriter</a></td>
  370. </tr>
  371. </table>
  372. </td>
  373. <td class="mlabels-right">
  374. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  375. </tr>
  376. </table>
  377. </div><div class="memdoc">
  378. </div>
  379. </div>
  380. <a id="ac8c9786b36d074059b306ff1d1d90453"></a>
  381. <h2 class="memtitle"><span class="permalink"><a href="#ac8c9786b36d074059b306ff1d1d90453">&#9670;&nbsp;</a></span>::grpc::experimental::DelegatingChannel</h2>
  382. <div class="memitem">
  383. <div class="memproto">
  384. <table class="mlabels">
  385. <tr>
  386. <td class="mlabels-left">
  387. <table class="memname">
  388. <tr>
  389. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1experimental_1_1_delegating_channel.html">grpc::experimental::DelegatingChannel</a></td>
  390. </tr>
  391. </table>
  392. </td>
  393. <td class="mlabels-right">
  394. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  395. </tr>
  396. </table>
  397. </div><div class="memdoc">
  398. </div>
  399. </div>
  400. <a id="ad26a823fee699f97244d581f400fe39a"></a>
  401. <h2 class="memtitle"><span class="permalink"><a href="#ad26a823fee699f97244d581f400fe39a">&#9670;&nbsp;</a></span>::grpc::internal::BlockingUnaryCallImpl</h2>
  402. <div class="memitem">
  403. <div class="memproto">
  404. <div class="memtemplate">
  405. template&lt;class InputMessage , class OutputMessage &gt; </div>
  406. <table class="mlabels">
  407. <tr>
  408. <td class="mlabels-left">
  409. <table class="memname">
  410. <tr>
  411. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_blocking_unary_call_impl.html">grpc::internal::BlockingUnaryCallImpl</a></td>
  412. </tr>
  413. </table>
  414. </td>
  415. <td class="mlabels-right">
  416. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  417. </tr>
  418. </table>
  419. </div><div class="memdoc">
  420. </div>
  421. </div>
  422. <a id="a039f3a4023eccbecbb5c9925722e9ef7"></a>
  423. <h2 class="memtitle"><span class="permalink"><a href="#a039f3a4023eccbecbb5c9925722e9ef7">&#9670;&nbsp;</a></span>::grpc::internal::CallbackUnaryCallImpl</h2>
  424. <div class="memitem">
  425. <div class="memproto">
  426. <div class="memtemplate">
  427. template&lt;class InputMessage , class OutputMessage &gt; </div>
  428. <table class="mlabels">
  429. <tr>
  430. <td class="mlabels-left">
  431. <table class="memname">
  432. <tr>
  433. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_callback_unary_call_impl.html">grpc::internal::CallbackUnaryCallImpl</a></td>
  434. </tr>
  435. </table>
  436. </td>
  437. <td class="mlabels-right">
  438. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  439. </tr>
  440. </table>
  441. </div><div class="memdoc">
  442. </div>
  443. </div>
  444. <a id="a2175726e9cbee09a493f40e1c3b5b088"></a>
  445. <h2 class="memtitle"><span class="permalink"><a href="#a2175726e9cbee09a493f40e1c3b5b088">&#9670;&nbsp;</a></span>::grpc::internal::ClientAsyncReaderFactory</h2>
  446. <div class="memitem">
  447. <div class="memproto">
  448. <div class="memtemplate">
  449. template&lt;class R &gt; </div>
  450. <table class="mlabels">
  451. <tr>
  452. <td class="mlabels-left">
  453. <table class="memname">
  454. <tr>
  455. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_client_async_reader_factory.html">grpc::internal::ClientAsyncReaderFactory</a></td>
  456. </tr>
  457. </table>
  458. </td>
  459. <td class="mlabels-right">
  460. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  461. </tr>
  462. </table>
  463. </div><div class="memdoc">
  464. </div>
  465. </div>
  466. <a id="a7c87e7adb535c485a4bc8e7215fab4a4"></a>
  467. <h2 class="memtitle"><span class="permalink"><a href="#a7c87e7adb535c485a4bc8e7215fab4a4">&#9670;&nbsp;</a></span>::grpc::internal::ClientAsyncReaderWriterFactory</h2>
  468. <div class="memitem">
  469. <div class="memproto">
  470. <div class="memtemplate">
  471. template&lt;class W , class R &gt; </div>
  472. <table class="mlabels">
  473. <tr>
  474. <td class="mlabels-left">
  475. <table class="memname">
  476. <tr>
  477. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_client_async_reader_writer_factory.html">grpc::internal::ClientAsyncReaderWriterFactory</a></td>
  478. </tr>
  479. </table>
  480. </td>
  481. <td class="mlabels-right">
  482. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  483. </tr>
  484. </table>
  485. </div><div class="memdoc">
  486. </div>
  487. </div>
  488. <a id="a1276dd3b0504721eced67f15c36ac888"></a>
  489. <h2 class="memtitle"><span class="permalink"><a href="#a1276dd3b0504721eced67f15c36ac888">&#9670;&nbsp;</a></span>::grpc::internal::ClientAsyncResponseReaderHelper</h2>
  490. <div class="memitem">
  491. <div class="memproto">
  492. <table class="mlabels">
  493. <tr>
  494. <td class="mlabels-left">
  495. <table class="memname">
  496. <tr>
  497. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_client_async_response_reader_helper.html">grpc::internal::ClientAsyncResponseReaderHelper</a></td>
  498. </tr>
  499. </table>
  500. </td>
  501. <td class="mlabels-right">
  502. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  503. </tr>
  504. </table>
  505. </div><div class="memdoc">
  506. </div>
  507. </div>
  508. <a id="aa160cb54356482ee5c40511fe76b4c9d"></a>
  509. <h2 class="memtitle"><span class="permalink"><a href="#aa160cb54356482ee5c40511fe76b4c9d">&#9670;&nbsp;</a></span>::grpc::internal::ClientAsyncWriterFactory</h2>
  510. <div class="memitem">
  511. <div class="memproto">
  512. <div class="memtemplate">
  513. template&lt;class W &gt; </div>
  514. <table class="mlabels">
  515. <tr>
  516. <td class="mlabels-left">
  517. <table class="memname">
  518. <tr>
  519. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_client_async_writer_factory.html">grpc::internal::ClientAsyncWriterFactory</a></td>
  520. </tr>
  521. </table>
  522. </td>
  523. <td class="mlabels-right">
  524. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  525. </tr>
  526. </table>
  527. </div><div class="memdoc">
  528. </div>
  529. </div>
  530. <a id="aac76a68caa02d284d9352eb3b8ed04fe"></a>
  531. <h2 class="memtitle"><span class="permalink"><a href="#aac76a68caa02d284d9352eb3b8ed04fe">&#9670;&nbsp;</a></span>::grpc::internal::ClientCallbackReaderFactory</h2>
  532. <div class="memitem">
  533. <div class="memproto">
  534. <div class="memtemplate">
  535. template&lt;class R &gt; </div>
  536. <table class="mlabels">
  537. <tr>
  538. <td class="mlabels-left">
  539. <table class="memname">
  540. <tr>
  541. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_client_callback_reader_factory.html">grpc::internal::ClientCallbackReaderFactory</a></td>
  542. </tr>
  543. </table>
  544. </td>
  545. <td class="mlabels-right">
  546. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  547. </tr>
  548. </table>
  549. </div><div class="memdoc">
  550. </div>
  551. </div>
  552. <a id="a12a368febde8b86808b24295c04c7b34"></a>
  553. <h2 class="memtitle"><span class="permalink"><a href="#a12a368febde8b86808b24295c04c7b34">&#9670;&nbsp;</a></span>::grpc::internal::ClientCallbackReaderWriterFactory</h2>
  554. <div class="memitem">
  555. <div class="memproto">
  556. <div class="memtemplate">
  557. template&lt;class W , class R &gt; </div>
  558. <table class="mlabels">
  559. <tr>
  560. <td class="mlabels-left">
  561. <table class="memname">
  562. <tr>
  563. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_client_callback_reader_writer_factory.html">grpc::internal::ClientCallbackReaderWriterFactory</a></td>
  564. </tr>
  565. </table>
  566. </td>
  567. <td class="mlabels-right">
  568. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  569. </tr>
  570. </table>
  571. </div><div class="memdoc">
  572. </div>
  573. </div>
  574. <a id="aee23b219653dea5f3fef55176aca3509"></a>
  575. <h2 class="memtitle"><span class="permalink"><a href="#aee23b219653dea5f3fef55176aca3509">&#9670;&nbsp;</a></span>::grpc::internal::ClientCallbackUnaryFactory</h2>
  576. <div class="memitem">
  577. <div class="memproto">
  578. <table class="mlabels">
  579. <tr>
  580. <td class="mlabels-left">
  581. <table class="memname">
  582. <tr>
  583. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_client_callback_unary_factory.html">grpc::internal::ClientCallbackUnaryFactory</a></td>
  584. </tr>
  585. </table>
  586. </td>
  587. <td class="mlabels-right">
  588. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  589. </tr>
  590. </table>
  591. </div><div class="memdoc">
  592. </div>
  593. </div>
  594. <a id="abe439612681a46aabf8cb5c1c8f0a170"></a>
  595. <h2 class="memtitle"><span class="permalink"><a href="#abe439612681a46aabf8cb5c1c8f0a170">&#9670;&nbsp;</a></span>::grpc::internal::ClientCallbackWriterFactory</h2>
  596. <div class="memitem">
  597. <div class="memproto">
  598. <div class="memtemplate">
  599. template&lt;class W &gt; </div>
  600. <table class="mlabels">
  601. <tr>
  602. <td class="mlabels-left">
  603. <table class="memname">
  604. <tr>
  605. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_client_callback_writer_factory.html">grpc::internal::ClientCallbackWriterFactory</a></td>
  606. </tr>
  607. </table>
  608. </td>
  609. <td class="mlabels-right">
  610. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  611. </tr>
  612. </table>
  613. </div><div class="memdoc">
  614. </div>
  615. </div>
  616. <a id="a9a23a8cfcee9fd9658ecd8bb1a3193ac"></a>
  617. <h2 class="memtitle"><span class="permalink"><a href="#a9a23a8cfcee9fd9658ecd8bb1a3193ac">&#9670;&nbsp;</a></span>::grpc::internal::InterceptedChannel</h2>
  618. <div class="memitem">
  619. <div class="memproto">
  620. <table class="mlabels">
  621. <tr>
  622. <td class="mlabels-left">
  623. <table class="memname">
  624. <tr>
  625. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_intercepted_channel.html">grpc::internal::InterceptedChannel</a></td>
  626. </tr>
  627. </table>
  628. </td>
  629. <td class="mlabels-right">
  630. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  631. </tr>
  632. </table>
  633. </div><div class="memdoc">
  634. </div>
  635. </div>
  636. <a id="afdfab4a69fd00ee5bffe02b9fd2718a2"></a>
  637. <h2 class="memtitle"><span class="permalink"><a href="#afdfab4a69fd00ee5bffe02b9fd2718a2">&#9670;&nbsp;</a></span>::grpc::internal::RpcMethod</h2>
  638. <div class="memitem">
  639. <div class="memproto">
  640. <table class="mlabels">
  641. <tr>
  642. <td class="mlabels-left">
  643. <table class="memname">
  644. <tr>
  645. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_rpc_method.html">grpc::internal::RpcMethod</a></td>
  646. </tr>
  647. </table>
  648. </td>
  649. <td class="mlabels-right">
  650. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  651. </tr>
  652. </table>
  653. </div><div class="memdoc">
  654. </div>
  655. </div>
  656. <hr/>The documentation for this class was generated from the following file:<ul>
  657. <li>include/grpcpp/impl/codegen/<a class="el" href="grpcpp_2impl_2codegen_2channel__interface_8h_source.html">channel_interface.h</a></li>
  658. </ul>
  659. </div><!-- contents -->
  660. <!-- start footer part -->
  661. <hr class="footer"/><address class="footer"><small>
  662. Generated on Wed Mar 3 2021 19:17:24 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  663. <img class="footer" src="doxygen.png" alt="doxygen"/>
  664. </a> 1.8.17
  665. </small></address>
  666. </body>
  667. </html>