Skip to content

Commit

Permalink
runtime: update documentation of thread limits (#3527)
Browse files Browse the repository at this point in the history
Since ed5a94e, 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.
  • Loading branch information
Kestrer committed Feb 23, 2021
1 parent 7de18af commit 8efed43
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions tokio/src/runtime/builder.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
///
Expand Down Expand Up @@ -220,16 +220,15 @@ 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`.
Expand All @@ -238,6 +237,10 @@ impl Builder {
///
/// In old versions `max_threads` limited both blocking and worker threads, but the
/// current `max_blocking_threads` does not include async worker threads in the count.
///
/// [`spawn_blocking`]: fn@crate::task::spawn_blocking
/// [`worker_threads`]: Self::worker_threads
/// [`thread_keep_alive`]: Self::thread_keep_alive
#[cfg_attr(docsrs, doc(alias = "max_threads"))]
pub fn max_blocking_threads(&mut self, val: usize) -> &mut Self {
assert!(val > 0, "Max blocking threads cannot be set to 0");
Expand Down

0 comments on commit 8efed43

Please sign in to comment.