AtHeartEngineer/specs
1
0
Fork 0
mirror of https://github.com/vacp2p/specs.git synced 2026-01-09 23:37:55 -05:00
Code Issues Packages Projects Releases Wiki Activity

yamux: document stream ACK backlog (#547)

Browse Source 
Co-authored-by: Marten Seemann <martenseemann@gmail.com>
This commit is contained in:
Thomas Eizinger
2023-09-04 22:34:29 +10:00
committed by GitHub
parent 50db89f3a7
commit c96c9ec590
1 changed files with 13 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
yamux/README.md
View File

@@ -152,8 +152,19 @@ The Length should be set to one of the following to provide an error code:
## Implementation considerations
### ACK backlog
### ACK backlog & backpressure
Yamux allows for a stream to be opened (and used) before it is acknowledged by the remote.
Yamux also does not specify a backpressure mechanism for opening new streams.
This presents a problem:
A peer must read from the socket and decode the frames to make progress on existing streams.
But any frame could also open yet another stream.
The ACK backlog is defined as the number of streams that a peer has opened which have not yet been acknowledged.
Implementations SHOULD at most allow an ACK backlog of 256 streams.
To support a basic form of backpressure, implementions:
- SHOULD at most allow an ACK backlog of 256 streams.
- MAY buffer unacknowledged inbound streams instead of resetting them when the application currently cannot handle any more streams.
Such a buffer MUST be bounded in size to mitigate DoS attacks.
- MAY delay acknowledging new streams until the application has received or is about to send the first DATA frame.