itsscb/tokio
1
0
Fork 0
mirror of https://github.com/tokio-rs/tokio.git synced 2025-10-01 12:20:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Mention features for basic_scheduler, threaded_scheduler (#1858)

Browse Source 
Fixes #1829
This commit is contained in:
Ömer Sinan Ağacan 2019-11-29 19:26:58 +03:00 committed by Ivan Petkov
parent 4261ab6627
commit ec7f2ae306
1 changed files with 15 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
tokio/src/runtime/builder.rs
View File

@ -152,23 +152,6 @@ impl Builder {
self self
} }
/// Use a simpler scheduler that runs all tasks on the current-thread.
///
/// The executor and all necessary drivers will all be run on the current
/// thread during `block_on` calls.
#[cfg(feature = "rt-core")]
pub fn basic_scheduler(&mut self) -> &mut Self {
self.kind = Kind::Basic;
self
}
/// Use a multi-threaded scheduler for executing tasks.
#[cfg(feature = "rt-threaded")]
pub fn threaded_scheduler(&mut self) -> &mut Self {
self.kind = Kind::ThreadPool;
self
}
/// Set name of threads spawned by the `Runtime`'s thread pool. /// Set name of threads spawned by the `Runtime`'s thread pool.
/// ///
/// The default name is "tokio-runtime-worker". /// The default name is "tokio-runtime-worker".
@ -369,6 +352,15 @@ cfg_time! {
cfg_rt_core! { cfg_rt_core! {
impl Builder { impl Builder {
/// Use a simpler scheduler that runs all tasks on the current-thread.
///
/// The executor and all necessary drivers will all be run on the current
/// thread during `block_on` calls.
pub fn basic_scheduler(&mut self) -> &mut Self {
self.kind = Kind::Basic;
self
}
fn build_basic_runtime(&mut self) -> io::Result<Runtime> { fn build_basic_runtime(&mut self) -> io::Result<Runtime> {
use crate::runtime::{BasicScheduler, Kind}; use crate::runtime::{BasicScheduler, Kind};
@ -407,6 +399,12 @@ cfg_rt_core! {
cfg_rt_threaded! { cfg_rt_threaded! {
impl Builder { impl Builder {
/// Use a multi-threaded scheduler for executing tasks.
pub fn threaded_scheduler(&mut self) -> &mut Self {
self.kind = Kind::ThreadPool;
self
}
fn build_threaded_runtime(&mut self) -> io::Result<Runtime> { fn build_threaded_runtime(&mut self) -> io::Result<Runtime> {
use crate::runtime::{Kind, ThreadPool}; use crate::runtime::{Kind, ThreadPool};
use crate::runtime::park::Parker; use crate::runtime::park::Parker;