Skip to content

Tasks

Related guidance: concepts/tasks, how-to/receive-local-tasks, how-to/dispatch-local-tasks, quickstarts/effector-handler.

Runnable examples: receive_task.py, dispatch_task.py, receive_mesh_task.py, dispatch_mesh_task.py.

SymbolSummary
TasksRegister typed handlers and dispatch typed requests.
TaskHandlerAn async request-only or context-and-request task handler.
RequestTaskHandlerHandle a validated task request without dispatch context.
ContextTaskHandlerHandle a validated task request together with its dispatch context.
TaskDispatchResultA task result, acknowledgment, or dispatch receipt selected by task mode.
TaskRequestContextDescribe the local context supplied to a registered task handler.
TaskAcknowledgementReport whether a task request was accepted.
TaskResultCarry a typed or JSON-object task result and its reported status.
TaskRegistrationDescribe one local task-handler registration.
DispatchReceiptConfirm broker acceptance of a fire-and-forget task dispatch.
TaskModeSelect the requested task completion behavior.
TaskStatusDescribe a task result’s reported state.

Version 0.2.0 · branch main