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

core: add clarification to ClientCall javadoc 

* Improve ClientCall documentation. Clarify that some methods of ClientCall may be invoked from any thread. Adds @throws clauses to request().
This commit is contained in:
Grant Oakley 2018-06-12 10:23:01 -07:00 committed by Carl Mastrangelo
parent 3934ad9f4b
commit defb955f3a
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -38,7 +38,8 @@ import javax.annotation.Nullable;
* Applications are expected to utilize normal payload messages for such signals, as a response * Applications are expected to utilize normal payload messages for such signals, as a response
* naturally acknowledges its request. * naturally acknowledges its request.
* *
* <p>Methods are guaranteed to be non-blocking. Implementations are not required to be thread-safe. * <p>Methods are guaranteed to be non-blocking. Not thread-safe except for {@link #request}, which
* may be called from any thread.
* *
* <p>There is no interaction between the states on the {@link Listener Listener} and {@link * <p>There is no interaction between the states on the {@link Listener Listener} and {@link
* ClientCall}, i.e., if {@link Listener#onClose Listener.onClose()} is called, it has no bearing on * ClientCall}, i.e., if {@link Listener#onClose Listener.onClose()} is called, it has no bearing on
@ -190,6 +191,8 @@ public abstract class ClientCall<ReqT, RespT> {
* *
* @param numMessages the requested number of messages to be delivered to the listener. Must be * @param numMessages the requested number of messages to be delivered to the listener. Must be
* non-negative. * non-negative.
* @throws IllegalStateException if call is not {@code start()}ed
* @throws IllegalArgumentException if numMessages is negative
*/ */
public abstract void request(int numMessages); public abstract void request(int numMessages);