mirrors/uquic
1
0
Fork 0
mirror of https://github.com/refraction-networking/uquic.git synced 2025-04-05 21:27:35 +03:00
Code Issues Projects Releases Packages Wiki Activity

improve the documentation for Stream.Context()

Browse source
This commit is contained in:
Marten Seemann 2019-04-03 01:12:47 +09:00
parent 907071221c
commit a5e9d34ebd
1 changed files with 2 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

3
interface.go
View file

@ -61,7 +61,8 @@ type Stream interface {
// When called multiple times or after reading the io.EOF it is a no-op. // When called multiple times or after reading the io.EOF it is a no-op.
CancelRead(ErrorCode) CancelRead(ErrorCode)
// The context is canceled as soon as the write-side of the stream is closed. // The context is canceled as soon as the write-side of the stream is closed.
// This happens when Close() is called, or when the stream is reset (either locally or remotely). // This happens when Close() or CancelWrite() is called, or when the peer
// cancels the read-side of their stream.
// Warning: This API should not be considered stable and might change soon. // Warning: This API should not be considered stable and might change soon.
Context() context.Context Context() context.Context
// SetReadDeadline sets the deadline for future Read calls and // SetReadDeadline sets the deadline for future Read calls and