Public Member Functions | Protected Member Functions | Private Attributes | Friends | List of all members
grpc::CallCredentials Class Referenceabstract

#include <credentials.h>

Inheritance diagram for grpc::CallCredentials:
Inheritance graph
[legend]

Public Member Functions

def __init__ (self, credentials)
 
virtual bool ApplyToCall (grpc_call *call)=0
 Apply this instance's credentials to call. More...
 
 CallCredentials ()
 
virtual grpc::string DebugString ()
 
 ~CallCredentials () override
 

Protected Member Functions

virtual SecureCallCredentialsAsSecureCredentials ()=0
 

Private Attributes

 _credentials
 

Friends

std::shared_ptr< CallCredentialsCompositeCallCredentials (const std::shared_ptr< CallCredentials > &creds1, const std::shared_ptr< CallCredentials > &creds2)
 Combines two call credentials objects into a composite call credentials. More...
 
std::shared_ptr< ChannelCredentialsCompositeChannelCredentials (const std::shared_ptr< ChannelCredentials > &channel_creds, const std::shared_ptr< CallCredentials > &call_creds)
 

Additional Inherited Members

- Private Member Functions inherited from grpc::GrpcLibraryCodegen
 GrpcLibraryCodegen (bool call_grpc_init=true)
 
virtual ~GrpcLibraryCodegen ()
 

Detailed Description

A call credentials object encapsulates the state needed by a client to authenticate with a server for a given call on a channel.

See also
https://grpc.io/docs/guides/auth.html
An encapsulation of the data required to assert an identity over a call.

A CallCredentials has to be used with secure Channel, otherwise the
metadata will not be transmitted to the server.

A CallCredentials may be composed with ChannelCredentials to always assert
identity for every call over that 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.

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

Constructor & Destructor Documentation

◆ CallCredentials()

grpc::CallCredentials::CallCredentials ( )

Definition at line 29 of file credentials_cc.cc.

◆ ~CallCredentials()

grpc::CallCredentials::~CallCredentials ( )
override

Definition at line 31 of file credentials_cc.cc.

◆ __init__()

def grpc.CallCredentials.__init__ (   self,
  credentials 
)

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

Member Function Documentation

◆ ApplyToCall()

virtual bool grpc::CallCredentials::ApplyToCall ( grpc_call call)
pure virtual

Apply this instance's credentials to call.

Implemented in grpc::SecureCallCredentials.

◆ AsSecureCredentials()

virtual SecureCallCredentials* grpc::CallCredentials::AsSecureCredentials ( )
protectedpure virtual

Implemented in grpc::SecureCallCredentials.

◆ DebugString()

virtual grpc::string grpc::CallCredentials::DebugString ( )
inlinevirtual

Reimplemented in grpc::SecureCallCredentials.

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

Friends And Related Function Documentation

◆ CompositeCallCredentials

std::shared_ptr<CallCredentials> CompositeCallCredentials ( const std::shared_ptr< CallCredentials > &  creds1,
const std::shared_ptr< CallCredentials > &  creds2 
)
friend

Combines two call credentials objects into a composite call credentials.

Definition at line 392 of file secure_credentials.cc.

◆ 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.

Member Data Documentation

◆ _credentials

grpc.CallCredentials._credentials
private

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


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


grpc
Author(s):
autogenerated on Fri May 16 2025 03:03:30