Skip to content

stub: add docs clarifying readiness #4342

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

Merged
merged 2 commits into from
Apr 13, 2018
Merged

stub: add docs clarifying readiness #4342

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9dfe10e
stub: add docs clarifying readiness
carl-mastrangelo Apr 13, 2018
c506b56
comments
carl-mastrangelo Apr 13, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions core/src/main/java/io/grpc/ClientCall.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,10 @@ public void onClose(Status status, Metadata trailers) {}
* {@link #sendMessage}) without requiring excessive buffering internally. This event is
* just a suggestion and the application is free to ignore it, however doing so may
* result in excessive buffering within the ClientCall.
*
* <p>If the type of a call is either {@link MethodDescriptor.MethodType#UNARY} or
* {@link MethodDescriptor.MethodType#SERVER_STREAMING}, this callback may not be fired. Calls
* that send exactly one message should not await this callback.
*/
public void onReady() {}
}
Expand Down Expand Up @@ -223,6 +227,10 @@ public void onReady() {}
*
* <p>This abstract class's implementation always returns {@code true}. Implementations generally
* override the method.
*
* <p>If the type of the call is either {@link MethodDescriptor.MethodType#UNARY} or
* {@link MethodDescriptor.MethodType#SERVER_STREAMING}, this method may return false. Calls that
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/may return/may persistently return/

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

* send exactly one message should not check this method.
*/
public boolean isReady() {
return true;
Expand Down