The configuration parameters for client connections. More...

#include <google/cloud/connection_options.h>

Public Types
using	BackgroundThreadsFactory = ::google::cloud::BackgroundThreadsFactory

Public Member Functions
	ConnectionOptions ()
	The default options, using `grpc::GoogleDefaultCredentials()`. More...

	ConnectionOptions (std::shared_ptr< grpc::ChannelCredentials > credentials)
	The default options, using an explicit credentials object. More...

ConnectionOptions &	set_credentials (std::shared_ptr< grpc::ChannelCredentials > v)
	Change the gRPC credentials value. More...

std::shared_ptr< grpc::ChannelCredentials >	credentials () const
	The gRPC credentials used by clients configured with this object. More...

ConnectionOptions &	set_endpoint (std::string v)
	Change the gRPC endpoint. More...

std::string const &	endpoint () const
	The endpoint used by clients configured with this object. More...

int	num_channels () const
	The number of transport channels to create. More...

ConnectionOptions &	set_num_channels (int num_channels)
	Set the value for `num_channels()`. More...

bool	tracing_enabled (std::string const &component) const
	Return whether tracing is enabled for the given `component`. More...

ConnectionOptions &	enable_tracing (std::string const &component)
	Enable tracing for `component` in clients configured with this object. More...

ConnectionOptions &	disable_tracing (std::string const &component)
	Disable tracing for `component` in clients configured with this object. More...

std::set< std::string > const &	components () const
	Return the set of tracing components. More...

TracingOptions const &	tracing_options () const
	Return the options for use when tracing RPCs. More...

std::string const &	channel_pool_domain () const
	Define the gRPC channel domain for clients configured with this object. More...

ConnectionOptions &	set_channel_pool_domain (std::string v)
	Set the value for `channel_pool_domain()`. More...

ConnectionOptions &	add_user_agent_prefix (std::string prefix)
	Prepend `prefix` to the user-agent string. More...

std::string const &	user_agent_prefix () const
	Return the current value for the user agent string. More...

grpc::ChannelArguments	CreateChannelArguments () const
	Create a new `grpc::ChannelArguments` configured with the options in this object. More...

ConnectionOptions &	set_background_thread_pool_size (std::size_t s)
	Set the number of background threads. More...

std::size_t	background_thread_pool_size () const

ConnectionOptions &	DisableBackgroundThreads (google::cloud::CompletionQueue const &cq)
	Configure the connection to use `cq` for all background work. More...

BackgroundThreadsFactory	background_threads_factory () const

Detailed Description

template<typename ConnectionTraits>
class google::cloud::ConnectionOptions< ConnectionTraits >

The configuration parameters for client connections.

Deprecated:: Use Options instead.

Definition at line 54 of file connection_options.h.

Member Typedef Documentation

◆ BackgroundThreadsFactory

template<typename ConnectionTraits >

using google::cloud::ConnectionOptions< ConnectionTraits >::BackgroundThreadsFactory = ::google::cloud::BackgroundThreadsFactory

Deprecated:: Prefer using google::cloud::BackgroundThreadsFactory.

Definition at line 330 of file connection_options.h.

Constructor & Destructor Documentation

◆ ConnectionOptions() [1/2]

template<typename ConnectionTraits >

google::cloud::ConnectionOptions< ConnectionTraits >::ConnectionOptions ( )

inline

The default options, using grpc::GoogleDefaultCredentials().

Deprecated:: Use Options instead.

Definition at line 61 of file connection_options.h.

◆ ConnectionOptions() [2/2]

template<typename ConnectionTraits >

google::cloud::ConnectionOptions< ConnectionTraits >::ConnectionOptions ( std::shared_ptr< grpc::ChannelCredentials > credentials )

inlineexplicit

The default options, using an explicit credentials object.

Deprecated:: Use Options instead.

Definition at line 68 of file connection_options.h.

Member Function Documentation

◆ add_user_agent_prefix()

template<typename ConnectionTraits >

ConnectionOptions& google::cloud::ConnectionOptions< ConnectionTraits >::add_user_agent_prefix ( std::string prefix )

inline

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

Definition at line 255 of file connection_options.h.

◆ background_thread_pool_size()

template<typename ConnectionTraits >

std::size_t google::cloud::ConnectionOptions< ConnectionTraits >::background_thread_pool_size ( ) const

inline

Deprecated:: Use Options and GrpcBackgroundThreadPoolSizeOption.

Definition at line 304 of file connection_options.h.

◆ background_threads_factory()

template<typename ConnectionTraits >

BackgroundThreadsFactory google::cloud::ConnectionOptions< ConnectionTraits >::background_threads_factory ( ) const

inline

Deprecated:: Not intended for applications to use.

There is no alternative implemented or planned.

Definition at line 337 of file connection_options.h.

◆ channel_pool_domain()

template<typename ConnectionTraits >

std::string const& google::cloud::ConnectionOptions< ConnectionTraits >::channel_pool_domain ( ) const

inline

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

Definition at line 230 of file connection_options.h.

◆ components()

template<typename ConnectionTraits >

std::set<std::string> const& google::cloud::ConnectionOptions< ConnectionTraits >::components ( ) const

inline

Return the set of tracing components.

Deprecated:: Use Options and TracingComponentsOption

Definition at line 197 of file connection_options.h.

◆ CreateChannelArguments()

template<typename ConnectionTraits >

grpc::ChannelArguments google::cloud::ConnectionOptions< ConnectionTraits >::CreateChannelArguments ( ) const

inline

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.

Definition at line 283 of file connection_options.h.

