From ef830758cc90924e9fdd5be6a451774fad326db0 Mon Sep 17 00:00:00 2001 From: Muxi Yan Date: Sat, 20 Oct 2018 09:50:36 -0700 Subject: [PATCH] Comments to methods of GRPCChannelConfiguration --- src/objective-c/GRPCClient/private/GRPCChannelPool.h | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/src/objective-c/GRPCClient/private/GRPCChannelPool.h b/src/objective-c/GRPCClient/private/GRPCChannelPool.h index e9c2ef2bd14..43e07b98454 100644 --- a/src/objective-c/GRPCClient/private/GRPCChannelPool.h +++ b/src/objective-c/GRPCClient/private/GRPCChannelPool.h @@ -29,12 +29,22 @@ NS_ASSUME_NONNULL_BEGIN @class GRPCChannel; +/** Caching signature of a channel. */ @interface GRPCChannelConfiguration : NSObject +/** The host that this channel is connected to. */ @property(copy, readonly) NSString *host; + +/** + * Options of the corresponding call. Note that only the channel-related options are of interest to + * this class. + */ @property(strong, readonly) GRPCCallOptions *callOptions; +/** Acquire the factory to generate a new channel with current configurations. */ @property(readonly) id channelFactory; + +/** Acquire the dictionary of channel args with current configurations. */ @property(readonly) NSDictionary *channelArgs; - (nullable instancetype)initWithHost:(NSString *)host callOptions:(GRPCCallOptions *)callOptions;