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

stub: Document that noop onCancelHandler is useful 

setOnCancelHandler tells gRPC that the application is handling
cancellation. But it's fine to have noop behavior within the handler
itself if the application doesn't need it. It is just a way to opt-in to
the more recent no-exception-from-onNext behavior. Let's mention this
use-case in the docs to make it more obvious it is a possibility.

Came up as part of #8409.
This commit is contained in:
Eric Anderson 2021-08-16 11:45:21 -07:00
parent 22603810b9
commit 9870db1f47
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
stub/src/main/java/io/grpc/stub/ServerCallStreamObserver.java
View File

@ -54,7 +54,9 @@ public abstract class ServerCallStreamObserver<V> extends CallStreamObserver<V>
* service returns its {@code StreamObserver}.
*
* <p>Setting the onCancelHandler will suppress the on-cancel exception thrown by
* {@link #onNext}.
* {@link #onNext}. If the caller is already handling cancellation via polling or cannot
* substantially benefit from observing cancellation, using a no-op {@code onCancelHandler} is
* useful just to suppress the {@code onNext()} exception.
*
* @param onCancelHandler to call when client has cancelled the call.
*/