The configuration parameters for client connections.
DeprecatedUse Options instead.
Constructors
ConnectionOptions
The default options, using grpc::GoogleDefaultCredentials().
DeprecatedUse Options instead.
ConnectionOptions
The default options, using an explicit credentials object.
DeprecatedUse Options instead.
| Parameter | |
|---|---|
| Name | Description |
credentials |
std::shared_ptr< grpc::ChannelCredentials >
|
Functions
set_credentials
Change the gRPC credentials value.
DeprecatedUse Options and UnifiedCredentialsOption.
| Parameter | |
|---|---|
| Name | Description |
v |
std::shared_ptr< grpc::ChannelCredentials >
|
| Returns | |
|---|---|
| Type | Description |
ConnectionOptions & |
|
credentials
The gRPC credentials used by clients configured with this object.
DeprecatedUse Options and UnifiedCredentialsOption.
| Returns | |
|---|---|
| Type | Description |
std::shared_ptr< grpc::ChannelCredentials > |
|
set_endpoint
Change the gRPC endpoint.
In almost all cases the default is the correct endpoint to use. Applications may need to be changed to (1) test against a fake or simulator, or (2) to use a beta or EAP version of the service.
The default value is set by ConnectionTraits::default_endpoint().
Deprecated
Use Options and EndpointOption.
| Parameter | |
|---|---|
| Name | Description |
v |
std::string
|
| Returns | |
|---|---|
| Type | Description |
ConnectionOptions & |
|
endpoint
The endpoint used by clients configured with this object.
DeprecatedUse Options and EndpointOption.
| Returns | |
|---|---|
| Type | Description |
std::string const & |
|
num_channels
The number of transport channels to create.
Some transports limit the number of simultaneous calls in progress on a channel (for gRPC the limit is 100). Increasing the number of channels thus increases the number of operations that can be in progress in parallel.
The default value is set by ConnectionTraits::default_num_channels().
Deprecated
Use Options and GrpcNumChannelsOption
| Returns | |
|---|---|
| Type | Description |
int |
|
set_num_channels
Set the value for num_channels().
DeprecatedUse Options and GrpcNumChannelsOption
| Parameter | |
|---|---|
| Name | Description |
num_channels |
int
|
| Returns | |
|---|---|
| Type | Description |
ConnectionOptions & |
|
tracing_enabled
Return whether tracing is enabled for the given component.
The C++ clients can log interesting events to help library and application developers troubleshoot problems. This flag returns true if tracing should be enabled by clients configured with this option.
Deprecated
Use Options and TracingComponentsOption
| Parameter | |
|---|---|
| Name | Description |
component |
std::string const &
|
| Returns | |
|---|---|
| Type | Description |
bool |
|
enable_tracing
Enable tracing for component in clients configured with this object.
DeprecatedUse Options and TracingComponentsOption
| Parameter | |
|---|---|
| Name | Description |
component |
std::string const &
|
| Returns | |
|---|---|
| Type | Description |
ConnectionOptions & |
|
disable_tracing
Disable tracing for component in clients configured with this object.
DeprecatedUse Options and TracingComponentsOption
| Parameter | |
|---|---|
| Name | Description |
component |
std::string const &
|
| Returns | |
|---|---|
| Type | Description |
ConnectionOptions & |
|
components
Return the set of tracing components.
DeprecatedUse Options and TracingComponentsOption
| Returns | |
|---|---|
| Type | Description |
std::set< std::string > const & |
|
tracing_options
Return the options for use when tracing RPCs.
DeprecatedUse Options and GrpcTracingOption
| Returns | |
|---|---|
| Type | Description |
TracingOptions const & |
|
channel_pool_domain
Define the gRPC channel domain for clients configured with this object.
In some cases applications may want to use a separate gRPC connections for different clients. gRPC may share the connection used by separate channels created with the same configuration. The client objects created with this object will create gRPC channels configured with grpc.channel_pooling_domain set to the value returned by channel_pool_domain(). gRPC channels with different values for grpc.channel_pooling_domain are guaranteed to use different connections. Note that there is no guarantee that channels with the same value will have the same connection though.
This option might be useful for applications that want to segregate traffic for whatever reason.
Deprecated
Use Options and GrpcChannelsArgumentsOption
| Returns | |
|---|---|
| Type | Description |
std::string const & |
|
set_channel_pool_domain
Set the value for channel_pool_domain().
DeprecatedUse Options and GrpcChannelsArgumentsOption
| Parameter | |
|---|---|
| Name | Description |
v |
std::string
|
| Returns | |
|---|---|
| Type | Description |
ConnectionOptions & |
|
add_user_agent_prefix
Prepend prefix to the user-agent string.
Libraries or services that use Cloud C++ clients may want to set their own user-agent prefix. This can help them develop telemetry information about number of users running particular versions of their system or library.
Deprecated
Use Options and UserAgentProductsOption
| Parameter | |
|---|---|
| Name | Description |
prefix |
std::string
|
| Returns | |
|---|---|
| Type | Description |
ConnectionOptions & |
|
user_agent_prefix
Return the current value for the user agent string.
DeprecatedUse Options and UserAgentProductsOption.
| Returns | |
|---|---|
| Type | Description |
std::string const & |
|
CreateChannelArguments
Create a new grpc::ChannelArguments configured with the options in this object.
The caller would typically pass this argument to grpc::CreateCustomChannel and create one more more gRPC channels.
Deprecated
Not intended for use in application code. There is no alternative implemented or planned.
| Returns | |
|---|---|
| Type | Description |
grpc::ChannelArguments |
|
set_background_thread_pool_size
Set the number of background threads.
Note: This value is not used if
DisableBackgroundThreads()is called.DeprecatedUseOptionsandGrpcBackgroundThreadPoolSizeOption
| Parameter | |
|---|---|
| Name | Description |
s |
std::size_t
|
| Returns | |
|---|---|
| Type | Description |
ConnectionOptions & |
|
background_thread_pool_size
DeprecatedUse Options and GrpcBackgroundThreadPoolSizeOption.
| Returns | |
|---|---|
| Type | Description |
std::size_t |
|
DisableBackgroundThreads
Configure the connection to use cq for all background work.
Connections need to perform background work on behalf of the application. Normally they just create a background thread and a CompletionQueue for this work, but the application may need more fine-grained control of their threads. In this case the application can provide the CompletionQueue and it assumes responsibility for creating one or more threads blocked on CompletionQueue::Run().
Deprecated
Use Options and GrpcCompletionQueueOption
| Parameter | |
|---|---|
| Name | Description |
cq |
google::cloud::CompletionQueue const &
|
| Returns | |
|---|---|
| Type | Description |
ConnectionOptions & |
|
background_threads_factory
DeprecatedNot intended for applications to use. There is no alternative implemented or planned.
| Returns | |
|---|---|
| Type | Description |
BackgroundThreadsFactory |
|