From: Seaker <seakerone@proton.me>
Date: Sun, 16 Nov 2025 10:44:35 +0000 (+0000)
Subject: net: clarify the platform-dependent backlog in `TcpSocket` docs (#7738)
X-Git-Url: https://git.feebdaed.xyz/?a=commitdiff_plain;h=4714ca168d6bd97193625657b0381e9b65a9ceff;p=0xmirror%2Ftokio.git

net: clarify the platform-dependent backlog in `TcpSocket` docs (#7738)
---

diff --git a/tokio/src/net/tcp/socket.rs b/tokio/src/net/tcp/socket.rs
index a168154d..eb3ea510 100644
--- a/tokio/src/net/tcp/socket.rs
+++ b/tokio/src/net/tcp/socket.rs
@@ -68,6 +68,9 @@ cfg_net! {
     ///     socket.set_reuseaddr(true)?;
     ///     socket.bind(addr)?;
     ///
+    ///     // Note: the actual backlog used by `TcpListener::bind` is platform-dependent,
+    ///     // as Tokio relies on Mio's default backlog value configuration. The `1024` here is only
+    ///     // illustrative and does not reflect the real value used.
     ///     let listener = socket.listen(1024)?;
     /// # drop(listener);
     ///