GRPC C++  1.66.0
Public Member Functions | Protected Member Functions | Friends
grpc::CallCredentials Class Reference

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

Public Member Functions

 ~CallCredentials () override
 
bool ApplyToCall (grpc_call *call)
 Apply this instance's credentials to call. More...
 
grpc::string DebugString ()
 

Protected Member Functions

 CallCredentials (grpc_call_credentials *creds)
 

Friends

class CompositeCallCredentialsImpl
 
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::string grpc::testing::GetOauth2AccessToken ()
 

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::CallCredentials::~CallCredentials ( )
override

◆ CallCredentials()

grpc::CallCredentials::CallCredentials ( grpc_call_credentials creds)
explicitprotected

Member Function Documentation

◆ ApplyToCall()

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

Apply this instance's credentials to call.

◆ DebugString()

grpc::string grpc::CallCredentials::DebugString ( )

Friends And Related Function Documentation

◆ CompositeCallCredentialsImpl

friend class CompositeCallCredentialsImpl
friend

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

◆ grpc::testing::GetOauth2AccessToken

std::string grpc::testing::GetOauth2AccessToken ( )
friend

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