From 1fec30e9fbab36ec687251ea528bf5847723dcff Mon Sep 17 00:00:00 2001 From: Alexey Date: Fri, 23 Aug 2024 12:31:55 +0300 Subject: [PATCH] Clarify yamux stream flow control terminilogy #621 --- yamux/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/yamux/README.md b/yamux/README.md index f6a4b45fa..338c26b07 100644 --- a/yamux/README.md +++ b/yamux/README.md @@ -57,7 +57,7 @@ The following message types are supported: * 0x0 Data - Used to transmit data. May transmit zero length payloads depending on the flags. * 0x1 Window Update - Used to updated the senders receive window size. - This is used to implement per-session flow control. + This is used to implement per-stream flow control. * 0x2 Ping - Used to measure RTT. It can also be used to heart-beat and do keep-alives over TCP. @@ -132,7 +132,7 @@ Alternatively, if an error occurs, the RST flag can be used to hard close a stre #### Flow Control -When Yamux is initially starts each stream with a 256KB window size. +When Yamux is initially starts each stream with a 256KiB window size. There is no window size for the session. To prevent the streams from stalling, window update frames should be sent regularly.