From 7843862f774651364cc93561803d8d3efcc6741e Mon Sep 17 00:00:00 2001 From: Kestrer Date: Mon, 15 Feb 2021 10:25:51 +0000 Subject: [PATCH] runtime: update documentation of thread limits Since ed5a94eb2db95b7cc142045fbbd5d68c6276e04e, there is no longer a limit of 32,768 threads on the worker threads and blocking thread pool, but the documentation has not been updated. This commit removes that part of the documentation. --- tokio/src/runtime/builder.rs | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/tokio/src/runtime/builder.rs b/tokio/src/runtime/builder.rs index 33b63e1fe66..e8805494928 100644 --- a/tokio/src/runtime/builder.rs +++ b/tokio/src/runtime/builder.rs @@ -167,8 +167,8 @@ impl Builder { /// Sets the number of worker threads the `Runtime` will use. /// - /// This should be a number between 0 and 32,768 though it is advised to - /// keep this value on the smaller side. + /// This can be any number above 0 though it is advised to keep this value + /// on the smaller side. /// /// # Default /// @@ -220,19 +220,22 @@ impl Builder { self } - /// Specifies limit for threads spawned by the Runtime used for blocking operations. + /// Specifies the limit for additional threads spawned by the Runtime. /// - /// - /// Similarly to the `worker_threads`, this number should be between 1 and 32,768. + /// These threads are used for blocking operations like tasks spawned + /// through [`spawn_blocking`]. Unlike the [`worker_threads`], they are not + /// always active and will exit if left idle for too long. You can change + /// this timeout duration with [`thread_keep_alive`]. /// /// The default value is 512. /// - /// Otherwise as `worker_threads` are always active, it limits additional threads (e.g. for - /// blocking annotations). - /// /// # Panic /// /// This will panic if `val` is not larger than `0`. + /// + /// [`spawn_blocking`]: fn@crate::task::spawn_blocking + /// [`worker_threads`]: Self::worker_threads + /// [`thread_keep_alive`]: Self::thread_keep_alive pub fn max_blocking_threads(&mut self, val: usize) -> &mut Self { assert!(val > 0, "Max blocking threads cannot be set to 0"); self.max_blocking_threads = val;