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

internal: tweak ClientTransport.GracefulClose documentation #2772

Merged
merged 2 commits into from
Apr 16, 2019
Merged

internal: tweak ClientTransport.GracefulClose documentation #2772

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a992fa
internal: tweak ClientTransport.GracefulClose documentation
jeanbza Apr 13, 2019
715c122
address menghanl@ review comment
jeanbza Apr 15, 2019
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
7 changes: 5 additions & 2 deletions internal/transport/transport.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -578,8 +578,11 @@ type ClientTransport interface {
// is called only once.
Close() error

// GracefulClose starts to tear down the transport. It stops accepting
// new RPCs and wait the completion of the pending RPCs.
// GracefulClose starts to tear down the transport: the transport will stop
// accepting new RPCs and NewStream will return error. Once all streams are
// finished, the transport will close.
//
// It does not block.
GracefulClose() error

// Write sends the data for the given stream. A nil stream indicates
Expand Down