Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

clarify CloseSend vs CloseAndRecv; better formatting #2071

Merged
merged 5 commits into from
May 29, 2018
Merged

clarify CloseSend vs CloseAndRecv; better formatting #2071

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
89b2beb
clarify CloseSend vs CloseAndRecv; better formatting
jeanbza May 12, 2018
a322e6d
grammatical fixes
jeanbza May 12, 2018
f42d192
review comments
jeanbza May 23, 2018
4971453
more review comments
jeanbza May 23, 2018
dfa76ed
more revision
jeanbza May 25, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 4 additions & 6 deletions stream.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,12 +109,10 @@ type ClientStream interface {
// 1. Call Close on the ClientConn.
// 2. Cancel the context provided.
// 3. Call RecvMsg until a non-nil error is returned. For protobuf-generated clients:
// - Unidirectional clients should call CloseAndRecv (in the unidirectional case,
// the server should only ever respond in the "closing" case). Note that
// CloseSend will may not release all goroutines; CloseAndRecv guarantees
// release of resources.
// - Bidirectional clients should call Close and then call Recv until a non-nil
// error is returned.
// - Unidirectional clients should call CloseAndRecv. Note that CloseSend may not
Copy link
Member

@dfawley dfawley May 18, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Unidirectional" is ambiguous. I think you want something like "For client streaming RPCs, clients should call ..."

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"client streaming RPCs" could include bidirectional, which does not have CloseAndRecv right?

Could you clarify how unidirectional is ambiguous? Are you referring to the fact that both clients and servers can unidirectionally stream?

If so, how about:

  • "For unidirectional RPCs, clients should ..."
  • "For bidirectional RPCs, clients and servers should ..."

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not "For client-streaming RPCs..."? We have historically called the two unidirectional streaming RPCs "client-streaming" and "server-streaming".

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

// release all goroutines; CloseAndRecv guarantees release of resources.
// - Bidirectional clients should call Close and then repeatedly call Recv until
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Bidirectional or server-streaming clients"?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

// a non-nil error is returned.
// 4. Receive a non-nil, non-io.EOF error from Header or SendMsg.
//
// If none of the above happen, a goroutine and a context will be leaked, and grpc
Expand Down