◆ credentials()

template<typename ConnectionTraits >

std::shared_ptr<grpc::ChannelCredentials> google::cloud::ConnectionOptions< ConnectionTraits >::credentials ( ) const

inline

The gRPC credentials used by clients configured with this object.

Deprecated:: Use Options and UnifiedCredentialsOption.

Definition at line 100 of file connection_options.h.

◆ disable_tracing()

template<typename ConnectionTraits >

ConnectionOptions& google::cloud::ConnectionOptions< ConnectionTraits >::disable_tracing ( std::string const & component )

inline

Disable tracing for component in clients configured with this object.

Deprecated:: Use Options and TracingComponentsOption

Definition at line 186 of file connection_options.h.

◆ DisableBackgroundThreads()

template<typename ConnectionTraits >

ConnectionOptions& google::cloud::ConnectionOptions< ConnectionTraits >::DisableBackgroundThreads ( google::cloud::CompletionQueue const & cq )

inline

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

Definition at line 321 of file connection_options.h.

◆ enable_tracing()

template<typename ConnectionTraits >

ConnectionOptions& google::cloud::ConnectionOptions< ConnectionTraits >::enable_tracing ( std::string const & component )

inline

Enable tracing for component in clients configured with this object.

Deprecated:: Use Options and TracingComponentsOption

Definition at line 175 of file connection_options.h.

◆ endpoint()

template<typename ConnectionTraits >

std::string const& google::cloud::ConnectionOptions< ConnectionTraits >::endpoint ( ) const

inline

The endpoint used by clients configured with this object.

Deprecated:: Use Options and EndpointOption.

Definition at line 127 of file connection_options.h.

◆ num_channels()

template<typename ConnectionTraits >

int google::cloud::ConnectionOptions< ConnectionTraits >::num_channels ( ) const

inline

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

Definition at line 142 of file connection_options.h.

◆ set_background_thread_pool_size()

template<typename ConnectionTraits >

ConnectionOptions& google::cloud::ConnectionOptions< ConnectionTraits >::set_background_thread_pool_size ( std::size_t s )

inline

Set the number of background threads.

Note: This value is not used if DisableBackgroundThreads() is called.

Deprecated:: Use Options and GrpcBackgroundThreadPoolSizeOption

Definition at line 296 of file connection_options.h.

◆ set_channel_pool_domain()

template<typename ConnectionTraits >

ConnectionOptions& google::cloud::ConnectionOptions< ConnectionTraits >::set_channel_pool_domain ( std::string v )

inline

Set the value for channel_pool_domain().

Deprecated:: Use Options and GrpcChannelsArgumentsOption

Definition at line 240 of file connection_options.h.

◆ set_credentials()

template<typename ConnectionTraits >

ConnectionOptions& google::cloud::ConnectionOptions< ConnectionTraits >::set_credentials ( std::shared_ptr< grpc::ChannelCredentials > v )

inline

Change the gRPC credentials value.

Deprecated:: Use Options and UnifiedCredentialsOption.

Definition at line 88 of file connection_options.h.

◆ set_endpoint()

template<typename ConnectionTraits >

ConnectionOptions& google::cloud::ConnectionOptions< ConnectionTraits >::set_endpoint ( std::string v )

inline

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.

Definition at line 116 of file connection_options.h.

◆ set_num_channels()

template<typename ConnectionTraits >

ConnectionOptions& google::cloud::ConnectionOptions< ConnectionTraits >::set_num_channels ( int num_channels )

inline

Set the value for num_channels().

Deprecated:: Use Options and GrpcNumChannelsOption

Definition at line 150 of file connection_options.h.

◆ tracing_enabled()

template<typename ConnectionTraits >

bool google::cloud::ConnectionOptions< ConnectionTraits >::tracing_enabled ( std::string const & component ) const

inline

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

Definition at line 165 of file connection_options.h.

◆ tracing_options()

template<typename ConnectionTraits >

TracingOptions const& google::cloud::ConnectionOptions< ConnectionTraits >::tracing_options ( ) const

inline

Return the options for use when tracing RPCs.

Deprecated:: Use Options and GrpcTracingOption

Definition at line 207 of file connection_options.h.

◆ user_agent_prefix()

template<typename ConnectionTraits >

std::string const& google::cloud::ConnectionOptions< ConnectionTraits >::user_agent_prefix ( ) const

inline

Return the current value for the user agent string.

Deprecated:: Use Options and UserAgentProductsOption.

Definition at line 268 of file connection_options.h.

Public Types

Public Member Functions

Detailed Description

template<typename ConnectionTraits> class google::cloud::ConnectionOptions< ConnectionTraits >

Member Typedef Documentation

◆ BackgroundThreadsFactory

Constructor & Destructor Documentation

◆ ConnectionOptions() [1/2]

◆ ConnectionOptions() [2/2]

Member Function Documentation

◆ add_user_agent_prefix()

◆ background_thread_pool_size()

◆ background_threads_factory()

◆ channel_pool_domain()

◆ components()

◆ CreateChannelArguments()

◆ credentials()

◆ disable_tracing()

◆ DisableBackgroundThreads()

◆ enable_tracing()

◆ endpoint()

◆ num_channels()

◆ set_background_thread_pool_size()

◆ set_channel_pool_domain()

◆ set_credentials()

◆ set_endpoint()

◆ set_num_channels()

◆ tracing_enabled()

◆ tracing_options()

◆ user_agent_prefix()

template<typename ConnectionTraits>
class google::cloud::ConnectionOptions< ConnectionTraits >