pub struct Runtime { /* private fields */ }
Expand description
An I/O-oriented thread pool for executing futures.
Each thread in the pool has its own I/O reactor, and futures are spawned onto threads
round-robin. Futures do not (currently) move between threads in the pool once spawned, and any
new futures spawned (using tokio::spawn
) inside futures are scheduled on the same worker as
the original future.
Implementations§
Source§impl Runtime
impl Runtime
Sourcepub fn new() -> Self
pub fn new() -> Self
Create a new thread pool with parameters from a default Builder
and return a handle to
it.
§Panics
Panics if enough threads could not be spawned (see Builder::build
).
Sourcepub fn handle(&self) -> &Handle
pub fn handle(&self) -> &Handle
Return a reference to the pool.
The returned handle reference can be cloned in order to get an owned value of the handle. This handle can be used to spawn additional futures onto the pool from other threads.
Sourcepub fn spawn<F>(&self, future: F) -> Result<&Self, SpawnError>
pub fn spawn<F>(&self, future: F) -> Result<&Self, SpawnError>
Spawn a future onto a runtime in the pool.
This spawns the given future onto a single thread runtime’s executor. That thread is then responsible for polling the future until it completes.
Sourcepub fn spawn_all<S>(
&self,
stream: S,
) -> impl Future<Item = (), Error = StreamSpawnError<<S as Stream>::Error>>
pub fn spawn_all<S>( &self, stream: S, ) -> impl Future<Item = (), Error = StreamSpawnError<<S as Stream>::Error>>
Spawn all futures yielded by a stream onto the pool.
This produces a future that accepts futures from a Stream
and spawns them all onto the
pool round-robin.
Sourcepub fn block_on<F, R, E>(&mut self, future: F) -> Result<R, E>
pub fn block_on<F, R, E>(&mut self, future: F) -> Result<R, E>
Run the given future on the current thread, and dispatch any child futures spawned with
tokio::spawn
onto the I/O pool.
Note that child futures of futures that are already running on the pool will be executed on
the same pool thread as their parent. Only the “top-level” calls to tokio::spawn
are
scheduled to the thread pool as a whole.
Note that the top-level future is executed using Future::wait
, and thus does not provide
access to timers, clocks, or other tokio runtime goodies.
Sourcepub fn shutdown(self)
pub fn shutdown(self)
Shut down the pool as soon as possible.
Note that once this method has been called, attempts to spawn additional futures onto the
pool through an outstanding Handle
may fail. Futures that have not yet resolved will be
dropped.
The pool will only terminate once any currently-running futures return NotReady
.
Sourcepub fn shutdown_on_idle(self)
pub fn shutdown_on_idle(self)
Shut down the pool once all spawned futures have completed.
Note that once this method has been called, attempts to spawn additional futures onto the
pool through an outstanding Handle
may fail.