feat: add configurable yamux close timeout for unread remote peers#219
Open
jxs wants to merge 2 commits into
Open
feat: add configurable yamux close timeout for unread remote peers#219jxs wants to merge 2 commits into
jxs wants to merge 2 commits into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This introduces a configurable timeout for
yamuxconnection shutdown, sopoll_closecan complete even when the remote peer stops reading from the underlying transport.When the timeout elapses during yamux close, the implementation stops waiting on yamux-level frame draining and force-closes at the yamux state-machine level.
In backpressured scenarios (e.g. remote stops reading), graceful yamux shutdown may otherwise wait indefinitely while trying to flush pending frames. This change gives users a bounded close path for those situations.
Important: this timeout only affects yamux protocol-level shutdown behavior.
It does not replace transport/socket-level close semantics. For TCP-level behavior (e.g. FIN/RST/linger behavior), users should still configure socket options such as
SO_LINGERas appropriate for their environment.