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

docs: clarify SendMsg/CloseSend usage (#2418)

Browse Source
This commit is contained in:
Jean de Klerk
2018-11-01 12:29:53 -06:00
committed by GitHub
parent 105f61423e
commit 61c3ec866d
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
stream.go
View File

@ -86,7 +86,8 @@ type ClientStream interface {
// stream.Recv has returned a non-nil error (including io.EOF). // stream.Recv has returned a non-nil error (including io.EOF).
Trailer() metadata.MD Trailer() metadata.MD
// CloseSend closes the send direction of the stream. It closes the stream // CloseSend closes the send direction of the stream. It closes the stream
// when non-nil error is met. // when non-nil error is met. It is also not safe to call CloseSend
// concurrently with SendMsg.
CloseSend() error CloseSend() error
// Context returns the context for this stream. // Context returns the context for this stream.
// //
@ -109,7 +110,8 @@ type ClientStream interface {
// //
// It is safe to have a goroutine calling SendMsg and another goroutine // It is safe to have a goroutine calling SendMsg and another goroutine
// calling RecvMsg on the same stream at the same time, but it is not safe // calling RecvMsg on the same stream at the same time, but it is not safe
// to call SendMsg on the same stream in different goroutines. // to call SendMsg on the same stream in different goroutines. It is also
// not safe to call CloseSend concurrently with SendMsg.
SendMsg(m interface{}) error SendMsg(m interface{}) error
// RecvMsg blocks until it receives a message into m or the stream is // RecvMsg blocks until it receives a message into m or the stream is
// done. It returns io.EOF when the stream completes successfully. On // done. It returns io.EOF when the stream completes successfully. On