GRPC PHP  1.38.0
Static Public Member Functions
Grpc\ChannelCredentials Class Reference

class ChannelCredentials More...

Static Public Member Functions

static setDefaultRootsPem ($pem_roots)
 Set default roots pem. More...
 
static isDefaultRootsPemSet ()
 if default roots pem is set More...
 
static invalidateDefaultRootsPem ()
 free default roots pem, if it is set More...
 
static createDefault ()
 Create a default channel credentials object. More...
 
static createSsl ($pem_root_certs="", $private_key="", $cert_chain="")
 Create SSL credentials. More...
 
static createComposite ($cred1_obj, $cred2_obj)
 Create composite credentials from two existing credentials. More...
 
static createInsecure ()
 Create insecure channel credentials. More...
 
static createXds ($fallback_creds)
 Create XDS channel credentials. More...
 

Detailed Description

class ChannelCredentials

See also
https://github.com/grpc/grpc/tree/master/src/php/ext/grpc/channel_credentials.c

Member Function Documentation

◆ createComposite()

static Grpc\ChannelCredentials::createComposite (   $cred1_obj,
  $cred2_obj 
)
static

Create composite credentials from two existing credentials.

Parameters
ChannelCredentials$cred1_objThe first credential
CallCredentials$cred2_objThe second credential
Returns
ChannelCredentials The new composite credentials object

◆ createDefault()

static Grpc\ChannelCredentials::createDefault ( )
static

Create a default channel credentials object.

Returns
ChannelCredentials The new default channel credentials object

◆ createInsecure()

static Grpc\ChannelCredentials::createInsecure ( )
static

Create insecure channel credentials.

Returns
null

◆ createSsl()

static Grpc\ChannelCredentials::createSsl (   $pem_root_certs = "",
  $private_key = "",
  $cert_chain = "" 
)
static

Create SSL credentials.

Parameters
string$pem_root_certs= "" PEM encoding of the server root certificates (optional)
string$private_key= "" PEM encoding of the client's private key (optional)
string$cert_chain= "" PEM encoding of the client's certificate chain (optional)
Returns
ChannelCredentials The new SSL credentials object

◆ createXds()

static Grpc\ChannelCredentials::createXds (   $fallback_creds)
static

Create XDS channel credentials.

Parameters
ChannelCredentials$fallback_credsThe 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.
Returns
ChannelCredentials The xDS channel credentials object

◆ invalidateDefaultRootsPem()

static Grpc\ChannelCredentials::invalidateDefaultRootsPem ( )
static

free default roots pem, if it is set

◆ isDefaultRootsPemSet()

static Grpc\ChannelCredentials::isDefaultRootsPemSet ( )
static

if default roots pem is set

Returns
TRUE/FALSE

◆ setDefaultRootsPem()

static Grpc\ChannelCredentials::setDefaultRootsPem (   $pem_roots)
static

Set default roots pem.

Parameters
string$pem_rootsPEM encoding of the server root certificates
Returns
void

The documentation for this class was generated from the following file: