Repository navigation
Document WebSocket callback threads and shutdown ownership - #638
Merged
Merged
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
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.
Applications need to know which thread can invoke a WebSocket callback to avoid reentrant locking and shutdown deadlocks. Document callback execution for clients using
start(), explicitconnect()/run(), and server connections, along with the separate contexts for send progress and the shared traffic tracker.Explain that fatal send failures now defer Close delivery to the connection thread, following #635. Add lifecycle guidance: configure callbacks before processing starts, use
close()inside handlers, performstop()and destruction from an owning thread, and avoid holding application locks needed by callbacks while joining.Closes #457. The send-failure behavior was fixed by #635; this change documents the threading model and remaining usage constraints.
Validation:
mkdocs build --strictandgit diff --checkpassed. The investigation also rebuilt master and ranIXWebSocketSendFailureTest: 60 assertions in 4 test cases passed. Documentation only; no runtime changes.