diff options
| author |  Alexander Polcyn <apolcyn@google.com> | 2017-07-28 14:53:20 -0700 |
|---|---|---|
| committer | Alexander Polcyn <apolcyn@google.com> | 2017-07-28 16:07:16 -0700 |
| commit | 088e85ca647ffecc06ca961933d7532ed75d1b8d (patch) | |
| tree | 04abde6666609b58751420344960d2ab181b9f36 /include/grpc/grpc.h | |
| parent | 8dc1b7db51c49869ab24404bc810500db51fc86d (diff) | |
add comment and test for memory api of grpc_call_cancel_with_status
Diffstat (limited to 'include/grpc/grpc.h')
| -rw-r--r-- | include/grpc/grpc.h | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/include/grpc/grpc.h b/include/grpc/grpc.h index 2cf8de0a2d..943d6e4891 100644 --- a/include/grpc/grpc.h +++ b/include/grpc/grpc.h @@ -296,7 +296,11 @@ GRPCAPI grpc_call_error grpc_call_cancel(grpc_call *call, void *reserved); If a status has not been received for the call, set it to the status code and description passed in. Importantly, this function does not send status nor description to the - remote endpoint. */ + remote endpoint. + Note that \a description doesn't need be a static string. + It doesn't need to be alive after the call to + grpc_call_cancel_with_status completes. + */ GRPCAPI grpc_call_error grpc_call_cancel_with_status(grpc_call *call, grpc_status_code status, const char *description, |