aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/objective-c/GRPCClient/private/GRPCChannel.h
diff options
context:
space:
mode:
authorGravatar Muxi Yan <mxyan@google.com>2018-10-19 17:56:42 -0700
committerGravatar Muxi Yan <mxyan@google.com>2018-10-19 17:57:04 -0700
commitb3cb4e17f76624e563e51165954ebaa6224d806c (patch)
tree48619b7220bc7d5f2cf08aaa4cf5eaf95e6692b3 /src/objective-c/GRPCClient/private/GRPCChannel.h
parent8cecb2a86dd5904c68f46d4b685b11c8cb0a8704 (diff)
Comment and rename GRPCChannel:ref and :unref
Diffstat (limited to 'src/objective-c/GRPCClient/private/GRPCChannel.h')
-rw-r--r--src/objective-c/GRPCClient/private/GRPCChannel.h14
1 files changed, 12 insertions, 2 deletions
diff --git a/src/objective-c/GRPCClient/private/GRPCChannel.h b/src/objective-c/GRPCClient/private/GRPCChannel.h
index 7a40638dc3..5f5fae0413 100644
--- a/src/objective-c/GRPCClient/private/GRPCChannel.h
+++ b/src/objective-c/GRPCClient/private/GRPCChannel.h
@@ -51,10 +51,20 @@ struct grpc_channel_credentials;
completionQueue:(nonnull GRPCCompletionQueue *)queue
callOptions:(nonnull GRPCCallOptions *)callOptions;
-- (void)unmanagedCallRef;
+/**
+ * Increase the refcount of the channel. If the channel was timed to be destroyed, cancel the timer.
+ */
+- (void)ref;
-- (void)unmanagedCallUnref;
+/**
+ * Decrease the refcount of the channel. If the refcount of the channel decrease to 0, start a timer
+ * to destroy the channel
+ */
+- (void)unref;
+/**
+ * Force the channel to be disconnected and destroyed immediately.
+ */
- (void)disconnect;
// TODO (mxyan): deprecate with GRPCCall:closeOpenConnections