Public Types | Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
grpc::experimental::ClientRpcInfo Class Reference

#include <client_interceptor.h>

Public Types

enum  Type {
  Type::UNARY, Type::CLIENT_STREAMING, Type::SERVER_STREAMING, Type::BIDI_STREAMING,
  Type::UNKNOWN
}
 Type categorizes RPCs by unary or streaming type. More...
 

Public Member Functions

ChannelInterfacechannel ()
 Return a pointer to the channel on which the RPC is being sent. More...
 
grpc::ClientContextclient_context ()
 
 ClientRpcInfo (ClientRpcInfo &&)=default
 
 ClientRpcInfo (const ClientRpcInfo &)=delete
 
const char * method () const
 Return the fully-specified method name. More...
 
const char * suffix_for_stats () const
 
Type type () const
 Return the type of the RPC (unary or a streaming flavor) More...
 
 ~ClientRpcInfo ()
 

Private Member Functions

 ClientRpcInfo ()=default
 
 ClientRpcInfo (grpc::ClientContext *ctx, internal::RpcMethod::RpcType type, const char *method, const char *suffix_for_stats, grpc::ChannelInterface *channel)
 
ClientRpcInfooperator= (ClientRpcInfo &&)=default
 
void RegisterInterceptors (const std::vector< std::unique_ptr< experimental::ClientInterceptorFactoryInterface >> &creators, size_t interceptor_pos)
 
void RunInterceptor (experimental::InterceptorBatchMethods *interceptor_methods, size_t pos)
 

Private Attributes

grpc::ChannelInterfacechannel_ = nullptr
 
grpc::ClientContextctx_ = nullptr
 
bool hijacked_ = false
 
size_t hijacked_interceptor_ = 0
 
std::vector< std::unique_ptr< experimental::Interceptor > > interceptors_
 
const char * method_ = nullptr
 
const char * suffix_for_stats_ = nullptr
 
Type type_ {Type::UNKNOWN}
 

Friends

class grpc::ClientContext
 
class internal::InterceptorBatchMethodsImpl
 

Detailed Description

Definition at line 68 of file impl/codegen/client_interceptor.h.

Member Enumeration Documentation

◆ Type

Type categorizes RPCs by unary or streaming type.

Enumerator
UNARY 
CLIENT_STREAMING 
SERVER_STREAMING 
BIDI_STREAMING 
UNKNOWN 

Definition at line 73 of file impl/codegen/client_interceptor.h.

Constructor & Destructor Documentation

◆ ~ClientRpcInfo()

grpc::experimental::ClientRpcInfo::~ClientRpcInfo ( )
inline

Definition at line 81 of file impl/codegen/client_interceptor.h.

◆ ClientRpcInfo() [1/4]

grpc::experimental::ClientRpcInfo::ClientRpcInfo ( const ClientRpcInfo )
delete

◆ ClientRpcInfo() [2/4]

grpc::experimental::ClientRpcInfo::ClientRpcInfo ( ClientRpcInfo &&  )
default

◆ ClientRpcInfo() [3/4]

grpc::experimental::ClientRpcInfo::ClientRpcInfo ( )
privatedefault

◆ ClientRpcInfo() [4/4]

grpc::experimental::ClientRpcInfo::ClientRpcInfo ( grpc::ClientContext ctx,
internal::RpcMethod::RpcType  type,
const char *  method,
const char *  suffix_for_stats,
grpc::ChannelInterface channel 
)
inlineprivate

Definition at line 124 of file impl/codegen/client_interceptor.h.

Member Function Documentation

◆ channel()

ChannelInterface* grpc::experimental::ClientRpcInfo::channel ( )
inline

Return a pointer to the channel on which the RPC is being sent.

Definition at line 97 of file impl/codegen/client_interceptor.h.

◆ client_context()

grpc::ClientContext* grpc::experimental::ClientRpcInfo::client_context ( )
inline

Return a pointer to the underlying ClientContext structure associated with the RPC to support features that apply to it

Definition at line 101 of file impl/codegen/client_interceptor.h.

◆ method()

const char* grpc::experimental::ClientRpcInfo::method ( ) const
inline

Return the fully-specified method name.

Definition at line 90 of file impl/codegen/client_interceptor.h.

◆ operator=()

ClientRpcInfo& grpc::experimental::ClientRpcInfo::operator= ( ClientRpcInfo &&  )
privatedefault

◆ RegisterInterceptors()

void grpc::experimental::ClientRpcInfo::RegisterInterceptors ( const std::vector< std::unique_ptr< experimental::ClientInterceptorFactoryInterface >> &  creators,
size_t  interceptor_pos 
)
inlineprivate

Definition at line 144 of file impl/codegen/client_interceptor.h.

◆ RunInterceptor()

void grpc::experimental::ClientRpcInfo::RunInterceptor ( experimental::InterceptorBatchMethods interceptor_methods,
size_t  pos 
)
inlineprivate

Definition at line 138 of file impl/codegen/client_interceptor.h.

◆ suffix_for_stats()

const char* grpc::experimental::ClientRpcInfo::suffix_for_stats ( ) const
inline

Return an identifying suffix for the client stub, or nullptr if one wasn't specified.

Definition at line 94 of file impl/codegen/client_interceptor.h.

◆ type()

Type grpc::experimental::ClientRpcInfo::type ( ) const
inline

Return the type of the RPC (unary or a streaming flavor)

Definition at line 104 of file impl/codegen/client_interceptor.h.

Friends And Related Function Documentation

◆ grpc::ClientContext

friend class grpc::ClientContext
friend

Definition at line 180 of file impl/codegen/client_interceptor.h.

◆ internal::InterceptorBatchMethodsImpl

Definition at line 179 of file impl/codegen/client_interceptor.h.

Member Data Documentation

◆ channel_

grpc::ChannelInterface* grpc::experimental::ClientRpcInfo::channel_ = nullptr
private

Definition at line 174 of file impl/codegen/client_interceptor.h.

◆ ctx_

grpc::ClientContext* grpc::experimental::ClientRpcInfo::ctx_ = nullptr
private

Definition at line 169 of file impl/codegen/client_interceptor.h.

◆ hijacked_

bool grpc::experimental::ClientRpcInfo::hijacked_ = false
private

Definition at line 176 of file impl/codegen/client_interceptor.h.

◆ hijacked_interceptor_

size_t grpc::experimental::ClientRpcInfo::hijacked_interceptor_ = 0
private

Definition at line 177 of file impl/codegen/client_interceptor.h.

◆ interceptors_

std::vector<std::unique_ptr<experimental::Interceptor> > grpc::experimental::ClientRpcInfo::interceptors_
private

Definition at line 175 of file impl/codegen/client_interceptor.h.

◆ method_

const char* grpc::experimental::ClientRpcInfo::method_ = nullptr
private

Definition at line 172 of file impl/codegen/client_interceptor.h.

◆ suffix_for_stats_

const char* grpc::experimental::ClientRpcInfo::suffix_for_stats_ = nullptr
private

Definition at line 173 of file impl/codegen/client_interceptor.h.

◆ type_

Type grpc::experimental::ClientRpcInfo::type_ {Type::UNKNOWN}
private

Definition at line 171 of file impl/codegen/client_interceptor.h.


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


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