documentation: add stream lifecycle doc to NewStream #2060
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
(very unfamiliar with proto-gen-go) I'm looking at pubsub.pb.go, one of our autogenerated clients. I assume this is generated with proto-gen-go. It does not appear to have any method-level comments. @dfawley wrt documenting ctx usage, did you have in mind putting some method-level comments on these generated files, or? |
dfawley
reviewed
May 10, 2018
| @@ -101,7 +101,7 @@ type ClientStream interface { | |||
| } | |||
|
|
|||
| // NewStream creates a new Stream for the client side. This is typically | |||
| // called by generated code. | |||
| // called by generated code. ctx is used for the lifetime of the stream. | |||
There was a problem hiding this comment.
If you're making changes here, would you mind summarizing what I wrote in #1854 regarding how to ensure a stream doesn't leak a goroutine? Something like:
// To ensure resources are not leaked due to the stream returned, one of the following
// actions must be performed:
//
// 1. call Close on the ClientConn,
// 2. cancel the context provided,
// 3. call RecvMsg until a non-nil error is returned, or
// 4. receive a non-nil error from Header or SendMsg besides io.EOF.
//
// If none of the above happen, a goroutine and a context will be leaked, and grpc
// will not call the optionally-configured stats handler with a stats.End message.
stream.go
Outdated
| @@ -114,7 +114,7 @@ func (cc *ClientConn) NewStream(ctx context.Context, desc *StreamDesc, method st | |||
| } | |||
|
|
|||
| // NewClientStream creates a new Stream for the client side. This is typically | |||
There was a problem hiding this comment.
How about
// NewClientStream is a wrapper for ClientConn.NewStream.
//
// DEPRECATED: ....to avoid the need to duplicate documentation.
dfawley
approved these changes
May 11, 2018
menghanl
changed the title
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds documentation around how to properly close a stream, and how ctx is used by streams.