grpc::ChannelCredentials Class Reference

#include <credentials.h>

Inheritance diagram for grpc::ChannelCredentials:

Public Member Functions
def	__init__ (self, credentials)
	ChannelCredentials ()
	~ChannelCredentials () override

Protected Member Functions
virtual SecureChannelCredentials *	AsSecureCredentials ()=0

Private Member Functions
virtual std::shared_ptr< Channel >	CreateChannelImpl (const grpc::string &target, const ChannelArguments &args)=0
virtual std::shared_ptr< Channel >	CreateChannelWithInterceptors (const grpc::string &, const ChannelArguments &, std::vector< std::unique_ptr< grpc::experimental::ClientInterceptorFactoryInterface >>)
virtual bool	IsInsecure () const
Private Member Functions inherited from grpc::GrpcLibraryCodegen
	GrpcLibraryCodegen (bool call_grpc_init=true)
virtual	~GrpcLibraryCodegen ()

Private Attributes
	_credentials

Friends
std::shared_ptr< ChannelCredentials >	CompositeChannelCredentials (const std::shared_ptr< ChannelCredentials > &channel_creds, const std::shared_ptr< CallCredentials > &call_creds)
std::shared_ptr< grpc::Channel >	CreateCustomChannel (const grpc::string &target, const std::shared_ptr< grpc::ChannelCredentials > &creds, const grpc::ChannelArguments &args)
std::shared_ptr< grpc::Channel >	grpc::experimental::CreateCustomChannelWithInterceptors (const grpc::string &target, const std::shared_ptr< grpc::ChannelCredentials > &creds, const grpc::ChannelArguments &args, std::vector< std::unique_ptr< grpc::experimental::ClientInterceptorFactoryInterface >> interceptor_creators)
std::shared_ptr< ChannelCredentials >	grpc::XdsCredentials (const std::shared_ptr< ChannelCredentials > &fallback_creds)

Detailed Description

A channel credentials object encapsulates all the state needed by a client to authenticate with a server for a given channel. It can make various assertions, e.g., about the client’s identity, role for all the calls on that channel.

See also

https://grpc.io/docs/guides/auth.html

An encapsulation of the data required to create a secure Channel.

This class has no supported interface - it exists to define the type of its
instances and its instances exist to be passed to other functions. For
example, ssl_channel_credentials returns an instance of this class and
secure_channel requires an instance of this class.

Definition at line 75 of file include/grpcpp/security/credentials.h.

Constructor & Destructor Documentation

ChannelCredentials()

grpc::ChannelCredentials::ChannelCredentials

(

)

Definition at line 25 of file credentials_cc.cc.

~ChannelCredentials()

grpc::ChannelCredentials::~ChannelCredentials ( )

override

Definition at line 27 of file credentials_cc.cc.

__init__()

def grpc.ChannelCredentials.__init__	(		self,
			credentials
	)

Definition at line 574 of file src/python/grpcio/grpc/__init__.py.

Member Function Documentation

AsSecureCredentials()

virtual SecureChannelCredentials* grpc::ChannelCredentials::AsSecureCredentials ( )

protectedpure virtual

Implemented in grpc::SecureChannelCredentials, and grpc::CronetChannelCredentialsImpl.

CreateChannelImpl()

virtual std::shared_ptr<Channel> grpc::ChannelCredentials::CreateChannelImpl ( const grpc::string &  target, const ChannelArguments &  args  )

privatepure virtual

Implemented in grpc::CronetChannelCredentialsImpl.

CreateChannelWithInterceptors()

virtual std::shared_ptr<Channel> grpc::ChannelCredentials::CreateChannelWithInterceptors ( const grpc::string &  , const ChannelArguments &  , std::vector< std::unique_ptr< grpc::experimental::ClientInterceptorFactoryInterface >>    )

inlineprivatevirtual

Definition at line 114 of file include/grpcpp/security/credentials.h.

IsInsecure()

virtual bool grpc::ChannelCredentials::IsInsecure ( ) const

inlineprivatevirtual

Definition at line 125 of file include/grpcpp/security/credentials.h.

Friends And Related Function Documentation

CompositeChannelCredentials

std::shared_ptr<ChannelCredentials> CompositeChannelCredentials ( const std::shared_ptr< ChannelCredentials > &  channel_creds, const std::shared_ptr< CallCredentials > &  call_creds  )

friend

Combines a channel credentials and a call credentials into a composite channel credentials.

Definition at line 373 of file secure_credentials.cc.

CreateCustomChannel

std::shared_ptr<grpc::Channel> CreateCustomChannel ( const grpc::string &  target, const std::shared_ptr< grpc::ChannelCredentials > &  creds, const grpc::ChannelArguments &  args  )

friend

Definition at line 43 of file create_channel.cc.

grpc::experimental::CreateCustomChannelWithInterceptors

std::shared_ptr<grpc::Channel> grpc::experimental::CreateCustomChannelWithInterceptors ( const grpc::string &  target, const std::shared_ptr< grpc::ChannelCredentials > &  creds, const grpc::ChannelArguments &  args, std::vector< std::unique_ptr< grpc::experimental::ClientInterceptorFactoryInterface >>  interceptor_creators  )

friend

grpc::XdsCredentials

std::shared_ptr<ChannelCredentials> grpc::XdsCredentials ( const std::shared_ptr< ChannelCredentials > &  fallback_creds )

friend

Member Data Documentation

_credentials

grpc.ChannelCredentials._credentials

private

Definition at line 575 of file src/python/grpcio/grpc/__init__.py.

---

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

• include/grpcpp/security/credentials.h
• src/python/grpcio/grpc/__init__.py
• credentials_cc.cc