carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GRPC C++: grpc::Channel 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++
   &#160;<span id="projectnumber">1.16.0-dev</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</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.html">Channel</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a>  </div>
  <div class="headertitle">
<div class="title">grpc::Channel Class Reference<span class="mlabels"><span class="mlabel">final</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>Channels represent a connection to an endpoint. Created by <em>CreateChannel</em>.  
 <a href="classgrpc_1_1_channel.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="grpcpp_2channel_8h_source.html">channel.h</a>&gt;</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:af12754677a599351077d6f68cc0c9159"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel.html#af12754677a599351077d6f68cc0c9159">~Channel</a> ()</td></tr>
<tr class="separator:af12754677a599351077d6f68cc0c9159"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a646d7a9d01f22037a72092d3a0bf159c"><td class="memItemLeft" align="right" valign="top"><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.html#a646d7a9d01f22037a72092d3a0bf159c">GetState</a> (bool try_to_connect) override</td></tr>
<tr class="memdesc:a646d7a9d01f22037a72092d3a0bf159c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current channel state.  <a href="#a646d7a9d01f22037a72092d3a0bf159c">More...</a><br /></td></tr>
<tr class="separator:a646d7a9d01f22037a72092d3a0bf159c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2cfba5ae4aae03ca016f902b2070a8a8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel.html#a2cfba5ae4aae03ca016f902b2070a8a8">GetLoadBalancingPolicyName</a> () const</td></tr>
<tr class="memdesc:a2cfba5ae4aae03ca016f902b2070a8a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the LB policy name, or the empty string if not yet available.  <a href="#a2cfba5ae4aae03ca016f902b2070a8a8">More...</a><br /></td></tr>
<tr class="separator:a2cfba5ae4aae03ca016f902b2070a8a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adeb2242c598bcc5179c90148eb0e289f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel.html#adeb2242c598bcc5179c90148eb0e289f">GetServiceConfigJSON</a> () const</td></tr>
<tr class="memdesc:adeb2242c598bcc5179c90148eb0e289f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the service config in JSON form, or the empty string if not available.  <a href="#adeb2242c598bcc5179c90148eb0e289f">More...</a><br /></td></tr>
<tr class="separator:adeb2242c598bcc5179c90148eb0e289f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classgrpc_1_1_channel_interface"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1_channel_interface')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc_1_1_channel_interface.html">grpc::ChannelInterface</a></td></tr>
<tr class="memitem:a3f5145d4778aa952540dc9983cefe13f inherit pub_methods_classgrpc_1_1_channel_interface"><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>
<tr class="separator:a3f5145d4778aa952540dc9983cefe13f inherit pub_methods_classgrpc_1_1_channel_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac2e0a00712088ca461359a78eb0e2c69 inherit pub_methods_classgrpc_1_1_channel_interface"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ac2e0a00712088ca461359a78eb0e2c69 inherit pub_methods_classgrpc_1_1_channel_interface"><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>
<tr class="memdesc:ac2e0a00712088ca461359a78eb0e2c69 inherit pub_methods_classgrpc_1_1_channel_interface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the <em>tag</em> on <em>cq</em> when the channel state is changed or <em>deadline</em> expires.  <a href="classgrpc_1_1_channel_interface.html#ac2e0a00712088ca461359a78eb0e2c69">More...</a><br /></td></tr>
<tr class="separator:ac2e0a00712088ca461359a78eb0e2c69 inherit pub_methods_classgrpc_1_1_channel_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a70567e7ea3d1a967ecf5ecdc220ac27e inherit pub_methods_classgrpc_1_1_channel_interface"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a70567e7ea3d1a967ecf5ecdc220ac27e inherit pub_methods_classgrpc_1_1_channel_interface"><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>
<tr class="memdesc:a70567e7ea3d1a967ecf5ecdc220ac27e inherit pub_methods_classgrpc_1_1_channel_interface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Blocking wait for channel state change or <em>deadline</em> expiration.  <a href="classgrpc_1_1_channel_interface.html#a70567e7ea3d1a967ecf5ecdc220ac27e">More...</a><br /></td></tr>
<tr class="separator:a70567e7ea3d1a967ecf5ecdc220ac27e inherit pub_methods_classgrpc_1_1_channel_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a31d360cd218614814d68e01e07ce55cc inherit pub_methods_classgrpc_1_1_channel_interface"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:a31d360cd218614814d68e01e07ce55cc inherit pub_methods_classgrpc_1_1_channel_interface"><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>
<tr class="memdesc:a31d360cd218614814d68e01e07ce55cc inherit pub_methods_classgrpc_1_1_channel_interface"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait for this channel to be connected.  <a href="classgrpc_1_1_channel_interface.html#a31d360cd218614814d68e01e07ce55cc">More...</a><br /></td></tr>
<tr class="separator:a31d360cd218614814d68e01e07ce55cc inherit pub_methods_classgrpc_1_1_channel_interface"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classgrpc_1_1internal_1_1_call_hook"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classgrpc_1_1internal_1_1_call_hook')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classgrpc_1_1internal_1_1_call_hook.html">grpc::internal::CallHook</a></td></tr>
<tr class="memitem:a351f3060b7d6378dabcec53d21842487 inherit pub_methods_classgrpc_1_1internal_1_1_call_hook"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1internal_1_1_call_hook.html#a351f3060b7d6378dabcec53d21842487">~CallHook</a> ()</td></tr>
<tr class="separator:a351f3060b7d6378dabcec53d21842487 inherit pub_methods_classgrpc_1_1internal_1_1_call_hook"><td class="memSeparator" colspan="2">&#160;</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:a9d3d75894c094247a6a89bdd9d9c068d"><td class="memTemplParams" colspan="2">template&lt;class InputMessage , class OutputMessage &gt; </td></tr>
<tr class="memitem:a9d3d75894c094247a6a89bdd9d9c068d"><td class="memTemplItemLeft" align="right" valign="top">class&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel.html#a9d3d75894c094247a6a89bdd9d9c068d">internal::BlockingUnaryCallImpl</a></td></tr>
<tr class="separator:a9d3d75894c094247a6a89bdd9d9c068d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afeee855c9424fd530c4aa98bce518243"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel.html#afeee855c9424fd530c4aa98bce518243">experimental::ChannelResetConnectionBackoff</a> (<a class="el" href="classgrpc_1_1_channel.html">Channel</a> *channel)</td></tr>
<tr class="separator:afeee855c9424fd530c4aa98bce518243"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acac59a2ab862b1c60832640b741e6440"><td class="memItemLeft" align="right" valign="top">std::shared_ptr&lt; <a class="el" href="classgrpc_1_1_channel.html">Channel</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrpc_1_1_channel.html#acac59a2ab862b1c60832640b741e6440">CreateChannelInternal</a> (const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;host, <a class="el" href="grpc__types_8h.html#a432bfa6b9f6603643cdf9de8804c254e">grpc_channel</a> *c_channel)</td></tr>
<tr class="separator:acac59a2ab862b1c60832640b741e6440"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Channels represent a connection to an endpoint. Created by <em>CreateChannel</em>. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="af12754677a599351077d6f68cc0c9159"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af12754677a599351077d6f68cc0c9159">&#9670;&nbsp;</a></span>~Channel()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">grpc::Channel::~Channel </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a2cfba5ae4aae03ca016f902b2070a8a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2cfba5ae4aae03ca016f902b2070a8a8">&#9670;&nbsp;</a></span>GetLoadBalancingPolicyName()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> grpc::Channel::GetLoadBalancingPolicyName </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the LB policy name, or the empty string if not yet available. </p>

