Struct TaskManager 

pub struct TaskManager { /* private fields */ }

Background task manager.

Manages the lifecycle of background tasks including submission, status tracking, and cancellation.

Implementations

impl TaskManager

pub fn new() -> TaskManager

Creates a new task manager.

pub fn with_list_changed_notifications() -> TaskManager

Creates a new task manager with list change notifications enabled.

pub fn new_for_testing() -> TaskManager

Creates a task manager configured for deterministic tests.

Tasks are not executed automatically; tests can drive state manually.

pub fn into_shared(self) -> Arc<TaskManager>

Converts this manager into a shared handle.

pub fn has_list_changed_notifications(&self) -> bool

Returns whether list change notifications are enabled.

pub fn set_notification_sender( &self, sender: Arc<dyn Fn(JsonRpcRequest) + Send + Sync>, )

Sets the notification sender for task status updates.

pub fn register_handler<F, Fut>(&self, task_type: impl Into<String>, handler: F)

where F: Fn(&Cx, Value) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<Value, McpError>> + Send + 'static,

Registers a task handler for a specific task type.

The handler will be invoked when a task of this type is submitted.

pub fn submit( &self, _cx: &Cx, task_type: impl Into<String>, params: Option<Value>, ) -> Result<TaskId, McpError>

Submits a new background task.

Returns the task ID for tracking. The task runs asynchronously in the background region.

pub fn start_task(&self, task_id: &TaskId) -> Result<(), McpError>

Starts execution of a pending task.

This is called internally to transition a task from Pending to Running.

pub fn update_progress( &self, task_id: &TaskId, progress: f64, message: Option<String>, )

Updates progress for a running task.

pub fn complete_task(&self, task_id: &TaskId, data: Value)

Completes a task with a successful result.

pub fn fail_task(&self, task_id: &TaskId, error: impl Into<String>)

Fails a task with an error.

pub fn get_info(&self, task_id: &TaskId) -> Option<TaskInfo>

Gets information about a task.

pub fn get_result(&self, task_id: &TaskId) -> Option<TaskResult>

Gets the result of a completed task.

pub fn list_tasks(&self, status_filter: Option<TaskStatus>) -> Vec<TaskInfo>

Lists all tasks, optionally filtered by status.

pub fn cancel( &self, task_id: &TaskId, reason: Option<String>, ) -> Result<TaskInfo, McpError>

Requests cancellation of a task.

Returns true if the task exists and cancellation was requested. The task may still be running until it checks for cancellation.

pub fn is_cancel_requested(&self, task_id: &TaskId) -> bool

Checks if cancellation has been requested for a task.

pub fn active_count(&self) -> usize

Returns the number of active (non-terminal) tasks.

pub fn total_count(&self) -> usize

Returns the total number of tasks.

pub fn cleanup_completed(&self, max_age: Duration)

Removes completed tasks older than the specified duration.

This is useful for preventing unbounded memory growth from completed tasks.

Trait Implementations

impl Debug for TaskManager

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

Formats the value using the given formatter.

impl Default for TaskManager

fn default() -> TaskManager

Returns the “default value” for a type.