carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258
							<!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 PHP: 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 PHP
   &#160;<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&amp;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&amp;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="namespace_grpc.html">Grpc</a></li><li class="navelem"><a class="el" href="class_grpc_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>  </div>
  <div class="headertitle">
<div class="title">Grpc\Channel Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>class <a class="el" href="class_grpc_1_1_channel.html" title="class Channel">Channel</a>  
 <a href="class_grpc_1_1_channel.html#details">More...</a></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:aa9cf4f79b071b277c297cbd2da31aff2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_channel.html#aa9cf4f79b071b277c297cbd2da31aff2">__construct</a> ($target, $args_array)</td></tr>
<tr class="memdesc:aa9cf4f79b071b277c297cbd2da31aff2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Construct an instance of the <a class="el" href="class_grpc_1_1_channel.html" title="class Channel">Channel</a> class.  <a href="class_grpc_1_1_channel.html#aa9cf4f79b071b277c297cbd2da31aff2">More...</a><br /></td></tr>
<tr class="separator:aa9cf4f79b071b277c297cbd2da31aff2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afce31d39c37f42d29cae7c5fbd5279d9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_channel.html#afce31d39c37f42d29cae7c5fbd5279d9">getTarget</a> ()</td></tr>
<tr class="memdesc:afce31d39c37f42d29cae7c5fbd5279d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the endpoint this call/stream is connected to.  <a href="class_grpc_1_1_channel.html#afce31d39c37f42d29cae7c5fbd5279d9">More...</a><br /></td></tr>
<tr class="separator:afce31d39c37f42d29cae7c5fbd5279d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a64f6c766e8d06e6d78c01c37de28f8d7"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_channel.html#a64f6c766e8d06e6d78c01c37de28f8d7">getConnectivityState</a> ($try_to_connect)</td></tr>
<tr class="memdesc:a64f6c766e8d06e6d78c01c37de28f8d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the connectivity state of the channel.  <a href="class_grpc_1_1_channel.html#a64f6c766e8d06e6d78c01c37de28f8d7">More...</a><br /></td></tr>
<tr class="separator:a64f6c766e8d06e6d78c01c37de28f8d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ef0546000edb6aba1f8e0233a75b10d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_channel.html#a2ef0546000edb6aba1f8e0233a75b10d">watchConnectivityState</a> ($last_state, $deadline_obj)</td></tr>
<tr class="memdesc:a2ef0546000edb6aba1f8e0233a75b10d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Watch the connectivity state of the channel until it changed.  <a href="class_grpc_1_1_channel.html#a2ef0546000edb6aba1f8e0233a75b10d">More...</a><br /></td></tr>
<tr class="separator:a2ef0546000edb6aba1f8e0233a75b10d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7475fd9110ae535b303cb37f8b217356"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_channel.html#a7475fd9110ae535b303cb37f8b217356">close</a> ()</td></tr>
<tr class="memdesc:a7475fd9110ae535b303cb37f8b217356"><td class="mdescLeft">&#160;</td><td class="mdescRight">Close the channel.  <a href="class_grpc_1_1_channel.html#a7475fd9110ae535b303cb37f8b217356">More...</a><br /></td></tr>
<tr class="separator:a7475fd9110ae535b303cb37f8b217356"><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>class <a class="el" href="class_grpc_1_1_channel.html" title="class Channel">Channel</a> </p>
<dl class="section see"><dt>See also</dt><dd><a href="https://github.com/grpc/grpc/tree/master/src/php/ext/grpc/channel.c">https://github.com/grpc/grpc/tree/master/src/php/ext/grpc/channel.c</a> </dd></dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aa9cf4f79b071b277c297cbd2da31aff2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa9cf4f79b071b277c297cbd2da31aff2">&#9670;&nbsp;</a></span>__construct()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Grpc\Channel::__construct </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>$target</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>$args_array</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Construct an instance of the <a class="el" href="class_grpc_1_1_channel.html" title="class Channel">Channel</a> class. </p>
<p>By default, the underlying grpc_channel is "persistent". That is, given the same set of parameters passed to the constructor, the same underlying grpc_channel will be returned.</p>
<p>If the $args array contains a "credentials" key mapping to a <a class="el" href="class_grpc_1_1_channel_credentials.html" title="class ChannelCredentials">ChannelCredentials</a> object, a secure channel will be created with those credentials.</p>
<p>If the $args array contains a "force_new" key mapping to a boolean value of "true", a new and separate underlying grpc_channel will be created and returned. This will not affect existing channels.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramtype">string</td><td class="paramname">$target</td><td>The hostname to associate with this channel </td></tr>
    <tr><td class="paramtype">array</td><td class="paramname">$args_array</td><td>The arguments to pass to the <a class="el" href="class_grpc_1_1_channel.html" title="class Channel">Channel</a> </td></tr>
  </table>
  </dd>
</dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Grpc\Channel::close </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Close the channel. </p>
<dl class="section return"><dt>Returns</dt><dd>void </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Grpc\Channel::getConnectivityState </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>$try_to_connect</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the connectivity state of the channel. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramtype">bool</td><td class="paramname">$try_to_connect</td><td>Try to connect on the channel (optional) </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>long The grpc connectivity state </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Grpc\Channel::getTarget </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get the endpoint this call/stream is connected to. </p>
<dl class="section return"><dt>Returns</dt><dd>string The URI of the endpoint </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Grpc\Channel::watchConnectivityState </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>$last_state</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>$deadline_obj</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Watch the connectivity state of the channel until it changed. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramtype">long</td><td class="paramname">$last_state</td><td>The previous connectivity state of the channel </td></tr>
    <tr><td class="paramtype"><a class="el" href="class_grpc_1_1_timeval.html" title="class Timeval">Timeval</a></td><td class="paramname">$deadline_obj</td><td>The deadline this function should wait until </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>bool If the connectivity state changes from last_state before deadline </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/php/lib/Grpc/<a class="el" href="_channel_8php.html">Channel.php</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 3 2021 19:20:18 for GRPC PHP by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>