</div>
</div>
<a id="adeb2242c598bcc5179c90148eb0e289f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adeb2242c598bcc5179c90148eb0e289f">&#9670;&nbsp;</a></span>GetServiceConfigJSON()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> grpc::Channel::GetServiceConfigJSON </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the service config in JSON form, or the empty string if not available. </p>

</div>
</div>
<a id="a646d7a9d01f22037a72092d3a0bf159c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a646d7a9d01f22037a72092d3a0bf159c">&#9670;&nbsp;</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"><a class="el" href="connectivity__state_8h.html#a065b65f5cdd062a67d82e2b6bcf68cf2">grpc_connectivity_state</a> grpc::Channel::GetState </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</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">override</span><span class="mlabel">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>Implements <a class="el" href="classgrpc_1_1_channel_interface.html#a68e987e7b87ca5a2668419736f9ee9b1">grpc::ChannelInterface</a>.</p>

</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="acac59a2ab862b1c60832640b741e6440"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acac59a2ab862b1c60832640b741e6440">&#9670;&nbsp;</a></span>CreateChannelInternal</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">std::shared_ptr&lt;<a class="el" href="classgrpc_1_1_channel.html">Channel</a>&gt; CreateChannelInternal </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="namespacegrpc.html#ab04a87625da3bf85cdaf5e7856b00203">grpc::string</a> &amp;&#160;</td>
          <td class="paramname"><em>host</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="grpc__types_8h.html#a432bfa6b9f6603643cdf9de8804c254e">grpc_channel</a> *&#160;</td>
          <td class="paramname"><em>c_channel</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></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="afeee855c9424fd530c4aa98bce518243"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afeee855c9424fd530c4aa98bce518243">&#9670;&nbsp;</a></span>experimental::ChannelResetConnectionBackoff</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="namespacegrpc_1_1experimental.html#ab4c7e40417b37179d52667f3208f69a3">experimental::ChannelResetConnectionBackoff</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classgrpc_1_1_channel.html">Channel</a> *&#160;</td>
          <td class="paramname"><em>channel</em></td><td>)</td>
          <td></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="a9d3d75894c094247a6a89bdd9d9c068d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d3d75894c094247a6a89bdd9d9c068d">&#9670;&nbsp;</a></span>internal::BlockingUnaryCallImpl</h2>

<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class InputMessage , class OutputMessage &gt; </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">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>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>include/grpcpp/<a class="el" href="grpcpp_2channel_8h_source.html">channel.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue Sep 18 2018 11:18:35 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>