diff options
| author |  Muxi Yan <mxyan@google.com> | 2018-10-19 09:50:33 -0700 |
|---|---|---|
| committer | Muxi Yan <mxyan@google.com> | 2018-10-19 09:50:33 -0700 |
| commit | 2a9efc3d1f0ddb42d0797dee5f82ca7abedc0936 (patch) | |
| tree | b2cd5405ef27ae85a64250a0eedd1db5e3a6c40c /src/objective-c/ProtoRPC/ProtoRPC.h | |
| parent | 75f8727a3e35ac3db8a3957d9318f2dfdd798e7f (diff) | |
polish cancel message of proto calls
Diffstat (limited to 'src/objective-c/ProtoRPC/ProtoRPC.h')
| -rw-r--r-- | src/objective-c/ProtoRPC/ProtoRPC.h | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/src/objective-c/ProtoRPC/ProtoRPC.h b/src/objective-c/ProtoRPC/ProtoRPC.h index f2ba513495..663c1610bc 100644 --- a/src/objective-c/ProtoRPC/ProtoRPC.h +++ b/src/objective-c/ProtoRPC/ProtoRPC.h @@ -71,7 +71,11 @@ callOptions:(GRPCCallOptions *)callOptions responseClass:(Class)responseClass NS_DESIGNATED_INITIALIZER; -/** Cancel the call at best effort. */ +/** + * Cancel the request of this call at best effort. It attempts to notify the server that the RPC + * should be cancelled, and issue closedWithTrailingMetadata:error: callback with error code + * CANCELED if no other error code has already been issued. + */ - (void)cancel; @end @@ -92,7 +96,11 @@ callOptions:(GRPCCallOptions *)callOptions responseClass:(Class)responseClass NS_DESIGNATED_INITIALIZER; -/** Cancel the call at best effort. */ +/** + * Cancel the request of this call at best effort. It attempts to notify the server that the RPC + * should be cancelled, and issue closedWithTrailingMetadata:error: callback with error code + * CANCELED if no other error code has already been issued. + */ - (void)cancel; /** |