classgrpc_1_1_channel_interface.html 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
  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.20.0</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.13 -->
  34. <script type="text/javascript">
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36. </script>
  37. <script type="text/javascript" src="menudata.js"></script>
  38. <script type="text/javascript" src="menu.js"></script>
  39. <script type="text/javascript">
  40. $(function() {
  41. initMenu('',true,false,'search.php','Search');
  42. $(document).ready(function() { init_search(); });
  43. });
  44. </script>
  45. <div id="main-nav"></div>
  46. <!-- window showing the filter options -->
  47. <div id="MSearchSelectWindow"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. onkeydown="return searchBox.OnSearchSelectKey(event)">
  51. </div>
  52. <!-- iframe showing the search results (closed by default) -->
  53. <div id="MSearchResultsWindow">
  54. <iframe src="javascript:void(0)" frameborder="0"
  55. name="MSearchResults" id="MSearchResults">
  56. </iframe>
  57. </div>
  58. <div id="nav-path" class="navpath">
  59. <ul>
  60. <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>
  61. </div>
  62. </div><!-- top -->
  63. <div class="header">
  64. <div class="summary">
  65. <a href="#pub-methods">Public Member Functions</a> &#124;
  66. <a href="#friends">Friends</a> </div>
  67. <div class="headertitle">
  68. <div class="title">grpc::ChannelInterface Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
  69. </div><!--header-->
  70. <div class="contents">
  71. <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>.
  72. <a href="classgrpc_1_1_channel_interface.html#details">More...</a></p>
  73. <p><code>#include &lt;<a class="el" href="grpcpp_2impl_2codegen_2channel__interface_8h_source.html">channel_interface.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: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>
  78. <tr class="separator:a3f5145d4778aa952540dc9983cefe13f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79. <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>
  80. <tr class="memdesc:a68e987e7b87ca5a2668419736f9ee9b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current channel state. <a href="#a68e987e7b87ca5a2668419736f9ee9b1">More...</a><br /></td></tr>
  81. <tr class="separator:a68e987e7b87ca5a2668419736f9ee9b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:ac2e0a00712088ca461359a78eb0e2c69"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  83. <tr class="memitem:ac2e0a00712088ca461359a78eb0e2c69"><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#ac2e0a00712088ca461359a78eb0e2c69">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">CompletionQueue</a> *cq, void *tag)</td></tr>
  84. <tr class="memdesc:ac2e0a00712088ca461359a78eb0e2c69"><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="#ac2e0a00712088ca461359a78eb0e2c69">More...</a><br /></td></tr>
  85. <tr class="separator:ac2e0a00712088ca461359a78eb0e2c69"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:a70567e7ea3d1a967ecf5ecdc220ac27e"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  87. <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>
  88. <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="#a70567e7ea3d1a967ecf5ecdc220ac27e">More...</a><br /></td></tr>
  89. <tr class="separator:a70567e7ea3d1a967ecf5ecdc220ac27e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a31d360cd218614814d68e01e07ce55cc"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  91. <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>
  92. <tr class="memdesc:a31d360cd218614814d68e01e07ce55cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait for this channel to be connected. <a href="#a31d360cd218614814d68e01e07ce55cc">More...</a><br /></td></tr>
  93. <tr class="separator:a31d360cd218614814d68e01e07ce55cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. </table><table class="memberdecls">
  95. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
  96. Friends</h2></td></tr>
  97. <tr class="memitem:ade499098cc91745c1c87147d7a7fb7bf"><td class="memTemplParams" colspan="2">template&lt;class R &gt; </td></tr>
  98. <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>
  99. <tr class="separator:ade499098cc91745c1c87147d7a7fb7bf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:a4498fada67d531d99a8642f47d746544"><td class="memTemplParams" colspan="2">template&lt;class W &gt; </td></tr>
  101. <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>
  102. <tr class="separator:a4498fada67d531d99a8642f47d746544"><td class="memSeparator" colspan="2">&#160;</td></tr>
  103. <tr class="memitem:a6d5659aa24edba057895be774e2752ec"><td class="memTemplParams" colspan="2">template&lt;class W , class R &gt; </td></tr>
  104. <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>
  105. <tr class="separator:a6d5659aa24edba057895be774e2752ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:a2175726e9cbee09a493f40e1c3b5b088"><td class="memTemplParams" colspan="2">template&lt;class R &gt; </td></tr>
  107. <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>
  108. <tr class="separator:a2175726e9cbee09a493f40e1c3b5b088"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:aa160cb54356482ee5c40511fe76b4c9d"><td class="memTemplParams" colspan="2">template&lt;class W &gt; </td></tr>
  110. <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>
  111. <tr class="separator:aa160cb54356482ee5c40511fe76b4c9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:a7c87e7adb535c485a4bc8e7215fab4a4"><td class="memTemplParams" colspan="2">template&lt;class W , class R &gt; </td></tr>
  113. <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>
  114. <tr class="separator:a7c87e7adb535c485a4bc8e7215fab4a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  115. <tr class="memitem:a9220bb63cb72c2095a63b595fd474dc9"><td class="memTemplParams" colspan="2">template&lt;class R &gt; </td></tr>
  116. <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>
  117. <tr class="separator:a9220bb63cb72c2095a63b595fd474dc9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  118. <tr class="memitem:a12a368febde8b86808b24295c04c7b34"><td class="memTemplParams" colspan="2">template&lt;class W , class R &gt; </td></tr>
  119. <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>
  120. <tr class="separator:a12a368febde8b86808b24295c04c7b34"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:aac76a68caa02d284d9352eb3b8ed04fe"><td class="memTemplParams" colspan="2">template&lt;class R &gt; </td></tr>
  122. <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>
  123. <tr class="separator:aac76a68caa02d284d9352eb3b8ed04fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:abe439612681a46aabf8cb5c1c8f0a170"><td class="memTemplParams" colspan="2">template&lt;class W &gt; </td></tr>
  125. <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>
  126. <tr class="separator:abe439612681a46aabf8cb5c1c8f0a170"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:ad26a823fee699f97244d581f400fe39a"><td class="memTemplParams" colspan="2">template&lt;class InputMessage , class OutputMessage &gt; </td></tr>
  128. <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>
  129. <tr class="separator:ad26a823fee699f97244d581f400fe39a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:a039f3a4023eccbecbb5c9925722e9ef7"><td class="memTemplParams" colspan="2">template&lt;class InputMessage , class OutputMessage &gt; </td></tr>
  131. <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>
  132. <tr class="separator:a039f3a4023eccbecbb5c9925722e9ef7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <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>
  134. <tr class="separator:afdfab4a69fd00ee5bffe02b9fd2718a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <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>
  136. <tr class="separator:a9a23a8cfcee9fd9658ecd8bb1a3193ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. </table>
  138. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  139. <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>
  140. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  141. <a id="a3f5145d4778aa952540dc9983cefe13f"></a>
  142. <h2 class="memtitle"><span class="permalink"><a href="#a3f5145d4778aa952540dc9983cefe13f">&#9670;&nbsp;</a></span>~ChannelInterface()</h2>
  143. <div class="memitem">
  144. <div class="memproto">
  145. <table class="mlabels">
  146. <tr>
  147. <td class="mlabels-left">
  148. <table class="memname">
  149. <tr>
  150. <td class="memname">virtual grpc::ChannelInterface::~ChannelInterface </td>
  151. <td>(</td>
  152. <td class="paramname"></td><td>)</td>
  153. <td></td>
  154. </tr>
  155. </table>
  156. </td>
  157. <td class="mlabels-right">
  158. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  159. </tr>
  160. </table>
  161. </div><div class="memdoc">
  162. </div>
  163. </div>
  164. <h2 class="groupheader">Member Function Documentation</h2>
  165. <a id="a68e987e7b87ca5a2668419736f9ee9b1"></a>
  166. <h2 class="memtitle"><span class="permalink"><a href="#a68e987e7b87ca5a2668419736f9ee9b1">&#9670;&nbsp;</a></span>GetState()</h2>
  167. <div class="memitem">
  168. <div class="memproto">
  169. <table class="mlabels">
  170. <tr>
  171. <td class="mlabels-left">
  172. <table class="memname">
  173. <tr>
  174. <td class="memname">virtual <a class="el" href="connectivity__state_8h.html#a065b65f5cdd062a67d82e2b6bcf68cf2">grpc_connectivity_state</a> grpc::ChannelInterface::GetState </td>
  175. <td>(</td>
  176. <td class="paramtype">bool&#160;</td>
  177. <td class="paramname"><em>try_to_connect</em></td><td>)</td>
  178. <td></td>
  179. </tr>
  180. </table>
  181. </td>
  182. <td class="mlabels-right">
  183. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  184. </tr>
  185. </table>
  186. </div><div class="memdoc">
  187. <p>Get the current channel state. </p>
  188. <p>If the channel is in IDLE and <em>try_to_connect</em> is set to true, try to connect. </p>
  189. <p>Implemented in <a class="el" href="classgrpc_1_1_channel.html#a646d7a9d01f22037a72092d3a0bf159c">grpc::Channel</a>, and <a class="el" href="classgrpc_1_1internal_1_1_intercepted_channel.html#ab7073fa3f0de1369f7201c1ce1630970">grpc::internal::InterceptedChannel</a>.</p>
  190. </div>
  191. </div>
  192. <a id="ac2e0a00712088ca461359a78eb0e2c69"></a>
  193. <h2 class="memtitle"><span class="permalink"><a href="#ac2e0a00712088ca461359a78eb0e2c69">&#9670;&nbsp;</a></span>NotifyOnStateChange()</h2>
  194. <div class="memitem">
  195. <div class="memproto">
  196. <div class="memtemplate">
  197. template&lt;typename T &gt; </div>
  198. <table class="mlabels">
  199. <tr>
  200. <td class="mlabels-left">
  201. <table class="memname">
  202. <tr>
  203. <td class="memname">void grpc::ChannelInterface::NotifyOnStateChange </td>
  204. <td>(</td>
  205. <td class="paramtype"><a class="el" href="connectivity__state_8h.html#a065b65f5cdd062a67d82e2b6bcf68cf2">grpc_connectivity_state</a>&#160;</td>
  206. <td class="paramname"><em>last_observed</em>, </td>
  207. </tr>
  208. <tr>
  209. <td class="paramkey"></td>
  210. <td></td>
  211. <td class="paramtype">T&#160;</td>
  212. <td class="paramname"><em>deadline</em>, </td>
  213. </tr>
  214. <tr>
  215. <td class="paramkey"></td>
  216. <td></td>
  217. <td class="paramtype"><a class="el" href="classgrpc_1_1_completion_queue.html">CompletionQueue</a> *&#160;</td>
  218. <td class="paramname"><em>cq</em>, </td>
  219. </tr>
  220. <tr>
  221. <td class="paramkey"></td>
  222. <td></td>
  223. <td class="paramtype">void *&#160;</td>
  224. <td class="paramname"><em>tag</em>&#160;</td>
  225. </tr>
  226. <tr>
  227. <td></td>
  228. <td>)</td>
  229. <td></td><td></td>
  230. </tr>
  231. </table>
  232. </td>
  233. <td class="mlabels-right">
  234. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  235. </tr>
  236. </table>
  237. </div><div class="memdoc">
  238. <p>Return the <em>tag</em> on <em>cq</em> when the channel state is changed or <em>deadline</em> expires. </p>
  239. <p><em>GetState</em> needs to called to get the current state. </p>
  240. </div>
  241. </div>
  242. <a id="a31d360cd218614814d68e01e07ce55cc"></a>
  243. <h2 class="memtitle"><span class="permalink"><a href="#a31d360cd218614814d68e01e07ce55cc">&#9670;&nbsp;</a></span>WaitForConnected()</h2>
  244. <div class="memitem">
  245. <div class="memproto">
  246. <div class="memtemplate">
  247. template&lt;typename T &gt; </div>
  248. <table class="mlabels">
  249. <tr>
  250. <td class="mlabels-left">
  251. <table class="memname">
  252. <tr>
  253. <td class="memname">bool grpc::ChannelInterface::WaitForConnected </td>
  254. <td>(</td>
  255. <td class="paramtype">T&#160;</td>
  256. <td class="paramname"><em>deadline</em></td><td>)</td>
  257. <td></td>
  258. </tr>
  259. </table>
  260. </td>
  261. <td class="mlabels-right">
  262. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  263. </tr>
  264. </table>
  265. </div><div class="memdoc">
  266. <p>Wait for this channel to be connected. </p>
  267. </div>
  268. </div>
  269. <a id="a70567e7ea3d1a967ecf5ecdc220ac27e"></a>
  270. <h2 class="memtitle"><span class="permalink"><a href="#a70567e7ea3d1a967ecf5ecdc220ac27e">&#9670;&nbsp;</a></span>WaitForStateChange()</h2>
  271. <div class="memitem">
  272. <div class="memproto">
  273. <div class="memtemplate">
  274. template&lt;typename T &gt; </div>
  275. <table class="mlabels">
  276. <tr>
  277. <td class="mlabels-left">
  278. <table class="memname">
  279. <tr>
  280. <td class="memname">bool grpc::ChannelInterface::WaitForStateChange </td>
  281. <td>(</td>
  282. <td class="paramtype"><a class="el" href="connectivity__state_8h.html#a065b65f5cdd062a67d82e2b6bcf68cf2">grpc_connectivity_state</a>&#160;</td>
  283. <td class="paramname"><em>last_observed</em>, </td>
  284. </tr>
  285. <tr>
  286. <td class="paramkey"></td>
  287. <td></td>
  288. <td class="paramtype">T&#160;</td>
  289. <td class="paramname"><em>deadline</em>&#160;</td>
  290. </tr>
  291. <tr>
  292. <td></td>
  293. <td>)</td>
  294. <td></td><td></td>
  295. </tr>
  296. </table>
  297. </td>
  298. <td class="mlabels-right">
  299. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  300. </tr>
  301. </table>
  302. </div><div class="memdoc">
  303. <p>Blocking wait for channel state change or <em>deadline</em> expiration. </p>
  304. <p><em>GetState</em> needs to called to get the current state. </p>
  305. </div>
  306. </div>
  307. <h2 class="groupheader">Friends And Related Function Documentation</h2>
  308. <a id="ade499098cc91745c1c87147d7a7fb7bf"></a>
  309. <h2 class="memtitle"><span class="permalink"><a href="#ade499098cc91745c1c87147d7a7fb7bf">&#9670;&nbsp;</a></span>::grpc::ClientReader</h2>
  310. <div class="memitem">
  311. <div class="memproto">
  312. <div class="memtemplate">
  313. template&lt;class R &gt; </div>
  314. <table class="mlabels">
  315. <tr>
  316. <td class="mlabels-left">
  317. <table class="memname">
  318. <tr>
  319. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1_client_reader.html">grpc::ClientReader</a></td>
  320. </tr>
  321. </table>
  322. </td>
  323. <td class="mlabels-right">
  324. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  325. </tr>
  326. </table>
  327. </div><div class="memdoc">
  328. </div>
  329. </div>
  330. <a id="a6d5659aa24edba057895be774e2752ec"></a>
  331. <h2 class="memtitle"><span class="permalink"><a href="#a6d5659aa24edba057895be774e2752ec">&#9670;&nbsp;</a></span>::grpc::ClientReaderWriter</h2>
  332. <div class="memitem">
  333. <div class="memproto">
  334. <div class="memtemplate">
  335. template&lt;class W , class R &gt; </div>
  336. <table class="mlabels">
  337. <tr>
  338. <td class="mlabels-left">
  339. <table class="memname">
  340. <tr>
  341. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1_client_reader_writer.html">grpc::ClientReaderWriter</a></td>
  342. </tr>
  343. </table>
  344. </td>
  345. <td class="mlabels-right">
  346. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  347. </tr>
  348. </table>
  349. </div><div class="memdoc">
  350. </div>
  351. </div>
  352. <a id="a4498fada67d531d99a8642f47d746544"></a>
  353. <h2 class="memtitle"><span class="permalink"><a href="#a4498fada67d531d99a8642f47d746544">&#9670;&nbsp;</a></span>::grpc::ClientWriter</h2>
  354. <div class="memitem">
  355. <div class="memproto">
  356. <div class="memtemplate">
  357. template&lt;class W &gt; </div>
  358. <table class="mlabels">
  359. <tr>
  360. <td class="mlabels-left">
  361. <table class="memname">
  362. <tr>
  363. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1_client_writer.html">grpc::ClientWriter</a></td>
  364. </tr>
  365. </table>
  366. </td>
  367. <td class="mlabels-right">
  368. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  369. </tr>
  370. </table>
  371. </div><div class="memdoc">
  372. </div>
  373. </div>
  374. <a id="ad26a823fee699f97244d581f400fe39a"></a>
  375. <h2 class="memtitle"><span class="permalink"><a href="#ad26a823fee699f97244d581f400fe39a">&#9670;&nbsp;</a></span>::grpc::internal::BlockingUnaryCallImpl</h2>
  376. <div class="memitem">
  377. <div class="memproto">
  378. <div class="memtemplate">
  379. template&lt;class InputMessage , class OutputMessage &gt; </div>
  380. <table class="mlabels">
  381. <tr>
  382. <td class="mlabels-left">
  383. <table class="memname">
  384. <tr>
  385. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_blocking_unary_call_impl.html">grpc::internal::BlockingUnaryCallImpl</a></td>
  386. </tr>
  387. </table>
  388. </td>
  389. <td class="mlabels-right">
  390. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  391. </tr>
  392. </table>
  393. </div><div class="memdoc">
  394. </div>
  395. </div>
  396. <a id="a039f3a4023eccbecbb5c9925722e9ef7"></a>
  397. <h2 class="memtitle"><span class="permalink"><a href="#a039f3a4023eccbecbb5c9925722e9ef7">&#9670;&nbsp;</a></span>::grpc::internal::CallbackUnaryCallImpl</h2>
  398. <div class="memitem">
  399. <div class="memproto">
  400. <div class="memtemplate">
  401. template&lt;class InputMessage , class OutputMessage &gt; </div>
  402. <table class="mlabels">
  403. <tr>
  404. <td class="mlabels-left">
  405. <table class="memname">
  406. <tr>
  407. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_callback_unary_call_impl.html">grpc::internal::CallbackUnaryCallImpl</a></td>
  408. </tr>
  409. </table>
  410. </td>
  411. <td class="mlabels-right">
  412. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  413. </tr>
  414. </table>
  415. </div><div class="memdoc">
  416. </div>
  417. </div>
  418. <a id="a2175726e9cbee09a493f40e1c3b5b088"></a>
  419. <h2 class="memtitle"><span class="permalink"><a href="#a2175726e9cbee09a493f40e1c3b5b088">&#9670;&nbsp;</a></span>::grpc::internal::ClientAsyncReaderFactory</h2>
  420. <div class="memitem">
  421. <div class="memproto">
  422. <div class="memtemplate">
  423. template&lt;class R &gt; </div>
  424. <table class="mlabels">
  425. <tr>
  426. <td class="mlabels-left">
  427. <table class="memname">
  428. <tr>
  429. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_client_async_reader_factory.html">grpc::internal::ClientAsyncReaderFactory</a></td>
  430. </tr>
  431. </table>
  432. </td>
  433. <td class="mlabels-right">
  434. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  435. </tr>
  436. </table>
  437. </div><div class="memdoc">
  438. </div>
  439. </div>
  440. <a id="a7c87e7adb535c485a4bc8e7215fab4a4"></a>
  441. <h2 class="memtitle"><span class="permalink"><a href="#a7c87e7adb535c485a4bc8e7215fab4a4">&#9670;&nbsp;</a></span>::grpc::internal::ClientAsyncReaderWriterFactory</h2>
  442. <div class="memitem">
  443. <div class="memproto">
  444. <div class="memtemplate">
  445. template&lt;class W , class R &gt; </div>
  446. <table class="mlabels">
  447. <tr>
  448. <td class="mlabels-left">
  449. <table class="memname">
  450. <tr>
  451. <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>
  452. </tr>
  453. </table>
  454. </td>
  455. <td class="mlabels-right">
  456. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  457. </tr>
  458. </table>
  459. </div><div class="memdoc">
  460. </div>
  461. </div>
  462. <a id="a9220bb63cb72c2095a63b595fd474dc9"></a>
  463. <h2 class="memtitle"><span class="permalink"><a href="#a9220bb63cb72c2095a63b595fd474dc9">&#9670;&nbsp;</a></span>::grpc::internal::ClientAsyncResponseReaderFactory</h2>
  464. <div class="memitem">
  465. <div class="memproto">
  466. <div class="memtemplate">
  467. template&lt;class R &gt; </div>
  468. <table class="mlabels">
  469. <tr>
  470. <td class="mlabels-left">
  471. <table class="memname">
  472. <tr>
  473. <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>
  474. </tr>
  475. </table>
  476. </td>
  477. <td class="mlabels-right">
  478. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  479. </tr>
  480. </table>
  481. </div><div class="memdoc">
  482. </div>
  483. </div>
  484. <a id="aa160cb54356482ee5c40511fe76b4c9d"></a>
  485. <h2 class="memtitle"><span class="permalink"><a href="#aa160cb54356482ee5c40511fe76b4c9d">&#9670;&nbsp;</a></span>::grpc::internal::ClientAsyncWriterFactory</h2>
  486. <div class="memitem">
  487. <div class="memproto">
  488. <div class="memtemplate">
  489. template&lt;class W &gt; </div>
  490. <table class="mlabels">
  491. <tr>
  492. <td class="mlabels-left">
  493. <table class="memname">
  494. <tr>
  495. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_client_async_writer_factory.html">grpc::internal::ClientAsyncWriterFactory</a></td>
  496. </tr>
  497. </table>
  498. </td>
  499. <td class="mlabels-right">
  500. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  501. </tr>
  502. </table>
  503. </div><div class="memdoc">
  504. </div>
  505. </div>
  506. <a id="aac76a68caa02d284d9352eb3b8ed04fe"></a>
  507. <h2 class="memtitle"><span class="permalink"><a href="#aac76a68caa02d284d9352eb3b8ed04fe">&#9670;&nbsp;</a></span>::grpc::internal::ClientCallbackReaderFactory</h2>
  508. <div class="memitem">
  509. <div class="memproto">
  510. <div class="memtemplate">
  511. template&lt;class R &gt; </div>
  512. <table class="mlabels">
  513. <tr>
  514. <td class="mlabels-left">
  515. <table class="memname">
  516. <tr>
  517. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_client_callback_reader_factory.html">grpc::internal::ClientCallbackReaderFactory</a></td>
  518. </tr>
  519. </table>
  520. </td>
  521. <td class="mlabels-right">
  522. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  523. </tr>
  524. </table>
  525. </div><div class="memdoc">
  526. </div>
  527. </div>
  528. <a id="a12a368febde8b86808b24295c04c7b34"></a>
  529. <h2 class="memtitle"><span class="permalink"><a href="#a12a368febde8b86808b24295c04c7b34">&#9670;&nbsp;</a></span>::grpc::internal::ClientCallbackReaderWriterFactory</h2>
  530. <div class="memitem">
  531. <div class="memproto">
  532. <div class="memtemplate">
  533. template&lt;class W , class R &gt; </div>
  534. <table class="mlabels">
  535. <tr>
  536. <td class="mlabels-left">
  537. <table class="memname">
  538. <tr>
  539. <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>
  540. </tr>
  541. </table>
  542. </td>
  543. <td class="mlabels-right">
  544. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  545. </tr>
  546. </table>
  547. </div><div class="memdoc">
  548. </div>
  549. </div>
  550. <a id="abe439612681a46aabf8cb5c1c8f0a170"></a>
  551. <h2 class="memtitle"><span class="permalink"><a href="#abe439612681a46aabf8cb5c1c8f0a170">&#9670;&nbsp;</a></span>::grpc::internal::ClientCallbackWriterFactory</h2>
  552. <div class="memitem">
  553. <div class="memproto">
  554. <div class="memtemplate">
  555. template&lt;class W &gt; </div>
  556. <table class="mlabels">
  557. <tr>
  558. <td class="mlabels-left">
  559. <table class="memname">
  560. <tr>
  561. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_client_callback_writer_factory.html">grpc::internal::ClientCallbackWriterFactory</a></td>
  562. </tr>
  563. </table>
  564. </td>
  565. <td class="mlabels-right">
  566. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  567. </tr>
  568. </table>
  569. </div><div class="memdoc">
  570. </div>
  571. </div>
  572. <a id="a9a23a8cfcee9fd9658ecd8bb1a3193ac"></a>
  573. <h2 class="memtitle"><span class="permalink"><a href="#a9a23a8cfcee9fd9658ecd8bb1a3193ac">&#9670;&nbsp;</a></span>::grpc::internal::InterceptedChannel</h2>
  574. <div class="memitem">
  575. <div class="memproto">
  576. <table class="mlabels">
  577. <tr>
  578. <td class="mlabels-left">
  579. <table class="memname">
  580. <tr>
  581. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_intercepted_channel.html">grpc::internal::InterceptedChannel</a></td>
  582. </tr>
  583. </table>
  584. </td>
  585. <td class="mlabels-right">
  586. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  587. </tr>
  588. </table>
  589. </div><div class="memdoc">
  590. </div>
  591. </div>
  592. <a id="afdfab4a69fd00ee5bffe02b9fd2718a2"></a>
  593. <h2 class="memtitle"><span class="permalink"><a href="#afdfab4a69fd00ee5bffe02b9fd2718a2">&#9670;&nbsp;</a></span>::grpc::internal::RpcMethod</h2>
  594. <div class="memitem">
  595. <div class="memproto">
  596. <table class="mlabels">
  597. <tr>
  598. <td class="mlabels-left">
  599. <table class="memname">
  600. <tr>
  601. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_rpc_method.html">grpc::internal::RpcMethod</a></td>
  602. </tr>
  603. </table>
  604. </td>
  605. <td class="mlabels-right">
  606. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  607. </tr>
  608. </table>
  609. </div><div class="memdoc">
  610. </div>
  611. </div>
  612. <hr/>The documentation for this class was generated from the following file:<ul>
  613. <li>include/grpcpp/impl/codegen/<a class="el" href="grpcpp_2impl_2codegen_2channel__interface_8h_source.html">channel_interface.h</a></li>
  614. </ul>
  615. </div><!-- contents -->
  616. <!-- start footer part -->
  617. <hr class="footer"/><address class="footer"><small>
  618. Generated on Wed Apr 17 2019 12:09:08 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  619. <img class="footer" src="doxygen.png" alt="doxygen"/>
  620. </a> 1.8.13
  621. </small></address>
  622. </body>
  623. </html>