Struct BackgroundTaskManager

pub struct BackgroundTaskManager {
    task_registry: Arc<RwLock<TaskRegistry>>,
}

A background task manager that can hold and manage multiple tasks. When dropped, it will abort all tasks. Graceful shutdown can be performed with graceful_shutdown

Fields

task_registry: Arc<RwLock<TaskRegistry>>

Implementations

impl BackgroundTaskManager

fn monitor_spawned_task( &self, handle: JoinHandle<Result<(), BridgeError>>, task_variant: TaskVariant, )

Monitors the spawned task. If any task stops running, logs the reason why and updates the task registry to register the task as not running.

async fn is_task_running(&self, variant: TaskVariant) -> bool

Checks if a task is running by checking the task registry

pub async fn get_stopped_tasks(&self) -> Result<StoppedTasks, BridgeError>

Gets all tasks that are not running Returns an error if the task status fetch takes too long

pub async fn get_task_status(&self, variant: TaskVariant) -> Option<TaskStatus>

Gets the status of a single task by checking the task registry

pub async fn ensure_task_looping<S, U: IntoTask<Task = S>>(&self, task: U)

where S: Task + Sized + Debug, <S as Task>::Output: Into<bool>,

Wraps the task in a cancelable loop and spawns it, registers it in the task registry. If a task with the same TaskVariant is already running, it will not be started.

async fn ensure_monitor_running(&self)

async fn send_cancel_signals(&self)

Sends cancel signals to all tasks that have a cancel_tx

pub fn abort_all(&mut self)

Abort all tasks by dropping their cancellation senders

pub async fn graceful_shutdown(&mut self)

Graceful shutdown of all tasks

This function does not have any timeout, please use graceful_shutdown_with_timeout instead for cases where you need a timeout. The function polls tasks until they are finished with a 100ms poll interval.

pub async fn graceful_shutdown_with_timeout(&mut self, timeout: Duration)

Graceful shutdown of all tasks with a timeout. All tasks will be aborted if the timeout is reached.

Arguments

• timeout - The timeout duration for the graceful shutdown. Since the graceful_shutdown function polls tasks until they are finished with a 100ms poll interval, the timeout should be at least 100ms for the timeout to be effective.

Trait Implementations

impl Debug for BackgroundTaskManager

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

Formats the value using the given formatter.

impl Default for BackgroundTaskManager

fn default() -> Self

Returns the “default value” for a type.

impl Drop for BackgroundTaskManager

fn drop(&mut self)

Executes the destructor for this type.