Skip to content

Commit dd47583

Browse files
authored
doc: document when GrpcNumChannelsOption applies (#10000)
1 parent 7b98883 commit dd47583

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

google/cloud/grpc_options.h

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,13 @@ struct GrpcCredentialOption {
4141
* gRPC limits the number of simultaneous calls in progress on a channel to
4242
* 100. Increasing the number of channels thus increases the number of
4343
* operations that can be in progress in parallel.
44+
*
45+
* @note This option only applies when passed to the following functions:
46+
* - `bigtable::MakeDataConnection()`
47+
* - `pubsub::MakePublisherConnection()`
48+
* - `pubsub::MakeSubscriberConnection()`
49+
* - `spanner::MakeConnection()`
50+
* - `storage_experimental::DefaultGrpcClient()`
4451
*/
4552
struct GrpcNumChannelsOption {
4653
using Type = int;

0 commit comments

Comments
 (0)