diff options
author | Muxi Yan <mxyan@google.com> | 2018-02-22 14:54:42 -0800 |
---|---|---|
committer | Muxi Yan <mxyan@google.com> | 2018-02-22 14:59:17 -0800 |
commit | 1a6d3a529be65d3f75e02f522ee0c77025191fb2 (patch) | |
tree | 38f22dfeb4bb5abea710891cf7d487433965f77f | |
parent | 3e440f3500e0e2b992cb4c242851c591b47d4f4d (diff) |
Add comments to the interface
-rw-r--r-- | include/grpc/impl/codegen/grpc_types.h | 2 | ||||
-rw-r--r-- | src/objective-c/GRPCClient/GRPCCall+MobileLog.h | 8 |
2 files changed, 8 insertions, 2 deletions
diff --git a/include/grpc/impl/codegen/grpc_types.h b/include/grpc/impl/codegen/grpc_types.h index 85106cad10..7d31095c91 100644 --- a/include/grpc/impl/codegen/grpc_types.h +++ b/include/grpc/impl/codegen/grpc_types.h @@ -309,6 +309,8 @@ typedef struct { Defaults to "blend". In the current implementation "blend" is equivalent to "latency". */ #define GRPC_ARG_OPTIMIZATION_TARGET "grpc.optimization_target" +/** Channel arg that carries the bridged objective c object for custom metrics + * logging filter. */ #define GRPC_ARG_MOBILE_LOG_CONFIG "grpc.mobile_log_config" /** \} */ diff --git a/src/objective-c/GRPCClient/GRPCCall+MobileLog.h b/src/objective-c/GRPCClient/GRPCCall+MobileLog.h index 7ccc140084..53b347d9ca 100644 --- a/src/objective-c/GRPCClient/GRPCCall+MobileLog.h +++ b/src/objective-c/GRPCClient/GRPCCall+MobileLog.h @@ -16,11 +16,15 @@ * */ -// Set the log config object to be passed to channels as channel arg. -// The setting is only effective to channels created after setLogConfig. #import "GRPCCall.h" @interface GRPCCall (MobileLog) +// Set the object to be passed down along channel stack with channel arg +// GRPC_ARG_MOBILE_LOG_CONFIG. The setting may be used by custom channel +// filters for metrics logging. + (void)setLogConfig:(id)logConfig; + +// Obtain the object to be passed down along channel stack with channel arg +// GRPC_ARG_MOBILE_LOG_CONFIG. + (id)logConfig; @end |