opensource/grpc-go
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

internal: tweak ClientTransport.GracefulClose documentation (#2772)

Browse Source 
* internal: tweak ClientTransport.GracefulClose documentation

* address menghanl@ review comment
This commit is contained in:
Jean de Klerk
2019-04-16 16:54:26 -06:00
committed by GitHub
parent 5b263177f2
commit d7af56a5e4
1 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
internal/transport/transport.go
View File

@ -578,8 +578,11 @@ type ClientTransport interface {
// is called only once. // is called only once.
Close() error Close() error
// GracefulClose starts to tear down the transport. It stops accepting // GracefulClose starts to tear down the transport: the transport will stop
// new RPCs and wait the completion of the pending RPCs. // accepting new RPCs and NewStream will return error. Once all streams are
// finished, the transport will close.
//
// It does not block.
GracefulClose() error GracefulClose() error
// Write sends the data for the given stream. A nil stream indicates // Write sends the data for the given stream. A nil stream indicates