grpc / grpc/grpc-java

Clarify the Javadoc for CallStreamObserver

Đang mở
#6,552 4 bình luận 0 reaction 0 người được giao Xem trên GitHub
docs enhancement
Ngôn ngữ chính
Java
Star
12.1k
Fork
4k
Merge trung bình
2 ngày 17 giờ
Pull request đã merge (30 ngày)
37

Mô tả

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`.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Hướng nghiên cứu

Start with stub/src/main/java/io/grpc/stub/CallStreamObserver.java, especially the Javadoc at lines 25–35 linked in the issue. Clarify the three StreamObserver implementations and the roles of ClientCallStreamObserver and ServerCallStreamObserver; the Javadoc should make where ClientCallStreamObserver appears understandable.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
java
Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
1/5
Thời gian dự kiến
1-3 giờ
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Đặc tả rõ ràng
Mức phù hợp với người mới
45/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.