From ac1268911e6a2119eae9e6d2a61067d14464c688 Mon Sep 17 00:00:00 2001 From: the harder the luckier Date: Thu, 7 Mar 2024 08:37:35 +0800 Subject: [PATCH] improve API documentation for OpenStreamSync (#4352) * docs: improve API documentation for OpenStreamSync Both `OpenStream` and `OpenStreamSync` themselves only create steam objects locally, but `OpenStreamSync` does not add document descriptions, which will cause ambiguity. * additional description --- interface.go | 3 +++ 1 file changed, 3 insertions(+) diff --git a/interface.go b/interface.go index 977fd22a..7ef03333 100644 --- a/interface.go +++ b/interface.go @@ -163,6 +163,9 @@ type Connection interface { OpenStream() (Stream, error) // OpenStreamSync opens a new bidirectional QUIC stream. // It blocks until a new stream can be opened. + // There is no signaling to the peer about new streams: + // The peer can only accept the stream after data has been sent on the stream, + // or the stream has been reset or closed. // If the error is non-nil, it satisfies the net.Error interface. // If the connection was closed due to a timeout, Timeout() will be true. OpenStreamSync(context.Context) (Stream, error)