Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

api: Clarify expectations regarding ServerCall#close #7580

Merged
merged 3 commits into from Nov 2, 2020
Merged

api: Clarify expectations regarding ServerCall#close #7580

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d086fd5
api: Clarify behavior of ServerCall#close regarding client cancellations
ST-DDT Oct 30, 2020
a880da6
Fix javadocs
ST-DDT Oct 30, 2020
a4e857a
Use @ejona86's suggested wording
ST-DDT Nov 1, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 7 additions & 0 deletions api/src/main/java/io/grpc/ServerCall.java
View file
Open in desktop
Expand Up @@ -163,6 +163,13 @@ public boolean isReady() {
* <p>Since {@link Metadata} is not thread-safe, the caller must not access (read or write) {@code
* trailers} after this point.
*
* <p>This method implies the caller completed processing the RPC, but it does not imply the RPC
* is complete. The call implementation will need additional time to complete the RPC and during
* this time the client is still able to cancel the request or a network error might cause the
* RPC to fail. If you wish to know when the call is actually completed/closed, you have to use
* {@link Listener#onComplete} or {@link Listener#onCancel} instead. This method is not
* necessarily invoked when Listener.onCancel() is called.
*
* @throws IllegalStateException if call is already {@code close}d
*/
public abstract void close(Status status, Metadata trailers);
Expand Down