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

Clarify benefits of read_unordered

Browse Source
This commit is contained in:
Benjamin Saunders
2020-05-09 13:09:01 -07:00
committed by Dirkjan Ochtman
parent 54f0ab1b14
commit 17d97888fc
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
quinn-proto/src/connection/mod.rs
+4 -3
View File
@@ -682,9 +682,10 @@ where
/// Read from the given recv stream, in undefined order
///
/// While stream data is usually returned to the application in order, for some applications
/// it can make sense to leverage the reduced latency of unordered reads. For ordered reads,
/// the sibling `read()` method can be used.
/// While stream data is typically processed by applications in-order, unordered reads improve
/// performance when packet loss occurs and data cannot be retransmitted before the flow control
/// window is filled. When in-order delivery is required, the sibling `read()` method should be
/// used.
///
/// The return value if `Ok` contains the bytes and their offset in the stream.
pub fn read_unordered(&mut self, id: StreamId) -> Result<Option<(Bytes, u64)>, ReadError> {