Skip to content

Commit

Permalink
Clarify yamux stream flow control terminilogy #621
Browse files Browse the repository at this point in the history
  • Loading branch information
@flcl42
flcl42 authored Aug 23, 2024
1 parent f25d0c2 commit 1fec30e
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions yamux/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 1fec30e

Please sign in to comment.