grpc / grpc/grpc-java

Clarify the Javadoc for CallStreamObserver

Open
#6,552 4 comments 0 reactions 0 assignees View on GitHub
docs enhancement
Dominant language
Java
Stars
12.1k
Forks
4k
Avg merge
2d 17h
Merged PRs (30d)
37

Description

The relevant part of the current Javadoc:
https://github.com/grpc/grpc-java/blob/6b04fc18f30deb3519c389fe457b99cf5a8d99d0/stub/src/main/java/io/grpc/stub/CallStreamObserver.java#L25-L35

As far as I can tell, for any call, there are three implementations of `StreamObserver` involved:
1) Implemented by the application, on the RPC client side ('inbound')
2) Implemented by the framework, on the RPC client side ('outbound'), `ClientCallStreamObserver`
3) Implemented by the framework, on the RPC server side ('outbound'), `ServerCallStreamObserver`

I think it would be nice to clarify that. I've spent significant time trying to understand where does `ClientCallStreamObserver` appear, being confused by the premise that there are only two implementations of `StreamObserver`.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.