grpc
/
grpc-java
mirror of https://github.com/grpc/grpc-java.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve docs to describe close as being last method called 

This isn't changing any of the semantics we already had, but more
informing users of the guarantees we provide.
This commit is contained in:
Eric Anderson 2015-07-08 09:41:55 -07:00
parent 7fff088e19
commit d27cbc8aa3
2 changed files with 13 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
core/src/main/java/io/grpc/ClientCall.java
View File

@ -80,10 +80,13 @@ public abstract class ClientCall<RequestT, ResponseT> {
public abstract void onPayload(T payload);
/**
* The ClientCall has been closed. No further sending or receiving can occur. If {@code status}
* is not equal to {@link Status#OK}, then the call failed. An additional block of trailer
* metadata may be received at the end of the call from the server. An empty {@link Metadata}
* object is passed if no trailers are received.
* The ClientCall has been closed. Any additional calls to the {@code ClientCall} will not be
* processed by the server. No further receiving will occur and no further notifications will be
* made.
*
* <p>If {@code status} is not equal to {@link Status#OK}, then the call failed. An additional
* block of trailer metadata may be received at the end of the call from the server. An empty
* {@link Metadata} object is passed if no trailers are received.
*
* @param status the result of the remote call.
* @param trailers metadata provided at call completion.

12
stub/src/main/java/io/grpc/stub/StreamObserver.java
View File

@ -60,9 +60,9 @@ public interface StreamObserver<V> {
/**
* Receives a terminating error from the stream.
*
* <p>May only be called once and is never called after {@link #onCompleted()}. In particular if
* an exception is thrown by an implementation of {@code onError} no further calls to any
* method are allowed.
* <p>May only be called once and if called it must be the last method called. In particular if an
* exception is thrown by an implementation of {@code onError} no further calls to any method are
* allowed.
*
* @param t the error occurred on the stream
*/
@ -71,9 +71,9 @@ public interface StreamObserver<V> {
/**
* Receives a notification of successful stream completion.
*
* <p>May only be called once and is never called after {@link #onError(Throwable)}. In particular
* if an exception is thrown by an implementation of {@code onCompleted} no further calls to
* any method are allowed.
* <p>May only be called once and if called it must be the last method called. In particular if an
* exception is thrown by an implementation of {@code onCompleted} no further calls to any method
* are allowed.
*/
public void onCompleted();
}