GRPC C++  1.0.0
Data Structures | Public Member Functions | Friends
grpc::ChannelArguments Class Reference

Options for channel creation. More...

#include <channel_arguments.h>

Public Member Functions

 ChannelArguments ()
 
 ~ChannelArguments ()
 
 ChannelArguments (const ChannelArguments &other)
 
ChannelArgumentsoperator= (ChannelArguments other)
 
void Swap (ChannelArguments &other)
 
void SetChannelArgs (grpc_channel_args *channel_args) const
 Dump arguments in this instance to channel_args. More...
 
void SetSslTargetNameOverride (const grpc::string &name)
 Set target name override for SSL host name checking. More...
 
void SetCompressionAlgorithm (grpc_compression_algorithm algorithm)
 Set the compression algorithm for the channel. More...
 
void SetUserAgentPrefix (const grpc::string &user_agent_prefix)
 The given string will be sent at the front of the user agent string. More...
 
void SetInt (const grpc::string &key, int value)
 Set an integer argument value under key. More...
 
void SetPointer (const grpc::string &key, void *value)
 Set a pointer argument value under key. Owership is not transferred. More...
 
void SetString (const grpc::string &key, const grpc::string &value)
 Set a textual argument value under key. More...
 

Friends

class SecureChannelCredentials
 
class testing::ChannelArgumentsTest
 

Detailed Description

Options for channel creation.

The user can use generic setters to pass key value pairs down to c channel creation code. For grpc related options, concrete setters are provided.

Constructor & Destructor Documentation

grpc::ChannelArguments::ChannelArguments ( )
grpc::ChannelArguments::~ChannelArguments ( )
inline
grpc::ChannelArguments::ChannelArguments ( const ChannelArguments other)

Member Function Documentation

ChannelArguments& grpc::ChannelArguments::operator= ( ChannelArguments  other)
inline
void grpc::ChannelArguments::SetChannelArgs ( grpc_channel_args channel_args) const

Dump arguments in this instance to channel_args.

Does not take ownership of channel_args.

Note that the underlying arguments are shared. Changes made to either channel_args or this instance would be reflected on both.

void grpc::ChannelArguments::SetCompressionAlgorithm ( grpc_compression_algorithm  algorithm)

Set the compression algorithm for the channel.

void grpc::ChannelArguments::SetInt ( const grpc::string key,
int  value 
)

Set an integer argument value under key.

void grpc::ChannelArguments::SetPointer ( const grpc::string key,
void *  value 
)

Set a pointer argument value under key. Owership is not transferred.

void grpc::ChannelArguments::SetSslTargetNameOverride ( const grpc::string name)

Set target name override for SSL host name checking.

This option is for testing only and should never be used in production.

void grpc::ChannelArguments::SetString ( const grpc::string key,
const grpc::string value 
)

Set a textual argument value under key.

void grpc::ChannelArguments::SetUserAgentPrefix ( const grpc::string user_agent_prefix)

The given string will be sent at the front of the user agent string.

void grpc::ChannelArguments::Swap ( ChannelArguments other)

Friends And Related Function Documentation

friend class SecureChannelCredentials
friend
friend class testing::ChannelArgumentsTest
friend

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