Struct cfx_tasks::TaskExecutor

pub struct TaskExecutor { /* private fields */ }

A type that can spawn new tokio tasks

Implementations

impl TaskExecutor

pub const fn handle(&self) -> &Handle

Returns the [Handle] to the tokio runtime.

pub const fn on_shutdown_signal(&self) -> &Shutdown

Returns the receiver of the shutdown signal.

pub fn spawn<F>(&self, fut: F) -> JoinHandle<()>

where F: Future<Output = ()> + Send + 'static,

Spawns the task onto the runtime. The given future resolves as soon as the Shutdown signal is received.

See also [Handle::spawn].

pub fn spawn_blocking<F>(&self, fut: F) -> JoinHandle<()>

where F: Future<Output = ()> + Send + 'static,

Spawns a blocking task onto the runtime. The given future resolves as soon as the Shutdown signal is received.

See also [Handle::spawn_blocking].

pub fn spawn_with_signal<F>( &self, f: impl FnOnce(Shutdown) -> F ) -> JoinHandle<()>

where F: Future<Output = ()> + Send + 'static,

Spawns the task onto the runtime. The given future resolves as soon as the Shutdown signal is received.

See also [Handle::spawn].

pub fn spawn_critical_blocking<F>( &self, name: &'static str, fut: F ) -> JoinHandle<()>

where F: Future<Output = ()> + Send + 'static,

This spawns a critical blocking task onto the runtime. The given future resolves as soon as the Shutdown signal is received.

If this task panics, the TaskManager is notified.

pub fn spawn_critical<F>(&self, name: &'static str, fut: F) -> JoinHandle<()>

where F: Future<Output = ()> + Send + 'static,

This spawns a critical task onto the runtime. The given future resolves as soon as the Shutdown signal is received.

If this task panics, the TaskManager is notified.

pub fn spawn_critical_with_shutdown_signal<F>( &self, name: &'static str, f: impl FnOnce(Shutdown) -> F ) -> JoinHandle<()>

where F: Future<Output = ()> + Send + 'static,

This spawns a critical task onto the runtime.

If this task panics, the TaskManager is notified.

pub fn spawn_critical_with_graceful_shutdown_signal<F>( &self, name: &'static str, f: impl FnOnce(GracefulShutdown) -> F ) -> JoinHandle<()>

where F: Future<Output = ()> + Send + 'static,

This spawns a critical task onto the runtime.

If this task panics, the TaskManager is notified. The TaskManager will wait until the given future has completed before shutting down.

Example

executor.spawn_critical_with_graceful_shutdown_signal(
    "grace",
    |shutdown| async move {
        // await the shutdown signal
        let guard = shutdown.await;
        // do work before exiting the program
        tokio::time::sleep(std::time::Duration::from_secs(1)).await;
        // allow graceful shutdown
        drop(guard);
    },
);

pub fn spawn_with_graceful_shutdown_signal<F>( &self, f: impl FnOnce(GracefulShutdown) -> F ) -> JoinHandle<()>

where F: Future<Output = ()> + Send + 'static,

This spawns a regular task onto the runtime.

The TaskManager will wait until the given future has completed before shutting down.

Example

executor.spawn_with_graceful_shutdown_signal(|shutdown| async move {
    // await the shutdown signal
    let guard = shutdown.await;
    // do work before exiting the program
    tokio::time::sleep(std::time::Duration::from_secs(1)).await;
    // allow graceful shutdown
    drop(guard);
});

Trait Implementations

impl Clone for TaskExecutor

fn clone(&self) -> TaskExecutor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TaskExecutor

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

Formats the value using the given formatter.

impl TaskSpawner for TaskExecutor

fn spawn(&self, fut: BoxFuture<'static, ()>) -> JoinHandle<()>

Spawns the task onto the runtime. See also [Handle::spawn].

fn spawn_critical( &self, name: &'static str, fut: BoxFuture<'static, ()> ) -> JoinHandle<()>

This spawns a critical task onto the runtime.

fn spawn_blocking(&self, fut: BoxFuture<'static, ()>) -> JoinHandle<()>

Spawns a blocking task onto the runtime.

fn spawn_critical_blocking( &self, name: &'static str, fut: BoxFuture<'static, ()> ) -> JoinHandle<()>

This spawns a critical blocking task onto the runtime.

impl TaskSpawnerExt for TaskExecutor

fn spawn_critical_with_graceful_shutdown_signal<F>( &self, name: &'static str, f: impl FnOnce(GracefulShutdown) -> F ) -> JoinHandle<()>

where F: Future<Output = ()> + Send + 'static,

This spawns a critical task onto the runtime.

fn spawn_with_graceful_shutdown_signal<F>( &self, f: impl FnOnce(GracefulShutdown) -> F ) -> JoinHandle<()>

where F: Future<Output = ()> + Send + 'static,

This spawns a regular task onto the runtime.