From 4e3ffc1016cfd09429788b077d425a97171d2492 Mon Sep 17 00:00:00 2001 From: Thomas Eizinger Date: Fri, 17 Feb 2023 21:51:58 +1300 Subject: [PATCH] Add ACK backlog recommendation --- yamux/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/yamux/README.md b/yamux/README.md index 385d31cbb..d4b391687 100644 --- a/yamux/README.md +++ b/yamux/README.md @@ -145,3 +145,11 @@ The Length should be set to one of the following to provide an error code: * 0x0 Normal termination * 0x1 Protocol error * 0x2 Internal error + +## Implementation considerations + +### ACK backlog + +Yamux allows for a stream to be opened (and used) before it is acknowledged by the remote. +We defined the ACK backlog 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.