123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=9"/>
- <meta name="generator" content="Doxygen 1.8.17"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>GRPC C++: grpc::ChannelInterface Class Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="search/searchdata.js"></script>
- <script type="text/javascript" src="search/search.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
- <td id="projectalign" style="padding-left: 0.5em;">
- <div id="projectname">GRPC C++
-  <span id="projectnumber">1.36.1</span>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.17 -->
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
- var searchBox = new SearchBox("searchBox", "search",false,'Search');
- /* @license-end */
- </script>
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
- $(function() {
- initMenu('',true,false,'search.php','Search');
- $(document).ready(function() { init_search(); });
- });
- /* @license-end */</script>
- <div id="main-nav"></div>
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- </div>
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <iframe src="javascript:void(0)" frameborder="0"
- name="MSearchResults" id="MSearchResults">
- </iframe>
- </div>
- <div id="nav-path" class="navpath">
- <ul>
- <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>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="#friends">Friends</a> </div>
- <div class="headertitle">
- <div class="title">grpc::ChannelInterface Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
- </div><!--header-->
- <div class="contents">
- <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>.
- <a href="classgrpc_1_1_channel_interface.html#details">More...</a></p>
- <p><code>#include <<a class="el" href="grpcpp_2impl_2codegen_2channel__interface_8h_source.html">channel_interface.h</a>></code></p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:a3f5145d4778aa952540dc9983cefe13f"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#a3f5145d4778aa952540dc9983cefe13f">~ChannelInterface</a> ()</td></tr>
- <tr class="separator:a3f5145d4778aa952540dc9983cefe13f"><td class="memSeparator" colspan="2"> </td></tr>
- <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> </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>
- <tr class="memdesc:a68e987e7b87ca5a2668419736f9ee9b1"><td class="mdescLeft"> </td><td class="mdescRight">Get the current channel state. <a href="classgrpc_1_1_channel_interface.html#a68e987e7b87ca5a2668419736f9ee9b1">More...</a><br /></td></tr>
- <tr class="separator:a68e987e7b87ca5a2668419736f9ee9b1"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad2ffa0dffc84f1fe38084c0993c4ca50"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
- <tr class="memitem:ad2ffa0dffc84f1fe38084c0993c4ca50"><td class="memTemplItemLeft" align="right" valign="top">void </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>
- <tr class="memdesc:ad2ffa0dffc84f1fe38084c0993c4ca50"><td class="mdescLeft"> </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>
- <tr class="separator:ad2ffa0dffc84f1fe38084c0993c4ca50"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a70567e7ea3d1a967ecf5ecdc220ac27e"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
- <tr class="memitem:a70567e7ea3d1a967ecf5ecdc220ac27e"><td class="memTemplItemLeft" align="right" valign="top">bool </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>
- <tr class="memdesc:a70567e7ea3d1a967ecf5ecdc220ac27e"><td class="mdescLeft"> </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>
- <tr class="separator:a70567e7ea3d1a967ecf5ecdc220ac27e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a31d360cd218614814d68e01e07ce55cc"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
- <tr class="memitem:a31d360cd218614814d68e01e07ce55cc"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#a31d360cd218614814d68e01e07ce55cc">WaitForConnected</a> (T deadline)</td></tr>
- <tr class="memdesc:a31d360cd218614814d68e01e07ce55cc"><td class="mdescLeft"> </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>
- <tr class="separator:a31d360cd218614814d68e01e07ce55cc"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
- Friends</h2></td></tr>
- <tr class="memitem:ade499098cc91745c1c87147d7a7fb7bf"><td class="memTemplParams" colspan="2">template<class R > </td></tr>
- <tr class="memitem:ade499098cc91745c1c87147d7a7fb7bf"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#ade499098cc91745c1c87147d7a7fb7bf">::grpc::ClientReader</a></td></tr>
- <tr class="separator:ade499098cc91745c1c87147d7a7fb7bf"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4498fada67d531d99a8642f47d746544"><td class="memTemplParams" colspan="2">template<class W > </td></tr>
- <tr class="memitem:a4498fada67d531d99a8642f47d746544"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#a4498fada67d531d99a8642f47d746544">::grpc::ClientWriter</a></td></tr>
- <tr class="separator:a4498fada67d531d99a8642f47d746544"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6d5659aa24edba057895be774e2752ec"><td class="memTemplParams" colspan="2">template<class W , class R > </td></tr>
- <tr class="memitem:a6d5659aa24edba057895be774e2752ec"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#a6d5659aa24edba057895be774e2752ec">::grpc::ClientReaderWriter</a></td></tr>
- <tr class="separator:a6d5659aa24edba057895be774e2752ec"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2175726e9cbee09a493f40e1c3b5b088"><td class="memTemplParams" colspan="2">template<class R > </td></tr>
- <tr class="memitem:a2175726e9cbee09a493f40e1c3b5b088"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#a2175726e9cbee09a493f40e1c3b5b088">::grpc::internal::ClientAsyncReaderFactory</a></td></tr>
- <tr class="separator:a2175726e9cbee09a493f40e1c3b5b088"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa160cb54356482ee5c40511fe76b4c9d"><td class="memTemplParams" colspan="2">template<class W > </td></tr>
- <tr class="memitem:aa160cb54356482ee5c40511fe76b4c9d"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#aa160cb54356482ee5c40511fe76b4c9d">::grpc::internal::ClientAsyncWriterFactory</a></td></tr>
- <tr class="separator:aa160cb54356482ee5c40511fe76b4c9d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7c87e7adb535c485a4bc8e7215fab4a4"><td class="memTemplParams" colspan="2">template<class W , class R > </td></tr>
- <tr class="memitem:a7c87e7adb535c485a4bc8e7215fab4a4"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#a7c87e7adb535c485a4bc8e7215fab4a4">::grpc::internal::ClientAsyncReaderWriterFactory</a></td></tr>
- <tr class="separator:a7c87e7adb535c485a4bc8e7215fab4a4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1276dd3b0504721eced67f15c36ac888"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#a1276dd3b0504721eced67f15c36ac888">::grpc::internal::ClientAsyncResponseReaderHelper</a></td></tr>
- <tr class="separator:a1276dd3b0504721eced67f15c36ac888"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a12a368febde8b86808b24295c04c7b34"><td class="memTemplParams" colspan="2">template<class W , class R > </td></tr>
- <tr class="memitem:a12a368febde8b86808b24295c04c7b34"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#a12a368febde8b86808b24295c04c7b34">::grpc::internal::ClientCallbackReaderWriterFactory</a></td></tr>
- <tr class="separator:a12a368febde8b86808b24295c04c7b34"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aac76a68caa02d284d9352eb3b8ed04fe"><td class="memTemplParams" colspan="2">template<class R > </td></tr>
- <tr class="memitem:aac76a68caa02d284d9352eb3b8ed04fe"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#aac76a68caa02d284d9352eb3b8ed04fe">::grpc::internal::ClientCallbackReaderFactory</a></td></tr>
- <tr class="separator:aac76a68caa02d284d9352eb3b8ed04fe"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:abe439612681a46aabf8cb5c1c8f0a170"><td class="memTemplParams" colspan="2">template<class W > </td></tr>
- <tr class="memitem:abe439612681a46aabf8cb5c1c8f0a170"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#abe439612681a46aabf8cb5c1c8f0a170">::grpc::internal::ClientCallbackWriterFactory</a></td></tr>
- <tr class="separator:abe439612681a46aabf8cb5c1c8f0a170"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aee23b219653dea5f3fef55176aca3509"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#aee23b219653dea5f3fef55176aca3509">::grpc::internal::ClientCallbackUnaryFactory</a></td></tr>
- <tr class="separator:aee23b219653dea5f3fef55176aca3509"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad26a823fee699f97244d581f400fe39a"><td class="memTemplParams" colspan="2">template<class InputMessage , class OutputMessage > </td></tr>
- <tr class="memitem:ad26a823fee699f97244d581f400fe39a"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#ad26a823fee699f97244d581f400fe39a">::grpc::internal::BlockingUnaryCallImpl</a></td></tr>
- <tr class="separator:ad26a823fee699f97244d581f400fe39a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a039f3a4023eccbecbb5c9925722e9ef7"><td class="memTemplParams" colspan="2">template<class InputMessage , class OutputMessage > </td></tr>
- <tr class="memitem:a039f3a4023eccbecbb5c9925722e9ef7"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#a039f3a4023eccbecbb5c9925722e9ef7">::grpc::internal::CallbackUnaryCallImpl</a></td></tr>
- <tr class="separator:a039f3a4023eccbecbb5c9925722e9ef7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:afdfab4a69fd00ee5bffe02b9fd2718a2"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#afdfab4a69fd00ee5bffe02b9fd2718a2">::grpc::internal::RpcMethod</a></td></tr>
- <tr class="separator:afdfab4a69fd00ee5bffe02b9fd2718a2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac8c9786b36d074059b306ff1d1d90453"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#ac8c9786b36d074059b306ff1d1d90453">::grpc::experimental::DelegatingChannel</a></td></tr>
- <tr class="separator:ac8c9786b36d074059b306ff1d1d90453"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9a23a8cfcee9fd9658ecd8bb1a3193ac"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#a9a23a8cfcee9fd9658ecd8bb1a3193ac">::grpc::internal::InterceptedChannel</a></td></tr>
- <tr class="separator:a9a23a8cfcee9fd9658ecd8bb1a3193ac"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <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>
- </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
- <a id="a3f5145d4778aa952540dc9983cefe13f"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a3f5145d4778aa952540dc9983cefe13f">◆ </a></span>~ChannelInterface()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual grpc::ChannelInterface::~ChannelInterface </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a id="a68e987e7b87ca5a2668419736f9ee9b1"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a68e987e7b87ca5a2668419736f9ee9b1">◆ </a></span>GetState()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">virtual <a class="el" href="connectivity__state_8h.html#a065b65f5cdd062a67d82e2b6bcf68cf2">grpc_connectivity_state</a> grpc::ChannelInterface::GetState </td>
- <td>(</td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>try_to_connect</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Get the current channel state. </p>
- <p>If the channel is in IDLE and <em>try_to_connect</em> is set to true, try to connect. </p>
- <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>
- </div>
- </div>
- <a id="ad2ffa0dffc84f1fe38084c0993c4ca50"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad2ffa0dffc84f1fe38084c0993c4ca50">◆ </a></span>NotifyOnStateChange()</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<typename T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void grpc::ChannelInterface::NotifyOnStateChange </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="connectivity__state_8h.html#a065b65f5cdd062a67d82e2b6bcf68cf2">grpc_connectivity_state</a> </td>
- <td class="paramname"><em>last_observed</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">T </td>
- <td class="paramname"><em>deadline</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">::<a class="el" href="classgrpc_1_1_completion_queue.html">grpc::CompletionQueue</a> * </td>
- <td class="paramname"><em>cq</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">void * </td>
- <td class="paramname"><em>tag</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Return the <em>tag</em> on <em>cq</em> when the channel state is changed or <em>deadline</em> expires. </p>
- <p><em>GetState</em> needs to called to get the current state. </p>
- </div>
- </div>
- <a id="a31d360cd218614814d68e01e07ce55cc"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a31d360cd218614814d68e01e07ce55cc">◆ </a></span>WaitForConnected()</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<typename T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool grpc::ChannelInterface::WaitForConnected </td>
- <td>(</td>
- <td class="paramtype">T </td>
- <td class="paramname"><em>deadline</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Wait for this channel to be connected. </p>
- </div>
- </div>
- <a id="a70567e7ea3d1a967ecf5ecdc220ac27e"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a70567e7ea3d1a967ecf5ecdc220ac27e">◆ </a></span>WaitForStateChange()</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<typename T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool grpc::ChannelInterface::WaitForStateChange </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="connectivity__state_8h.html#a065b65f5cdd062a67d82e2b6bcf68cf2">grpc_connectivity_state</a> </td>
- <td class="paramname"><em>last_observed</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">T </td>
- <td class="paramname"><em>deadline</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Blocking wait for channel state change or <em>deadline</em> expiration. </p>
- <p><em>GetState</em> needs to called to get the current state. </p>
- </div>
- </div>
- <h2 class="groupheader">Friends And Related Function Documentation</h2>
- <a id="ade499098cc91745c1c87147d7a7fb7bf"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ade499098cc91745c1c87147d7a7fb7bf">◆ </a></span>::grpc::ClientReader</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class R > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class ::<a class="el" href="classgrpc_1_1_client_reader.html">grpc::ClientReader</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a6d5659aa24edba057895be774e2752ec"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a6d5659aa24edba057895be774e2752ec">◆ </a></span>::grpc::ClientReaderWriter</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class W , class R > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class ::<a class="el" href="classgrpc_1_1_client_reader_writer.html">grpc::ClientReaderWriter</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a4498fada67d531d99a8642f47d746544"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a4498fada67d531d99a8642f47d746544">◆ </a></span>::grpc::ClientWriter</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class W > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class ::<a class="el" href="classgrpc_1_1_client_writer.html">grpc::ClientWriter</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="ac8c9786b36d074059b306ff1d1d90453"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ac8c9786b36d074059b306ff1d1d90453">◆ </a></span>::grpc::experimental::DelegatingChannel</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class ::<a class="el" href="classgrpc_1_1experimental_1_1_delegating_channel.html">grpc::experimental::DelegatingChannel</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="ad26a823fee699f97244d581f400fe39a"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#ad26a823fee699f97244d581f400fe39a">◆ </a></span>::grpc::internal::BlockingUnaryCallImpl</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class InputMessage , class OutputMessage > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_blocking_unary_call_impl.html">grpc::internal::BlockingUnaryCallImpl</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a039f3a4023eccbecbb5c9925722e9ef7"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a039f3a4023eccbecbb5c9925722e9ef7">◆ </a></span>::grpc::internal::CallbackUnaryCallImpl</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class InputMessage , class OutputMessage > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_callback_unary_call_impl.html">grpc::internal::CallbackUnaryCallImpl</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a2175726e9cbee09a493f40e1c3b5b088"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a2175726e9cbee09a493f40e1c3b5b088">◆ </a></span>::grpc::internal::ClientAsyncReaderFactory</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class R > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_client_async_reader_factory.html">grpc::internal::ClientAsyncReaderFactory</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a7c87e7adb535c485a4bc8e7215fab4a4"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a7c87e7adb535c485a4bc8e7215fab4a4">◆ </a></span>::grpc::internal::ClientAsyncReaderWriterFactory</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class W , class R > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <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>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a1276dd3b0504721eced67f15c36ac888"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a1276dd3b0504721eced67f15c36ac888">◆ </a></span>::grpc::internal::ClientAsyncResponseReaderHelper</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_client_async_response_reader_helper.html">grpc::internal::ClientAsyncResponseReaderHelper</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="aa160cb54356482ee5c40511fe76b4c9d"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aa160cb54356482ee5c40511fe76b4c9d">◆ </a></span>::grpc::internal::ClientAsyncWriterFactory</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class W > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_client_async_writer_factory.html">grpc::internal::ClientAsyncWriterFactory</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="aac76a68caa02d284d9352eb3b8ed04fe"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aac76a68caa02d284d9352eb3b8ed04fe">◆ </a></span>::grpc::internal::ClientCallbackReaderFactory</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class R > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_client_callback_reader_factory.html">grpc::internal::ClientCallbackReaderFactory</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a12a368febde8b86808b24295c04c7b34"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a12a368febde8b86808b24295c04c7b34">◆ </a></span>::grpc::internal::ClientCallbackReaderWriterFactory</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class W , class R > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <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>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="aee23b219653dea5f3fef55176aca3509"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aee23b219653dea5f3fef55176aca3509">◆ </a></span>::grpc::internal::ClientCallbackUnaryFactory</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_client_callback_unary_factory.html">grpc::internal::ClientCallbackUnaryFactory</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="abe439612681a46aabf8cb5c1c8f0a170"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#abe439612681a46aabf8cb5c1c8f0a170">◆ </a></span>::grpc::internal::ClientCallbackWriterFactory</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class W > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_client_callback_writer_factory.html">grpc::internal::ClientCallbackWriterFactory</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="a9a23a8cfcee9fd9658ecd8bb1a3193ac"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a9a23a8cfcee9fd9658ecd8bb1a3193ac">◆ </a></span>::grpc::internal::InterceptedChannel</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_intercepted_channel.html">grpc::internal::InterceptedChannel</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <a id="afdfab4a69fd00ee5bffe02b9fd2718a2"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#afdfab4a69fd00ee5bffe02b9fd2718a2">◆ </a></span>::grpc::internal::RpcMethod</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">friend class ::<a class="el" href="classgrpc_1_1internal_1_1_rpc_method.html">grpc::internal::RpcMethod</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">friend</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following file:<ul>
- <li>include/grpcpp/impl/codegen/<a class="el" href="grpcpp_2impl_2codegen_2channel__interface_8h_source.html">channel_interface.h</a></li>
- </ul>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated on Wed Mar 3 2021 19:17:24 for GRPC C++ by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.17
- </small></address>
- </body>
- </html>
|