classgrpc_1_1_channel_interface.html 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589
  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.17.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:ad26a823fee699f97244d581f400fe39a"><td class="memTemplParams" colspan="2">template&lt;class InputMessage , class OutputMessage &gt; </td></tr>
  119. <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>
  120. <tr class="separator:ad26a823fee699f97244d581f400fe39a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:a039f3a4023eccbecbb5c9925722e9ef7"><td class="memTemplParams" colspan="2">template&lt;class InputMessage , class OutputMessage &gt; </td></tr>
  122. <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>
  123. <tr class="separator:a039f3a4023eccbecbb5c9925722e9ef7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <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>
  125. <tr class="separator:afdfab4a69fd00ee5bffe02b9fd2718a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <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>
  127. <tr class="separator:a9a23a8cfcee9fd9658ecd8bb1a3193ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. </table>
  129. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  130. <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>
  131. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  132. <a id="a3f5145d4778aa952540dc9983cefe13f"></a>
  133. <h2 class="memtitle"><span class="permalink"><a href="#a3f5145d4778aa952540dc9983cefe13f">&#9670;&nbsp;</a></span>~ChannelInterface()</h2>
  134. <div class="memitem">
  135. <div class="memproto">
  136. <table class="mlabels">
  137. <tr>
  138. <td class="mlabels-left">
  139. <table class="memname">
  140. <tr>
  141. <td class="memname">virtual grpc::ChannelInterface::~ChannelInterface </td>
  142. <td>(</td>
  143. <td class="paramname"></td><td>)</td>
  144. <td></td>
  145. </tr>
  146. </table>
  147. </td>
  148. <td class="mlabels-right">
  149. <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
  150. </tr>
  151. </table>
  152. </div><div class="memdoc">
  153. </div>
  154. </div>
  155. <h2 class="groupheader">Member Function Documentation</h2>
  156. <a id="a68e987e7b87ca5a2668419736f9ee9b1"></a>
  157. <h2 class="memtitle"><span class="permalink"><a href="#a68e987e7b87ca5a2668419736f9ee9b1">&#9670;&nbsp;</a></span>GetState()</h2>
  158. <div class="memitem">
  159. <div class="memproto">
  160. <table class="mlabels">
  161. <tr>
  162. <td class="mlabels-left">
  163. <table class="memname">
  164. <tr>
  165. <td class="memname">virtual <a class="el" href="connectivity__state_8h.html#a065b65f5cdd062a67d82e2b6bcf68cf2">grpc_connectivity_state</a> grpc::ChannelInterface::GetState </td>
  166. <td>(</td>
  167. <td class="paramtype">bool&#160;</td>
  168. <td class="paramname"><em>try_to_connect</em></td><td>)</td>
  169. <td></td>
  170. </tr>
  171. </table>
  172. </td>
  173. <td class="mlabels-right">
  174. <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
  175. </tr>
  176. </table>
  177. </div><div class="memdoc">
  178. <p>Get the current channel state. </p>
  179. <p>If the channel is in IDLE and <em>try_to_connect</em> is set to true, try to connect. </p>
  180. <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>
  181. </div>
  182. </div>
  183. <a id="ac2e0a00712088ca461359a78eb0e2c69"></a>
  184. <h2 class="memtitle"><span class="permalink"><a href="#ac2e0a00712088ca461359a78eb0e2c69">&#9670;&nbsp;</a></span>NotifyOnStateChange()</h2>
  185. <div class="memitem">
  186. <div class="memproto">
  187. <div class="memtemplate">
  188. template&lt;typename T &gt; </div>
  189. <table class="mlabels">
  190. <tr>
  191. <td class="mlabels-left">
  192. <table class="memname">
  193. <tr>
  194. <td class="memname">void grpc::ChannelInterface::NotifyOnStateChange </td>
  195. <td>(</td>
  196. <td class="paramtype"><a class="el" href="connectivity__state_8h.html#a065b65f5cdd062a67d82e2b6bcf68cf2">grpc_connectivity_state</a>&#160;</td>
  197. <td class="paramname"><em>last_observed</em>, </td>
  198. </tr>
  199. <tr>
  200. <td class="paramkey"></td>
  201. <td></td>
  202. <td class="paramtype">T&#160;</td>
  203. <td class="paramname"><em>deadline</em>, </td>
  204. </tr>
  205. <tr>
  206. <td class="paramkey"></td>
  207. <td></td>
  208. <td class="paramtype"><a class="el" href="classgrpc_1_1_completion_queue.html">CompletionQueue</a> *&#160;</td>
  209. <td class="paramname"><em>cq</em>, </td>
  210. </tr>
  211. <tr>
  212. <td class="paramkey"></td>
  213. <td></td>
  214. <td class="paramtype">void *&#160;</td>
  215. <td class="paramname"><em>tag</em>&#160;</td>
  216. </tr>
  217. <tr>
  218. <td></td>
  219. <td>)</td>
  220. <td></td><td></td>
  221. </tr>
  222. </table>
  223. </td>
  224. <td class="mlabels-right">
  225. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  226. </tr>
  227. </table>
  228. </div><div class="memdoc">
  229. <p>Return the <em>tag</em> on <em>cq</em> when the channel state is changed or <em>deadline</em> expires. </p>
  230. <p><em>GetState</em> needs to called to get the current state. </p>
  231. </div>
  232. </div>
  233. <a id="a31d360cd218614814d68e01e07ce55cc"></a>
  234. <h2 class="memtitle"><span class="permalink"><a href="#a31d360cd218614814d68e01e07ce55cc">&#9670;&nbsp;</a></span>WaitForConnected()</h2>
  235. <div class="memitem">
  236. <div class="memproto">
  237. <div class="memtemplate">
  238. template&lt;typename T &gt; </div>
  239. <table class="mlabels">
  240. <tr>
  241. <td class="mlabels-left">
  242. <table class="memname">
  243. <tr>
  244. <td class="memname">bool grpc::ChannelInterface::WaitForConnected </td>
  245. <td>(</td>
  246. <td class="paramtype">T&#160;</td>
  247. <td class="paramname"><em>deadline</em></td><td>)</td>
  248. <td></td>
  249. </tr>
  250. </table>
  251. </td>
  252. <td class="mlabels-right">
  253. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  254. </tr>
  255. </table>
  256. </div><div class="memdoc">
  257. <p>Wait for this channel to be connected. </p>
  258. </div>
  259. </div>
  260. <a id="a70567e7ea3d1a967ecf5ecdc220ac27e"></a>
  261. <h2 class="memtitle"><span class="permalink"><a href="#a70567e7ea3d1a967ecf5ecdc220ac27e">&#9670;&nbsp;</a></span>WaitForStateChange()</h2>
  262. <div class="memitem">
  263. <div class="memproto">
  264. <div class="memtemplate">
  265. template&lt;typename T &gt; </div>
  266. <table class="mlabels">
  267. <tr>
  268. <td class="mlabels-left">
  269. <table class="memname">
  270. <tr>
  271. <td class="memname">bool grpc::ChannelInterface::WaitForStateChange </td>
  272. <td>(</td>
  273. <td class="paramtype"><a class="el" href="connectivity__state_8h.html#a065b65f5cdd062a67d82e2b6bcf68cf2">grpc_connectivity_state</a>&#160;</td>
  274. <td class="paramname"><em>last_observed</em>, </td>
  275. </tr>
  276. <tr>
  277. <td class="paramkey"></td>
  278. <td></td>
  279. <td class="paramtype">T&#160;</td>
  280. <td class="paramname"><em>deadline</em>&#160;</td>
  281. </tr>
  282. <tr>
  283. <td></td>
  284. <td>)</td>
  285. <td></td><td></td>
  286. </tr>
  287. </table>
  288. </td>
  289. <td class="mlabels-right">
  290. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  291. </tr>
  292. </table>
  293. </div><div class="memdoc">
  294. <p>Blocking wait for channel state change or <em>deadline</em> expiration. </p>
  295. <p><em>GetState</em> needs to called to get the current state. </p>
  296. </div>
  297. </div>
  298. <h2 class="groupheader">Friends And Related Function Documentation</h2>
  299. <a id="ade499098cc91745c1c87147d7a7fb7bf"></a>
  300. <h2 class="memtitle"><span class="permalink"><a href="#ade499098cc91745c1c87147d7a7fb7bf">&#9670;&nbsp;</a></span>::grpc::ClientReader</h2>
  301. <div class="memitem">
  302. <div class="memproto">
  303. <div class="memtemplate">
  304. template&lt;class R &gt; </div>
  305. <table class="mlabels">
  306. <tr>
  307. <td class="mlabels-left">
  308. <table class="memname">
  309. <tr>
  310. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1_client_reader.html">grpc::ClientReader</a></td>
  311. </tr>
  312. </table>
  313. </td>
  314. <td class="mlabels-right">
  315. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  316. </tr>
  317. </table>
  318. </div><div class="memdoc">
  319. </div>
  320. </div>
  321. <a id="a6d5659aa24edba057895be774e2752ec"></a>
  322. <h2 class="memtitle"><span class="permalink"><a href="#a6d5659aa24edba057895be774e2752ec">&#9670;&nbsp;</a></span>::grpc::ClientReaderWriter</h2>
  323. <div class="memitem">
  324. <div class="memproto">
  325. <div class="memtemplate">
  326. template&lt;class W , class R &gt; </div>
  327. <table class="mlabels">
  328. <tr>
  329. <td class="mlabels-left">
  330. <table class="memname">
  331. <tr>
  332. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1_client_reader_writer.html">grpc::ClientReaderWriter</a></td>
  333. </tr>
  334. </table>
  335. </td>
  336. <td class="mlabels-right">
  337. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  338. </tr>
  339. </table>
  340. </div><div class="memdoc">
  341. </div>
  342. </div>
  343. <a id="a4498fada67d531d99a8642f47d746544"></a>
  344. <h2 class="memtitle"><span class="permalink"><a href="#a4498fada67d531d99a8642f47d746544">&#9670;&nbsp;</a></span>::grpc::ClientWriter</h2>
  345. <div class="memitem">
  346. <div class="memproto">
  347. <div class="memtemplate">
  348. template&lt;class W &gt; </div>
  349. <table class="mlabels">
  350. <tr>
  351. <td class="mlabels-left">
  352. <table class="memname">
  353. <tr>
  354. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1_client_writer.html">grpc::ClientWriter</a></td>
  355. </tr>
  356. </table>
  357. </td>
  358. <td class="mlabels-right">
  359. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  360. </tr>
  361. </table>
  362. </div><div class="memdoc">
  363. </div>
  364. </div>
  365. <a id="ad26a823fee699f97244d581f400fe39a"></a>
  366. <h2 class="memtitle"><span class="permalink"><a href="#ad26a823fee699f97244d581f400fe39a">&#9670;&nbsp;</a></span>::grpc::internal::BlockingUnaryCallImpl</h2>
  367. <div class="memitem">
  368. <div class="memproto">
  369. <div class="memtemplate">
  370. template&lt;class InputMessage , class OutputMessage &gt; </div>
  371. <table class="mlabels">
  372. <tr>
  373. <td class="mlabels-left">
  374. <table class="memname">
  375. <tr>
  376. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_blocking_unary_call_impl.html">grpc::internal::BlockingUnaryCallImpl</a></td>
  377. </tr>
  378. </table>
  379. </td>
  380. <td class="mlabels-right">
  381. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  382. </tr>
  383. </table>
  384. </div><div class="memdoc">
  385. </div>
  386. </div>
  387. <a id="a039f3a4023eccbecbb5c9925722e9ef7"></a>
  388. <h2 class="memtitle"><span class="permalink"><a href="#a039f3a4023eccbecbb5c9925722e9ef7">&#9670;&nbsp;</a></span>::grpc::internal::CallbackUnaryCallImpl</h2>
  389. <div class="memitem">
  390. <div class="memproto">
  391. <div class="memtemplate">
  392. template&lt;class InputMessage , class OutputMessage &gt; </div>
  393. <table class="mlabels">
  394. <tr>
  395. <td class="mlabels-left">
  396. <table class="memname">
  397. <tr>
  398. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_callback_unary_call_impl.html">grpc::internal::CallbackUnaryCallImpl</a></td>
  399. </tr>
  400. </table>
  401. </td>
  402. <td class="mlabels-right">
  403. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  404. </tr>
  405. </table>
  406. </div><div class="memdoc">
  407. </div>
  408. </div>
  409. <a id="a2175726e9cbee09a493f40e1c3b5b088"></a>
  410. <h2 class="memtitle"><span class="permalink"><a href="#a2175726e9cbee09a493f40e1c3b5b088">&#9670;&nbsp;</a></span>::grpc::internal::ClientAsyncReaderFactory</h2>
  411. <div class="memitem">
  412. <div class="memproto">
  413. <div class="memtemplate">
  414. template&lt;class R &gt; </div>
  415. <table class="mlabels">
  416. <tr>
  417. <td class="mlabels-left">
  418. <table class="memname">
  419. <tr>
  420. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_client_async_reader_factory.html">grpc::internal::ClientAsyncReaderFactory</a></td>
  421. </tr>
  422. </table>
  423. </td>
  424. <td class="mlabels-right">
  425. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  426. </tr>
  427. </table>
  428. </div><div class="memdoc">
  429. </div>
  430. </div>
  431. <a id="a7c87e7adb535c485a4bc8e7215fab4a4"></a>
  432. <h2 class="memtitle"><span class="permalink"><a href="#a7c87e7adb535c485a4bc8e7215fab4a4">&#9670;&nbsp;</a></span>::grpc::internal::ClientAsyncReaderWriterFactory</h2>
  433. <div class="memitem">
  434. <div class="memproto">
  435. <div class="memtemplate">
  436. template&lt;class W , class R &gt; </div>
  437. <table class="mlabels">
  438. <tr>
  439. <td class="mlabels-left">
  440. <table class="memname">
  441. <tr>
  442. <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>
  443. </tr>
  444. </table>
  445. </td>
  446. <td class="mlabels-right">
  447. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  448. </tr>
  449. </table>
  450. </div><div class="memdoc">
  451. </div>
  452. </div>
  453. <a id="a9220bb63cb72c2095a63b595fd474dc9"></a>
  454. <h2 class="memtitle"><span class="permalink"><a href="#a9220bb63cb72c2095a63b595fd474dc9">&#9670;&nbsp;</a></span>::grpc::internal::ClientAsyncResponseReaderFactory</h2>
  455. <div class="memitem">
  456. <div class="memproto">
  457. <div class="memtemplate">
  458. template&lt;class R &gt; </div>
  459. <table class="mlabels">
  460. <tr>
  461. <td class="mlabels-left">
  462. <table class="memname">
  463. <tr>
  464. <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>
  465. </tr>
  466. </table>
  467. </td>
  468. <td class="mlabels-right">
  469. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  470. </tr>
  471. </table>
  472. </div><div class="memdoc">
  473. </div>
  474. </div>
  475. <a id="aa160cb54356482ee5c40511fe76b4c9d"></a>
  476. <h2 class="memtitle"><span class="permalink"><a href="#aa160cb54356482ee5c40511fe76b4c9d">&#9670;&nbsp;</a></span>::grpc::internal::ClientAsyncWriterFactory</h2>
  477. <div class="memitem">
  478. <div class="memproto">
  479. <div class="memtemplate">
  480. template&lt;class W &gt; </div>
  481. <table class="mlabels">
  482. <tr>
  483. <td class="mlabels-left">
  484. <table class="memname">
  485. <tr>
  486. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_client_async_writer_factory.html">grpc::internal::ClientAsyncWriterFactory</a></td>
  487. </tr>
  488. </table>
  489. </td>
  490. <td class="mlabels-right">
  491. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  492. </tr>
  493. </table>
  494. </div><div class="memdoc">
  495. </div>
  496. </div>
  497. <a id="a9a23a8cfcee9fd9658ecd8bb1a3193ac"></a>
  498. <h2 class="memtitle"><span class="permalink"><a href="#a9a23a8cfcee9fd9658ecd8bb1a3193ac">&#9670;&nbsp;</a></span>::grpc::internal::InterceptedChannel</h2>
  499. <div class="memitem">
  500. <div class="memproto">
  501. <table class="mlabels">
  502. <tr>
  503. <td class="mlabels-left">
  504. <table class="memname">
  505. <tr>
  506. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_intercepted_channel.html">grpc::internal::InterceptedChannel</a></td>
  507. </tr>
  508. </table>
  509. </td>
  510. <td class="mlabels-right">
  511. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  512. </tr>
  513. </table>
  514. </div><div class="memdoc">
  515. </div>
  516. </div>
  517. <a id="afdfab4a69fd00ee5bffe02b9fd2718a2"></a>
  518. <h2 class="memtitle"><span class="permalink"><a href="#afdfab4a69fd00ee5bffe02b9fd2718a2">&#9670;&nbsp;</a></span>::grpc::internal::RpcMethod</h2>
  519. <div class="memitem">
  520. <div class="memproto">
  521. <table class="mlabels">
  522. <tr>
  523. <td class="mlabels-left">
  524. <table class="memname">
  525. <tr>
  526. <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_rpc_method.html">grpc::internal::RpcMethod</a></td>
  527. </tr>
  528. </table>
  529. </td>
  530. <td class="mlabels-right">
  531. <span class="mlabels"><span class="mlabel">friend</span></span> </td>
  532. </tr>
  533. </table>
  534. </div><div class="memdoc">
  535. </div>
  536. </div>
  537. <hr/>The documentation for this class was generated from the following file:<ul>
  538. <li>include/grpcpp/impl/codegen/<a class="el" href="grpcpp_2impl_2codegen_2channel__interface_8h_source.html">channel_interface.h</a></li>
  539. </ul>
  540. </div><!-- contents -->
  541. <!-- start footer part -->
  542. <hr class="footer"/><address class="footer"><small>
  543. Generated on Wed Dec 5 2018 14:10:18 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
  544. <img class="footer" src="doxygen.png" alt="doxygen"/>
  545. </a> 1.8.13
  546. </small></address>
  547. </body>
  548. </html>