722 lines
35 KiB
HTML
722 lines
35 KiB
HTML
<!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.31.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="namespacegrpc.html#a3c981ec4941ef822eb01ac99da53ca88">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:a2acd32839ec4e5e92fe4b796a913623f"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
|
|
<tr class="memitem:a2acd32839ec4e5e92fe4b796a913623f"><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#a2acd32839ec4e5e92fe4b796a913623f">NotifyOnStateChange</a> (<a class="el" href="connectivity__state_8h.html#a065b65f5cdd062a67d82e2b6bcf68cf2">grpc_connectivity_state</a> last_observed, T deadline, ::<a class="el" href="classgrpc__impl_1_1_completion_queue.html">grpc_impl::CompletionQueue</a> *cq, void *tag)</td></tr>
|
|
<tr class="memdesc:a2acd32839ec4e5e92fe4b796a913623f"><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#a2acd32839ec4e5e92fe4b796a913623f">More...</a><br /></td></tr>
|
|
<tr class="separator:a2acd32839ec4e5e92fe4b796a913623f"><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:a05b1387940f7625cebd368b4ad8bfb78"><td class="memTemplParams" colspan="2">template<class R > </td></tr>
|
|
<tr class="memitem:a05b1387940f7625cebd368b4ad8bfb78"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#a05b1387940f7625cebd368b4ad8bfb78">::grpc_impl::ClientReader</a></td></tr>
|
|
<tr class="separator:a05b1387940f7625cebd368b4ad8bfb78"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a50a886684b0bead6daf85a6537b57ed9"><td class="memTemplParams" colspan="2">template<class W > </td></tr>
|
|
<tr class="memitem:a50a886684b0bead6daf85a6537b57ed9"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#a50a886684b0bead6daf85a6537b57ed9">::grpc_impl::ClientWriter</a></td></tr>
|
|
<tr class="separator:a50a886684b0bead6daf85a6537b57ed9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6e5a529ee986e9e4558e8fb5ed7bf469"><td class="memTemplParams" colspan="2">template<class W , class R > </td></tr>
|
|
<tr class="memitem:a6e5a529ee986e9e4558e8fb5ed7bf469"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#a6e5a529ee986e9e4558e8fb5ed7bf469">::grpc_impl::ClientReaderWriter</a></td></tr>
|
|
<tr class="separator:a6e5a529ee986e9e4558e8fb5ed7bf469"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acec66ebadeb4641d4f4b6ca5f8605576"><td class="memTemplParams" colspan="2">template<class R > </td></tr>
|
|
<tr class="memitem:acec66ebadeb4641d4f4b6ca5f8605576"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#acec66ebadeb4641d4f4b6ca5f8605576">::grpc_impl::internal::ClientAsyncReaderFactory</a></td></tr>
|
|
<tr class="separator:acec66ebadeb4641d4f4b6ca5f8605576"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab4142fa2001470e3fe40be3da1cbad1d"><td class="memTemplParams" colspan="2">template<class W > </td></tr>
|
|
<tr class="memitem:ab4142fa2001470e3fe40be3da1cbad1d"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#ab4142fa2001470e3fe40be3da1cbad1d">::grpc_impl::internal::ClientAsyncWriterFactory</a></td></tr>
|
|
<tr class="separator:ab4142fa2001470e3fe40be3da1cbad1d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8c9c94392fd59035f28c1a1fbf48b5d1"><td class="memTemplParams" colspan="2">template<class W , class R > </td></tr>
|
|
<tr class="memitem:a8c9c94392fd59035f28c1a1fbf48b5d1"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#a8c9c94392fd59035f28c1a1fbf48b5d1">::grpc_impl::internal::ClientAsyncReaderWriterFactory</a></td></tr>
|
|
<tr class="separator:a8c9c94392fd59035f28c1a1fbf48b5d1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac21cd93c6c60410e3880fe7c17413fbc"><td class="memTemplParams" colspan="2">template<class R > </td></tr>
|
|
<tr class="memitem:ac21cd93c6c60410e3880fe7c17413fbc"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#ac21cd93c6c60410e3880fe7c17413fbc">::grpc_impl::internal::ClientAsyncResponseReaderFactory</a></td></tr>
|
|
<tr class="separator:ac21cd93c6c60410e3880fe7c17413fbc"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa2cdad8f0b03411cc64a86feef794967"><td class="memTemplParams" colspan="2">template<class W , class R > </td></tr>
|
|
<tr class="memitem:aa2cdad8f0b03411cc64a86feef794967"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#aa2cdad8f0b03411cc64a86feef794967">::grpc_impl::internal::ClientCallbackReaderWriterFactory</a></td></tr>
|
|
<tr class="separator:aa2cdad8f0b03411cc64a86feef794967"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1b97e2cfc0091303a32d5bc45f67d016"><td class="memTemplParams" colspan="2">template<class R > </td></tr>
|
|
<tr class="memitem:a1b97e2cfc0091303a32d5bc45f67d016"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#a1b97e2cfc0091303a32d5bc45f67d016">::grpc_impl::internal::ClientCallbackReaderFactory</a></td></tr>
|
|
<tr class="separator:a1b97e2cfc0091303a32d5bc45f67d016"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2a84ec8fd9964e233cc292ebc11050f9"><td class="memTemplParams" colspan="2">template<class W > </td></tr>
|
|
<tr class="memitem:a2a84ec8fd9964e233cc292ebc11050f9"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#a2a84ec8fd9964e233cc292ebc11050f9">::grpc_impl::internal::ClientCallbackWriterFactory</a></td></tr>
|
|
<tr class="separator:a2a84ec8fd9964e233cc292ebc11050f9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1b9c72fd25b53b3b37723d02eb6ddf44"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#a1b9c72fd25b53b3b37723d02eb6ddf44">::grpc_impl::internal::ClientCallbackUnaryFactory</a></td></tr>
|
|
<tr class="separator:a1b9c72fd25b53b3b37723d02eb6ddf44"><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:a4cb550833580f99a3482fddc7fe86125"><td class="memTemplParams" colspan="2">template<class InputMessage , class OutputMessage > </td></tr>
|
|
<tr class="memitem:a4cb550833580f99a3482fddc7fe86125"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel_interface.html#a4cb550833580f99a3482fddc7fe86125">::grpc_impl::internal::CallbackUnaryCallImpl</a></td></tr>
|
|
<tr class="separator:a4cb550833580f99a3482fddc7fe86125"><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="namespacegrpc.html#a3c981ec4941ef822eb01ac99da53ca88">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__impl_1_1_channel.html#a26d3eb40a00bc1ab58eb0752579c12d0">grpc_impl::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="a2acd32839ec4e5e92fe4b796a913623f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2acd32839ec4e5e92fe4b796a913623f">◆ </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__impl_1_1_completion_queue.html">grpc_impl::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="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="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>
|
|
<a id="a05b1387940f7625cebd368b4ad8bfb78"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a05b1387940f7625cebd368b4ad8bfb78">◆ </a></span>::grpc_impl::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__impl_1_1_client_reader.html">grpc_impl::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="a6e5a529ee986e9e4558e8fb5ed7bf469"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6e5a529ee986e9e4558e8fb5ed7bf469">◆ </a></span>::grpc_impl::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__impl_1_1_client_reader_writer.html">grpc_impl::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="a50a886684b0bead6daf85a6537b57ed9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a50a886684b0bead6daf85a6537b57ed9">◆ </a></span>::grpc_impl::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__impl_1_1_client_writer.html">grpc_impl::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="a4cb550833580f99a3482fddc7fe86125"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4cb550833580f99a3482fddc7fe86125">◆ </a></span>::grpc_impl::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__impl_1_1internal_1_1_callback_unary_call_impl.html">grpc_impl::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="acec66ebadeb4641d4f4b6ca5f8605576"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acec66ebadeb4641d4f4b6ca5f8605576">◆ </a></span>::grpc_impl::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__impl_1_1internal_1_1_client_async_reader_factory.html">grpc_impl::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="a8c9c94392fd59035f28c1a1fbf48b5d1"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8c9c94392fd59035f28c1a1fbf48b5d1">◆ </a></span>::grpc_impl::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__impl_1_1internal_1_1_client_async_reader_writer_factory.html">grpc_impl::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="ac21cd93c6c60410e3880fe7c17413fbc"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac21cd93c6c60410e3880fe7c17413fbc">◆ </a></span>::grpc_impl::internal::ClientAsyncResponseReaderFactory</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__impl_1_1internal_1_1_client_async_response_reader_factory.html">grpc_impl::internal::ClientAsyncResponseReaderFactory</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="ab4142fa2001470e3fe40be3da1cbad1d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab4142fa2001470e3fe40be3da1cbad1d">◆ </a></span>::grpc_impl::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__impl_1_1internal_1_1_client_async_writer_factory.html">grpc_impl::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="a1b97e2cfc0091303a32d5bc45f67d016"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1b97e2cfc0091303a32d5bc45f67d016">◆ </a></span>::grpc_impl::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__impl_1_1internal_1_1_client_callback_reader_factory.html">grpc_impl::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="aa2cdad8f0b03411cc64a86feef794967"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa2cdad8f0b03411cc64a86feef794967">◆ </a></span>::grpc_impl::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__impl_1_1internal_1_1_client_callback_reader_writer_factory.html">grpc_impl::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="a1b9c72fd25b53b3b37723d02eb6ddf44"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1b9c72fd25b53b3b37723d02eb6ddf44">◆ </a></span>::grpc_impl::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__impl_1_1internal_1_1_client_callback_unary_factory.html">grpc_impl::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="a2a84ec8fd9964e233cc292ebc11050f9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2a84ec8fd9964e233cc292ebc11050f9">◆ </a></span>::grpc_impl::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__impl_1_1internal_1_1_client_callback_writer_factory.html">grpc_impl::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>
|
|
<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 Tue Aug 18 2020 16:24:48 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>
|