mirror of
https://github.com/navidrome/navidrome.git
synced 2026-03-02 05:46:24 -05:00
34 lines
1.3 KiB
Go
34 lines
1.3 KiB
Go
package capabilities
|
|
|
|
// TaskWorker provides task execution handling.
|
|
// This capability allows plugins to receive callbacks when their queued tasks
|
|
// are ready to execute. Plugins that use the taskqueue host service must
|
|
// implement this capability.
|
|
//
|
|
//nd:capability name=taskworker
|
|
type TaskWorker interface {
|
|
// OnTaskExecute is called when a queued task is ready to run.
|
|
// Return an error to trigger retry (if retries are configured).
|
|
//nd:export name=nd_task_execute
|
|
OnTaskExecute(TaskExecuteRequest) (TaskExecuteResponse, error)
|
|
}
|
|
|
|
// TaskExecuteRequest is the request provided when a task is ready to execute.
|
|
type TaskExecuteRequest struct {
|
|
// QueueName is the name of the queue this task belongs to.
|
|
QueueName string `json:"queueName"`
|
|
// TaskID is the unique identifier for this task.
|
|
TaskID string `json:"taskId"`
|
|
// Payload is the opaque data provided when the task was enqueued.
|
|
Payload []byte `json:"payload"`
|
|
// Attempt is the current attempt number (1-based: first attempt = 1).
|
|
Attempt int32 `json:"attempt"`
|
|
}
|
|
|
|
// TaskExecuteResponse is the response from task execution.
|
|
type TaskExecuteResponse struct {
|
|
// Error, if non-empty, indicates the task failed. The task will be retried
|
|
// if retries are configured and attempts remain.
|
|
Error string `json:"error,omitempty"`
|
|
}
|