carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401
							<!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\ChannelCredentials 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_credentials.html">ChannelCredentials</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">Grpc\ChannelCredentials Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>class <a class="el" href="class_grpc_1_1_channel_credentials.html" title="class ChannelCredentials">ChannelCredentials</a>  
 <a href="class_grpc_1_1_channel_credentials.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:aa36260c02be6eb2f7d141dcbc508ddcf"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_channel_credentials.html#aa36260c02be6eb2f7d141dcbc508ddcf">setDefaultRootsPem</a> ($pem_roots)</td></tr>
<tr class="memdesc:aa36260c02be6eb2f7d141dcbc508ddcf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set default roots pem.  <a href="class_grpc_1_1_channel_credentials.html#aa36260c02be6eb2f7d141dcbc508ddcf">More...</a><br /></td></tr>
<tr class="separator:aa36260c02be6eb2f7d141dcbc508ddcf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af9f1e5522ce2767c297e46847ef5fff4"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_channel_credentials.html#af9f1e5522ce2767c297e46847ef5fff4">isDefaultRootsPemSet</a> ()</td></tr>
<tr class="memdesc:af9f1e5522ce2767c297e46847ef5fff4"><td class="mdescLeft">&#160;</td><td class="mdescRight">if default roots pem is set  <a href="class_grpc_1_1_channel_credentials.html#af9f1e5522ce2767c297e46847ef5fff4">More...</a><br /></td></tr>
<tr class="separator:af9f1e5522ce2767c297e46847ef5fff4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeb985b18bdb11939991e988f717c801a"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_channel_credentials.html#aeb985b18bdb11939991e988f717c801a">invalidateDefaultRootsPem</a> ()</td></tr>
<tr class="memdesc:aeb985b18bdb11939991e988f717c801a"><td class="mdescLeft">&#160;</td><td class="mdescRight">free default roots pem, if it is set  <a href="class_grpc_1_1_channel_credentials.html#aeb985b18bdb11939991e988f717c801a">More...</a><br /></td></tr>
<tr class="separator:aeb985b18bdb11939991e988f717c801a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6cfccd4ab1f09fc3e326e4cc98c0507"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_channel_credentials.html#ae6cfccd4ab1f09fc3e326e4cc98c0507">createDefault</a> ()</td></tr>
<tr class="memdesc:ae6cfccd4ab1f09fc3e326e4cc98c0507"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a default channel credentials object.  <a href="class_grpc_1_1_channel_credentials.html#ae6cfccd4ab1f09fc3e326e4cc98c0507">More...</a><br /></td></tr>
<tr class="separator:ae6cfccd4ab1f09fc3e326e4cc98c0507"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5f8365f36d4b11101039e86811571203"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_channel_credentials.html#a5f8365f36d4b11101039e86811571203">createSsl</a> ($pem_root_certs=&quot;&quot;, $private_key=&quot;&quot;, $cert_chain=&quot;&quot;)</td></tr>
<tr class="memdesc:a5f8365f36d4b11101039e86811571203"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create SSL credentials.  <a href="class_grpc_1_1_channel_credentials.html#a5f8365f36d4b11101039e86811571203">More...</a><br /></td></tr>
<tr class="separator:a5f8365f36d4b11101039e86811571203"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab86aca4055799eaa2eed315fa2446944"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_channel_credentials.html#ab86aca4055799eaa2eed315fa2446944">createComposite</a> ($cred1_obj, $cred2_obj)</td></tr>
<tr class="memdesc:ab86aca4055799eaa2eed315fa2446944"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create composite credentials from two existing credentials.  <a href="class_grpc_1_1_channel_credentials.html#ab86aca4055799eaa2eed315fa2446944">More...</a><br /></td></tr>
<tr class="separator:ab86aca4055799eaa2eed315fa2446944"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab8ca6b64ea261b0c9344878b2348f320"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_channel_credentials.html#ab8ca6b64ea261b0c9344878b2348f320">createInsecure</a> ()</td></tr>
<tr class="memdesc:ab8ca6b64ea261b0c9344878b2348f320"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create insecure channel credentials.  <a href="class_grpc_1_1_channel_credentials.html#ab8ca6b64ea261b0c9344878b2348f320">More...</a><br /></td></tr>
<tr class="separator:ab8ca6b64ea261b0c9344878b2348f320"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aafd024703e87b413ba6862c20cb5565e"><td class="memItemLeft" align="right" valign="top">static&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_grpc_1_1_channel_credentials.html#aafd024703e87b413ba6862c20cb5565e">createXds</a> ($fallback_creds)</td></tr>
<tr class="memdesc:aafd024703e87b413ba6862c20cb5565e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create XDS channel credentials.  <a href="class_grpc_1_1_channel_credentials.html#aafd024703e87b413ba6862c20cb5565e">More...</a><br /></td></tr>
<tr class="separator:aafd024703e87b413ba6862c20cb5565e"><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_credentials.html" title="class ChannelCredentials">ChannelCredentials</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_credentials.c">https://github.com/grpc/grpc/tree/master/src/php/ext/grpc/channel_credentials.c</a> </dd></dl>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ab86aca4055799eaa2eed315fa2446944"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab86aca4055799eaa2eed315fa2446944">&#9670;&nbsp;</a></span>createComposite()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static Grpc\ChannelCredentials::createComposite </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>$cred1_obj</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>$cred2_obj</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">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Create composite credentials from two existing credentials. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramtype"><a class="el" href="class_grpc_1_1_channel_credentials.html" title="class ChannelCredentials">ChannelCredentials</a></td><td class="paramname">$cred1_obj</td><td>The first credential </td></tr>
    <tr><td class="paramtype"><a class="el" href="class_grpc_1_1_call_credentials.html" title="class CallCredentials">CallCredentials</a></td><td class="paramname">$cred2_obj</td><td>The second credential </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_grpc_1_1_channel_credentials.html" title="class ChannelCredentials">ChannelCredentials</a> The new composite credentials object </dd></dl>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static Grpc\ChannelCredentials::createDefault </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Create a default channel credentials object. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_grpc_1_1_channel_credentials.html" title="class ChannelCredentials">ChannelCredentials</a> The new default channel credentials object </dd></dl>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static Grpc\ChannelCredentials::createInsecure </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Create insecure channel credentials. </p>
