Add ACK backlog recommendation

libp2p · Feb 17, 2023 · 4e3ffc1 · 4e3ffc1
1 parent 8a05acc
commit 4e3ffc1
Showing 1 changed file with 8 additions and 0 deletions.
diff --git 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.