docs(axum): recommend actor pattern for concurrent WebSocket read/write - #3842
Open
0xendale wants to merge 1 commit into
Open
docs(axum): recommend actor pattern for concurrent WebSocket read/write#38420xendale wants to merge 1 commit into
0xendale wants to merge 1 commit 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
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.
Motivation
The WebSocket module docs suggest
StreamExt::splitas the way to read and write concurrently. Splitting wraps each half in a lock that must be acquired on every operation, which adds avoidable overhead. Upstream issue #3793 proposes highlighting the actor pattern as the higher-performance alternative, and #3786 already laid the groundwork by documenting thatWebSocket::recvis cancel safe.Solution
Rework the "Read and write concurrently" section in
axum/src/extract/ws.rs:tokio::select!to raceWebSocket::recv(cancel safe) against anmpscchannel that other tasks use to send messages to the client. Links to Actors with Tokio for background.StreamExt::splitas a documented alternative, with a note about its per-operation locking overhead.Both examples are compile-checked doc tests. Verified with
cargo test -p axum --all-features --doc wsandcargo docusing CI's rustdoc flags (-D rustdoc::all -A rustdoc::private-doc-tests); the test-only hidden line does not appear in the rendered docs.