<dl class="section return"><dt>Returns</dt><dd>null </dd></dl>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static Grpc\ChannelCredentials::createSsl </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>$pem_root_certs</em> = <code>&quot;&quot;</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>$private_key</em> = <code>&quot;&quot;</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>$cert_chain</em> = <code>&quot;&quot;</code>&#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">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Create SSL credentials. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramtype">string</td><td class="paramname">$pem_root_certs</td><td>= "" PEM encoding of the server root certificates (optional) </td></tr>
    <tr><td class="paramtype">string</td><td class="paramname">$private_key</td><td>= "" PEM encoding of the client's private key (optional) </td></tr>
    <tr><td class="paramtype">string</td><td class="paramname">$cert_chain</td><td>= "" PEM encoding of the client's certificate chain (optional) </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_grpc_1_1_channel_credentials.html" title="class ChannelCredentials">ChannelCredentials</a> The new SSL credentials object </dd></dl>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static Grpc\ChannelCredentials::createXds </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>$fallback_creds</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Create XDS channel credentials. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramtype"><a class="el" href="class_grpc_1_1_channel_credentials.html" title="class ChannelCredentials">ChannelCredentials</a></td><td class="paramname">$fallback_creds</td><td>The fallback credentials used if the channel target does not have the 'xds:///' scheme or if the xDS control plane does not provide information on how to fetch credentials dynamically. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="class_grpc_1_1_channel_credentials.html" title="class ChannelCredentials">ChannelCredentials</a> The xDS channel credentials object </dd></dl>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static Grpc\ChannelCredentials::invalidateDefaultRootsPem </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>free default roots pem, if it is set </p>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static Grpc\ChannelCredentials::isDefaultRootsPemSet </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>if default roots pem is set </p>
<dl class="section return"><dt>Returns</dt><dd>TRUE/FALSE </dd></dl>

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static Grpc\ChannelCredentials::setDefaultRootsPem </td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname"><em>$pem_roots</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Set default roots pem. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramtype">string</td><td class="paramname">$pem_roots</td><td>PEM encoding of the server root certificates </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>void </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_credentials_8php.html">ChannelCredentials.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>