Struct tokio_threadpool::ThreadPool
[−]
[src]
pub struct ThreadPool { /* fields omitted */ }
Work-stealing based thread pool for executing futures.
If a ThreadPool
instance is dropped without explicitly being shutdown,
shutdown_now
is called implicitly, forcing all tasks that have not yet
completed to be dropped.
Create ThreadPool
instances using Builder
.
Methods
impl ThreadPool
[src]
pub fn new() -> ThreadPool
[src]
Create a new ThreadPool
with default values.
Use Builder
for creating a configured thread pool.
pub fn spawn<F>(&self, future: F) where
F: Future<Item = (), Error = ()> + Send + 'static,
[src]
F: Future<Item = (), Error = ()> + Send + 'static,
Spawn a future onto the thread pool.
This function takes ownership of the future and randomly assigns it to a worker thread. The thread will then start executing the future.
Examples
use futures::future::{Future, lazy}; // Create a thread pool with default configuration values let thread_pool = ThreadPool::new(); thread_pool.spawn(lazy(|| { println!("called from a worker thread"); Ok(()) })); // Gracefully shutdown the threadpool thread_pool.shutdown().wait().unwrap();
Panics
This function panics if the spawn fails. Use [Sender::spawn
] for a
version that returns a Result
instead of panicking.
pub fn sender(&self) -> &Sender
[src]
Return a reference to the sender handle
The handle is used to spawn futures onto the thread pool. It also
implements the Executor
trait.
pub fn sender_mut(&mut self) -> &mut Sender
[src]
Return a mutable reference to the sender handle
pub fn shutdown_on_idle(self) -> Shutdown
[src]
Shutdown the pool once it becomes idle.
Idle is defined as the completion of all futures that have been spawned onto the thread pool. There may still be outstanding handles when the thread pool reaches an idle state.
Once the idle state is reached, calling spawn
on any outstanding
handle will result in an error. All worker threads are signaled and will
shutdown. The returned future completes once all worker threads have
completed the shutdown process.
pub fn shutdown(self) -> Shutdown
[src]
Shutdown the pool
This prevents the thread pool from accepting new tasks but will allow any existing tasks to complete.
Calling spawn
on any outstanding handle will result in an error. All
worker threads are signaled and will shutdown. The returned future
completes once all worker threads have completed the shutdown process.
pub fn shutdown_now(self) -> Shutdown
[src]
Shutdown the pool immediately
This will prevent the thread pool from accepting new tasks and abort any tasks that are currently running on the thread pool.
Calling spawn
on any outstanding handle will result in an error. All
worker threads are signaled and will shutdown. The returned future
completes once all worker threads have completed the shutdown process.
Trait Implementations
impl Debug for ThreadPool
[src]
fn fmt(&self, __arg_0: &mut Formatter) -> Result
[src]
Formats the value using the given formatter. Read more