Struct ShutdownAwareTaskSpawner 

pub struct ShutdownAwareTaskSpawner { /* private fields */ }

Shutdown-aware task spawner

A wrapper around GracefulShutdown for spawning named tasks that respect shutdown signals. Provides logging and automatic cancellation on shutdown.

Example

use allframe_core::shutdown::{GracefulShutdown, ShutdownAwareTaskSpawner};
use std::sync::Arc;

#[tokio::main]
async fn main() {
    let shutdown = Arc::new(GracefulShutdown::new());
    let spawner = ShutdownAwareTaskSpawner::new(shutdown.clone());

    // Spawn a task that will be cancelled on shutdown
    spawner.spawn("my_task", || async {
        loop {
            tokio::time::sleep(std::time::Duration::from_secs(1)).await;
            println!("Working...");
        }
    });

    // Shutdown will cancel the spawned task
    shutdown.shutdown();
}

Implementations

impl ShutdownAwareTaskSpawner

pub fn new(shutdown: Arc<GracefulShutdown>) -> Self

Create a new shutdown-aware task spawner

pub fn shutdown(&self) -> &Arc<GracefulShutdown>

Get a reference to the underlying shutdown handler

pub fn spawn<F, Fut>(&self, task_name: &str, future: F) -> JoinHandle<()>

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

Spawn a task that will be cancelled on shutdown

The task will be logged when starting, completing, and cancelling.

pub fn spawn_background<F, Fut>( &self, task_name: &str, future: F, ) -> JoinHandle<()>

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

Spawn a long-running background task

This is an alias for spawn - both handle shutdown the same way. Use this to semantically indicate the task is intended to run for the lifetime of the application.

pub fn spawn_with_result<F, Fut, T>( &self, task_name: &str, future: F, ) -> JoinHandle<Option<T>>

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

Spawn a task and return its result (if it completes before shutdown)

Trait Implementations

impl Clone for ShutdownAwareTaskSpawner

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.