core/doc: clarify when ClientCall.cancel() can be called.

The original javadoc may be misunderstood as "one must call
halfClose() before calling cancel()".
This commit is contained in:
Kun Zhang 2020-05-07 18:41:22 -07:00 committed by GitHub
parent e7d6b5f808
commit 96a32ed768
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions

View File

@ -205,8 +205,8 @@ public abstract class ClientCall<ReqT, RespT> {
/** /**
* Prevent any further processing for this {@code ClientCall}. No further messages may be sent or * Prevent any further processing for this {@code ClientCall}. No further messages may be sent or
* will be received. The server is informed of cancellations, but may not stop processing the * will be received. The server is informed of cancellations, but may not stop processing the
* call. Cancellation is permitted if previously {@link #halfClose}d. Cancelling an already {@code * call. Cancellation is permitted even if previously {@link #halfClose}d. Cancelling an already
* cancel()}ed {@code ClientCall} has no effect. * {@code cancel()}ed {@code ClientCall} has no effect.
* *
* <p>No other methods on this class can be called after this method has been called. * <p>No other methods on this class can be called after this method has been called.
* *