GRPC C++  1.24.0
Public Member Functions | Protected Member Functions | Friends
grpc_impl::CallCredentials Class Referenceabstract

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

#include <credentials_impl.h>

Public Member Functions

 CallCredentials ()
 
 ~CallCredentials ()
 
virtual bool ApplyToCall (grpc_call *call)=0
 Apply this instance's credentials to call. More...
 

Protected Member Functions

virtual SecureCallCredentials * AsSecureCredentials ()=0
 

Friends

std::shared_ptr< ChannelCredentialsCompositeChannelCredentials (const std::shared_ptr< ChannelCredentials > &channel_creds, const std::shared_ptr< CallCredentials > &call_creds)
 Combines a channel credentials and a call credentials into a composite channel credentials. More...
 
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...
 

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

Constructor & Destructor Documentation

◆ CallCredentials()

grpc_impl::CallCredentials::CallCredentials ( )

◆ ~CallCredentials()

grpc_impl::CallCredentials::~CallCredentials ( )

Member Function Documentation

◆ ApplyToCall()

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

Apply this instance's credentials to call.

◆ AsSecureCredentials()

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

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.

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


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