net: clarify platform-dependent backlog in TcpSocket docs#7738
Merged
ADD-SP merged 1 commit intotokio-rs:masterfrom Nov 16, 2025
Merged
net: clarify platform-dependent backlog in TcpSocket docs#7738ADD-SP merged 1 commit intotokio-rs:masterfrom
ADD-SP merged 1 commit intotokio-rs:masterfrom
Conversation
The example showing how `TcpListener::bind` is equivalent to manually constructing a `TcpSocket` previously used a hardcoded backlog of 1024. However, Tokio now relies on Mio's platform-dependent default backlog configuration, so the value in the example was misleading. This commit updates the documentation by adding a note explaining that the actual backlog used by `TcpListener::bind` varies by platform and that the example value is only illustrative. Fixes: tokio-rs#7729
ADD-SP
approved these changes
Nov 16, 2025
Member
|
Thanks! |
ADD-SP
added
T-docs
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.
Fixes: #7729
Motivation
The documentation example for reproducing the behavior of
TcpListener::binduses a hardcoded backlog value of 1024. However, Tokio now relies on Mio's platform-dependent default backlog configuration, so the value in the example was misleading.Solution
This commit updates the documentation by adding a note explaining that the
actual backlog used by
TcpListener::bindvaries by platform and that theexample value is only illustrative.