Struct IoDispatcher

pub struct IoDispatcher(/* private fields */);

IoDispatcher is unstable and may change in the future.

A cross-thread, cross-runtime dispatcher of async IO workloads.

IoDispatchers are handles to an async runtime that can handle work submissions and multiplexes them across a set of worker threads. Unlike an async runtime, which is free to balance tasks as they see fit, the purpose of the Dispatcher is to enable the spawning of asynchronous, !Send tasks across potentially many worker threads, and allowing work submission from any other runtime.

Implementations

impl IoDispatcher

pub fn new() -> Self

pub fn new_tokio(num_thread: usize) -> Self

Create a new IO dispatcher that uses a set of Tokio current_thread runtimes to execute both Send and !Send futures.

A handle to the dispatcher can be passed freely among threads, allowing multiple parties to perform dispatching across different threads.

impl IoDispatcher

pub fn shared() -> Self

Returns a handle to the current process’s shared Dispatcher.

Trait Implementations

impl Clone for IoDispatcher

fn clone(&self) -> IoDispatcher

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for IoDispatcher

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for IoDispatcher

fn default() -> Self

Returns the “default value” for a type.

impl Dispatch for IoDispatcher

fn dispatch<F, Fut, R>(&self, task: F) -> VortexResult<JoinHandle<R>>

where F: FnOnce() -> Fut + Send + 'static, Fut: Future<Output = R> + 'static, R: Send + 'static,

Dispatch a new asynchronous task.

fn shutdown(self) -> VortexResult<()>

Gracefully shutdown the dispatcher, consuming it.