aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/objective-c/GRPCClient/GRPCCallOptions.h
diff options
context:
space:
mode:
authorGravatar Muxi Yan <mxyan@google.com>2018-10-16 18:06:13 -0700
committerGravatar Muxi Yan <mxyan@google.com>2018-10-16 18:06:13 -0700
commit6032e960d43af5912d06553adc22012d3f7c758a (patch)
tree0bb91bf5166cadaa1efae31c0f63fcd2a5221dc9 /src/objective-c/GRPCClient/GRPCCallOptions.h
parent543fbf38c0ad1690558f7be3d1c58ff445a8714f (diff)
Polish channelID comments
Diffstat (limited to 'src/objective-c/GRPCClient/GRPCCallOptions.h')
-rw-r--r--src/objective-c/GRPCClient/GRPCCallOptions.h7
1 files changed, 5 insertions, 2 deletions
diff --git a/src/objective-c/GRPCClient/GRPCCallOptions.h b/src/objective-c/GRPCClient/GRPCCallOptions.h
index ff575d09cf..e1a63f83b2 100644
--- a/src/objective-c/GRPCClient/GRPCCallOptions.h
+++ b/src/objective-c/GRPCClient/GRPCCallOptions.h
@@ -41,6 +41,7 @@ typedef NS_ENUM(NSInteger, GRPCCompressAlgorithm) {
// The transport to be used by a gRPC call
typedef NS_ENUM(NSInteger, GRPCTransportType) {
+ GRPCTransportTypeDefault = 0,
// gRPC internal HTTP/2 stack with BoringSSL
GRPCTransportTypeChttp2BoringSSL = 0,
// Cronet stack
@@ -180,8 +181,10 @@ typedef NS_ENUM(NSInteger, GRPCTransportType) {
@property(copy, readonly) NSString *channelPoolDomain;
/**
- * Channel id allows a call to force creating a new channel (connection) rather than using a cached
- * channel. Calls using distinct channelID will not get cached to the same connection.
+ * Channel id allows control of channel caching within a channelPoolDomain. A call with a unique
+ * channelID will create a new channel (connection) instead of reusing an existing one. Multiple
+ * calls in the same channelPoolDomain using identical channelID are allowed to share connection
+ * if other channel options are also the same.
*/
@property(readonly) NSUInteger channelID;