Skip to main content

TaskManager

Struct TaskManager 

Source
pub struct TaskManager { /* private fields */ }
Expand description

Server-side task store and executor for the SEP-2663 Tasks extension.

Cheaply cloneable; all clones share the same state.

§Retention

Entries are swept opportunistically on every spawn / get_task / update_task / cancel_task / running_task_count call: non-terminal tasks whose ttl_ms has elapsed are marked failed (their operation is aborted), and terminal tasks are evicted after being retained for one further ttl_ms window past their terminal transition so pollers can observe the final state.

Note that the retention window intentionally extends past the creation-based lifetime that ttl_ms advertises on the wire: a task that runs to its TTL deadline is marked failed around created + ttl_ms and stays observable until roughly created + 2 × ttl_ms. This is compliant — SEP-2663 lets servers delete expired tasks at any time after the TTL, so retaining them longer as an observation grace period is a server-side policy choice, not a wire-contract change. Clients may treat the task as unusable after createdAt + ttlMs regardless.

Tasks with ttl_ms: None are retained for the lifetime of the manager (spec: unlimited retention) — bound task creation or call Self::shutdown yourself if you spawn such tasks in a long-lived server. There is no background sweeper; an idle manager holds its entries until the next call.

Implementations§

Source§

impl TaskManager

Source

pub fn new() -> TaskManager

Source

pub fn spawn<F>(&self, options: TaskOptions, make_future: F) -> Task
where F: FnOnce(TaskContext) -> Pin<Box<dyn Future<Output = Result<CallToolResult, TaskExit>> + Send>>,

Spawn an operation as a task and return its seed Task state for a CreateTaskResult. The task is durably observable via Self::get_task before this method returns.

make_future receives a TaskContext for mid-task input requests, status messages, and cooperative cancellation checks.

Source

pub fn get_task(&self, task_id: &str) -> Result<DetailedTask, ErrorData>

Handle tasks/get: return the current DetailedTask state.

Source

pub fn update_task( &self, task_id: &str, input_responses: impl IntoIterator<Item = (String, Value)>, ) -> Result<(), ErrorData>

Handle tasks/update: deliver inputResponses to the running operation. Unknown, already-answered, or superseded keys are ignored per spec; a partial set of responses is accepted.

Source

pub fn cancel_task(&self, task_id: &str) -> Result<(), ErrorData>

Handle tasks/cancel: cooperative cancellation (SEP-2663).

Records the cancellation intent and acknowledges immediately, but does not abort the underlying future or force a terminal state. The operation observes cancellation via TaskContext::is_cancel_requested / TaskContext::cancelled, or via the error returned from a pending TaskContext::request_input call (whose response channel is dropped here), and decides its own terminal status:

  • stops with TaskExit::Cancelled → recorded as cancelled,
  • stops with TaskExit::Error → recorded as failed with the error inlined (a real failure after a cancel request is not masked),
  • finishes its work anyway → recorded as completed — per the spec, “the task may still reach a non-cancelled terminal status”.
Source

pub fn running_task_count(&self) -> usize

Number of tasks currently in a non-terminal state.

Source

pub fn shutdown(&self)

Abort all running tasks and clear all task state.

Trait Implementations§

Source§

impl Clone for TaskManager

Source§

fn clone(&self) -> TaskManager

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for TaskManager

Source§

fn default() -> TaskManager

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more