aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/objective-c/GRPCClient/GRPCCall.h
diff options
context:
space:
mode:
authorGravatar Muxi Yan <mxyan@google.com>2017-09-11 15:48:51 -0700
committerGravatar Muxi Yan <mxyan@google.com>2017-09-11 15:48:51 -0700
commitf6e61bf7686bfce40d4f3912fd9eeb2ba6987e62 (patch)
tree5648dcdffd1d1e63c384d53acb6cb9b6062fdff2 /src/objective-c/GRPCClient/GRPCCall.h
parentafa47005015295e65b932403142938f9bb9b72fc (diff)
Add comment for timeout; assert on negative timeout value; fix timeout test
Diffstat (limited to 'src/objective-c/GRPCClient/GRPCCall.h')
-rw-r--r--src/objective-c/GRPCClient/GRPCCall.h4
1 files changed, 3 insertions, 1 deletions
diff --git a/src/objective-c/GRPCClient/GRPCCall.h b/src/objective-c/GRPCClient/GRPCCall.h
index 03552779d8..3b0ef56c3a 100644
--- a/src/objective-c/GRPCClient/GRPCCall.h
+++ b/src/objective-c/GRPCClient/GRPCCall.h
@@ -170,7 +170,9 @@ extern id const kGRPCTrailersKey;
@property (atomic, copy, readwrite) NSString *serverName;
/**
- * The timeout for the RPC call in milliseconds. If set to 0, the call will not timeout.
+ * The timeout for the RPC call in milliseconds. If set to 0, the call will not timeout. If set to
+ * positive, the gRPC call returns with status GRPCErrorCodeDeadlineExceeded. A negative value is
+ * not allowed.
*/
@property NSTimeInterval timeout;