diff options
Diffstat (limited to 'include/grpc++/impl/codegen/client_context.h')
| -rw-r--r-- | include/grpc++/impl/codegen/client_context.h | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/include/grpc++/impl/codegen/client_context.h b/include/grpc++/impl/codegen/client_context.h index 61d97ce818..38cce27b99 100644 --- a/include/grpc++/impl/codegen/client_context.h +++ b/include/grpc++/impl/codegen/client_context.h @@ -289,7 +289,9 @@ class ClientContext { creds_ = creds; } - /// Return the compression algorithm to be used by the client call. + /// Return the compression algorithm the client call will request be used. + /// Note that the gRPC runtime may decide to ignore this request, for example, + /// due to resource constraints. grpc_compression_algorithm compression_algorithm() const { return compression_algorithm_; } @@ -302,7 +304,10 @@ class ClientContext { /// Flag whether the initial metadata should be \a corked /// /// If \a corked is true, then the initial metadata will be coalesced with the - /// write of first message in the stream. + /// write of first message in the stream. As a result, any tag set for the + /// initial metadata operation (starting a client-streaming or bidi-streaming + /// RPC) will not actually be sent to the completion queue or delivered + /// via Next. /// /// \param corked The flag indicating whether the initial metadata is to be /// corked or not. @@ -330,6 +335,10 @@ class ClientContext { /// already finished, it may still return success. /// /// There is no guarantee the call will be cancelled. + /// + /// Note that TryCancel() does not change any of the tags that are pending + /// on the completion queue. All pending tags will still be delivered + /// (though their ok result may reflect the effect of cancellation). void TryCancel(); /// Global Callbacks |