classgrpc_1_1_channel_interface.html 35 KB

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