gsadmin/noq
1
0
Fork 0
mirror of https://github.com/n0-computer/noq.git synced 2026-09-23 03:35:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updates docs for Connection::accept_bi() and Connection::open_bi()

Browse Source
This commit is contained in:
James Leitch
2023-11-10 17:30:10 +00:00
committed by Dirkjan Ochtman
parent ca0fae8896
commit e77cd3e33d
1 changed files with 15 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
quinn/src/connection.rs
+15 -1
View File
@@ -282,7 +282,12 @@ impl Connection {
///
/// Streams are cheap and instantaneous to open unless blocked by flow control. As a
/// consequence, the peer won't be notified that a stream has been opened until the stream is
/// actually used.
/// actually used. Calling [`open_bi()`] then waiting on the [`RecvStream`] without writing
/// anything to [`SendStream`] will never succeed.
///
/// [`open_bi()`]: crate::Connection::open_bi
/// [`SendStream`]: crate::SendStream
/// [`RecvStream`]: crate::RecvStream
pub fn open_bi(&self) -> OpenBi<'_> {
OpenBi {
conn: &self.0,
@@ -299,6 +304,15 @@ impl Connection {
}
/// Accept the next incoming bidirectional stream
///
/// **Important Note**: The `Connection` that calls [`open_bi()`] must write to its [`SendStream`]
/// before the other `Connection` is able to `accept_bi()`. Calling [`open_bi()`] then
/// waiting on the [`RecvStream`] without writing anything to [`SendStream`] will never succeed.
///
/// [`accept_bi()`]: crate::Connection::accept_bi
/// [`open_bi()`]: crate::Connection::open_bi
/// [`SendStream`]: crate::SendStream
/// [`RecvStream`]: crate::RecvStream
pub fn accept_bi(&self) -> AcceptBi<'_> {
AcceptBi {
conn: &self.0,