tache

package module
v0.1.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 4, 2025 License: MIT Imports: 14 Imported by: 6

README

tache

A task manager for golang

Documentation

Index

Constants

View Source 
const (
	// StatePending is the state of a task when it is pending
	StatePending = iota
	// StateRunning is the state of a task when it is running
	StateRunning
	// StateSucceeded is the state of a task when it succeeded
	StateSucceeded
	// StateCanceling is the state of a task when it is canceling
	StateCanceling
	// StateCanceled is the state of a task when it is canceled
	StateCanceled
	// StateErrored is the state of a task when it is errored (it will be retried)
	StateErrored
	// StateFailing is the state of a task when it is failing (executed OnFailed hook)
	StateFailing
	// StateFailed is the state of a task when it failed (no retry times left)
	StateFailed
	// StateWaitingRetry is the state of a task when it is waiting for retry
	StateWaitingRetry
	// StateBeforeRetry is the state of a task when it is executing OnBeforeRetry hook
	StateBeforeRetry
)

Variables

This section is empty.

Functions

func IsRecoverable 

func IsRecoverable(err error) bool

IsRecoverable checks if error is an instance of `unrecoverableError`

func NewErr 

func NewErr(msg string) error

NewErr creates a new TacheError

func Unrecoverable 

func Unrecoverable(err error) error

Unrecoverable wraps an error in `unrecoverableError` struct

Types

type Base 

type Base struct {
	ID       string `json:"id"`
	State    State  `json:"state"`
	Retry    int    `json:"retry"`
	MaxRetry int    `json:"max_retry"`
	// contains filtered or unexported fields
}

Base is the base struct for all tasks to implement TaskBase interface

func (*Base) AddSubtask added in v0.1.6 

func (b *Base) AddSubtask(subtask Task)

func (*Base) Cancel 

func (b *Base) Cancel()

func (*Base) Ctx 

func (b *Base) Ctx() context.Context

func (*Base) CtxDone 

func (b *Base) CtxDone() <-chan struct{}

func (*Base) ExecuteSubtasks added in v0.1.6 

func (b *Base) ExecuteSubtasks() error

func (*Base) GetErr 

func (b *Base) GetErr() error

func (*Base) GetID 

func (b *Base) GetID() string

func (*Base) GetManager added in v0.1.6 

func (b *Base) GetManager() IManager

func (*Base) GetParent added in v0.1.6 

func (b *Base) GetParent() Task

func (*Base) GetProgress 

func (b *Base) GetProgress() float64

func (*Base) GetRetry 

func (b *Base) GetRetry() (int, int)

func (*Base) GetSelf added in v0.1.6 

func (b *Base) GetSelf() Task

func (*Base) GetState 

func (b *Base) GetState() State

func (*Base) GetSubtasks added in v0.1.6 

func (b *Base) GetSubtasks() []Task

func (*Base) GetWorker added in v0.1.6 

func (b *Base) GetWorker() *Worker

func (*Base) Persist 

func (b *Base) Persist()

func (*Base) SetCancelFunc 

func (b *Base) SetCancelFunc(cancelFunc context.CancelFunc)

func (*Base) SetCtx 

func (b *Base) SetCtx(ctx context.Context)

func (*Base) SetErr 

func (b *Base) SetErr(err error)

func (*Base) SetID 

func (b *Base) SetID(id string)

func (*Base) SetManager added in v0.1.6 

func (b *Base) SetManager(manager IManager)

func (*Base) SetParent added in v0.1.6 

func (b *Base) SetParent(parent Task)

func (*Base) SetPersist 

func (b *Base) SetPersist(persist func())

func (*Base) SetProgress 

func (b *Base) SetProgress(progress float64)

func (*Base) SetRetry 

func (b *Base) SetRetry(retry int, maxRetry int)

func (*Base) SetState 

func (b *Base) SetState(state State)

func (*Base) SetWorker added in v0.1.6 

func (b *Base) SetWorker(worker *Worker)

func (*Base) Wait added in v0.1.6 

func (b *Base) Wait()

Wait waits for the task to complete, can be called multiple times

type IManager added in v0.1.6 

type IManager interface {
	GenerateID() string
	SaveSubTask(subtask Task)
	GetByIDAll(id string) Task
}

type Info 

type Info interface {
	NamedTask
	StatusTask
}

type Manager 

type Manager[T Task] struct {
	// contains filtered or unexported fields
}

Manager is the manager of all tasks

func NewManager 

func NewManager[T Task](opts ...Option) *Manager[T]

NewManager create a new manager

func (*Manager[T]) Add 

func (m *Manager[T]) Add(task T)

Add a task to manager

func (*Manager[T]) Cancel 

func (m *Manager[T]) Cancel(id string)

Cancel a task by ID

func (*Manager[T]) CancelAll 

func (m *Manager[T]) CancelAll()

CancelAll cancel all tasks, just cancel all root tasks is enough because all subtasks will be canceled by their parent tasks

func (*Manager[T]) CancelByCondition added in v0.1.3 

func (m *Manager[T]) CancelByCondition(condition func(task T) bool)

CancelByCondition cancel tasks under specific condition given by a function

func (*Manager[T]) GenerateID added in v0.1.6 

func (m *Manager[T]) GenerateID() string

func (*Manager[T]) GetAll 

func (m *Manager[T]) GetAll() []T

deprecated: use GetRootTasks instead GetAll get all tasks

func (*Manager[T]) GetByCondition added in v0.1.3 

func (m *Manager[T]) GetByCondition(condition func(task T) bool) []T

GetByCondition get tasks under specific condition given by a function

func (*Manager[T]) GetByID 

func (m *Manager[T]) GetByID(id string) (T, bool)

GetByID get task by ID

func (*Manager[T]) GetByIDAll added in v0.1.6 

func (m *Manager[T]) GetByIDAll(id string) Task

GetByIDAll gets the task by ID, including subtasks

func (*Manager[T]) GetByState 

func (m *Manager[T]) GetByState(state ...State) []T

GetByState get tasks by state

func (*Manager[T]) GetRootTasks added in v0.1.6 

func (m *Manager[T]) GetRootTasks() []T

GetRootTasks gets all root tasks (tasks without parents)

func (*Manager[T]) GetTaskTrees added in v0.1.6 

func (m *Manager[T]) GetTaskTrees() []*TaskTree

GetTaskTrees gets all tasks in tree structure

func (*Manager[T]) GetTreeByID added in v0.1.6 

func (m *Manager[T]) GetTreeByID(id string) *TaskTree

GetTreeByID gets the task tree by root task ID

func (*Manager[T]) Pause 

func (m *Manager[T]) Pause()

Pause manager

func (*Manager[T]) Remove 

func (m *Manager[T]) Remove(id string)

Remove a task by ID

func (*Manager[T]) RemoveAll 

func (m *Manager[T]) RemoveAll()

RemoveAll remove all tasks

func (*Manager[T]) RemoveByCondition added in v0.1.3 

func (m *Manager[T]) RemoveByCondition(condition func(task T) bool)

RemoveByCondition remove tasks under specific condition given by a function

func (*Manager[T]) RemoveByState 

func (m *Manager[T]) RemoveByState(state ...State)

RemoveByState remove tasks by state

func (*Manager[T]) Retry 

func (m *Manager[T]) Retry(id string)

Retry a task by ID

func (*Manager[T]) RetryAllFailed 

func (m *Manager[T]) RetryAllFailed()

RetryAllFailed retry all failed tasks

func (*Manager[T]) SaveSubTask added in v0.1.6 

func (m *Manager[T]) SaveSubTask(subtask Task)

func (*Manager[T]) SetWorkersNumActive added in v0.1.4 

func (m *Manager[T]) SetWorkersNumActive(active int64)

func (*Manager[T]) Start 

func (m *Manager[T]) Start()

Start manager

func (*Manager[T]) Wait 

func (m *Manager[T]) Wait()

Wait wait all tasks done, just for test

func (*Manager[T]) WaitByID added in v0.1.6 

func (m *Manager[T]) WaitByID(id string)

WaitByID waits for a task by ID to complete

type NamedTask added in v0.1.6 

type NamedTask interface {
	GetName() string
}

type OnBeforeRetry 

type OnBeforeRetry interface {
	OnBeforeRetry()
}

OnBeforeRetry is the interface for tasks that need to be executed before retrying

type OnFailed 

type OnFailed interface {
	OnFailed()
}

OnFailed is the interface for tasks that need to be executed when they fail

type OnSucceeded 

type OnSucceeded interface {
	OnSucceeded()
}

OnSucceeded is the interface for tasks that need to be executed when they succeed

type Option 

type Option func(*Options)

Option is the option for manager

func WithLogger 

func WithLogger(logger *slog.Logger) Option

WithLogger set logger

func WithMaxRetry 

func WithMaxRetry(maxRetry int) Option

WithMaxRetry set retry

func WithOptions 

func WithOptions(opts Options) Option

WithOptions set options

func WithPersistDebounce 

func WithPersistDebounce(debounce time.Duration) Option

WithPersistDebounce set persist debounce

func WithPersistFunction added in v0.1.2 

func WithPersistFunction(r func() ([]byte, error), w func([]byte) error) Option

func WithPersistPath 

func WithPersistPath(path string) Option

WithPersistPath set persist path

func WithRunning 

func WithRunning(running bool) Option

WithRunning set running

func WithTimeout 

func WithTimeout(timeout time.Duration) Option

WithTimeout set timeout

func WithWorks 

func WithWorks(works int) Option

WithWorks set works

type Options 

type Options struct {
	Works                int
	MaxRetry             int
	Timeout              *time.Duration
	PersistPath          string
	PersistDebounce      *time.Duration
	Running              bool
	Logger               *slog.Logger
	PersistReadFunction  func() ([]byte, error)
	PersistWriteFunction func([]byte) error
}

Options is the options for manager

func DefaultOptions 

func DefaultOptions() *Options

DefaultOptions returns default options

type Persistable 

type Persistable interface {
	Persistable() bool
}

Persistable judge whether the task is persistable

type Recoverable 

type Recoverable interface {
	Recoverable() bool
}

Recoverable judge whether the task is recoverable

type Retryable 

type Retryable interface {
	Retryable() bool
}

Retryable judge whether the task is retryable

type State 

type State int

State is the state of a task

type StatusTask added in v0.1.6 

type StatusTask interface {
	GetStatus() string
}

type TacheError 

type TacheError struct {
	Msg string
}

TacheError is a custom error type

func (*TacheError) Error 

func (e *TacheError) Error() string

type Task 

type Task interface {
	TaskBase
	Run() error
}

Task is the interface for all tasks

type TaskBase 

type TaskBase interface {
	// SetProgress sets the progress of the task
	SetProgress(progress float64)
	// GetProgress gets the progress of the task
	GetProgress() float64
	// SetState sets the state of the task
	SetState(state State)
	// GetState gets the state of the task
	GetState() State
	// GetID gets the ID of the task
	GetID() string
	// SetID sets the ID of the task
	SetID(id string)
	// SetErr sets the error of the task
	SetErr(err error)
	// GetErr gets the error of the task
	GetErr() error
	// SetCtx sets the context of the task
	SetCtx(ctx context.Context)
	// CtxDone gets the context done channel of the task
	CtxDone() <-chan struct{}
	// Cancel cancels the task
	Cancel()
	// Ctx gets the context of the task
	Ctx() context.Context
	// SetCancelFunc sets the cancel function of the task
	SetCancelFunc(cancelFunc context.CancelFunc)
	// GetRetry gets the retry of the task
	GetRetry() (int, int)
	// SetRetry sets the retry of the task
	SetRetry(retry int, maxRetry int)
	// Persist persists the task
	Persist()
	// SetPersist sets the persist function of the task
	SetPersist(persist func())
	// SetWorker sets the worker of the task
	SetWorker(worker *Worker)
	// GetWorker gets the worker of the task
	GetWorker() *Worker
	// AddSubtask adds a subtask to the current task
	AddSubtask(subtask Task)
	// GetSubtasks gets all subtasks of the current task
	GetSubtasks() []Task
	// GetParent gets the parent task of the current task
	GetParent() Task
	// SetParent sets the parent task of the current task
	SetParent(parent Task)
	// ExecuteSubtasks executes all subtasks and waits for them to complete
	ExecuteSubtasks() error
	// GetManager gets the manager of the current task
	GetManager() IManager
	// SetManager sets the manager of the current task
	SetManager(manager IManager)
	// GetSelf gets the self task of the current task
	GetSelf() Task
	// Wait waits for the task to complete, can be called multiple times
	Wait()
}

TaskBase is the base interface for all tasks

type TaskTree added in v0.1.6 

type TaskTree struct {
	Task     Task        `json:"task"`
	Subtasks []*TaskTree `json:"subtasks"`
}

TaskTree represents a task in tree structure

type TaskWithInfo 

type TaskWithInfo interface {
	Task
	Info
}

type Worker 

type Worker struct {
	ID int
}

Worker is the worker to execute task

func (Worker) Execute 

func (w Worker) Execute(task Task)

Execute executes the task

type WorkerPool 

type WorkerPool struct {
	// contains filtered or unexported fields
}

WorkerPool is the pool of workers

func NewWorkerPool 

func NewWorkerPool(size int) *WorkerPool

NewWorkerPool creates a new worker pool

func (*WorkerPool) Get 

func (wp *WorkerPool) Get() *Worker

Get gets a worker from pool

func (*WorkerPool) Put 

func (wp *WorkerPool) Put(worker *Worker)

Put puts a worker back to pool

func (*WorkerPool) SetNumActive added in v0.1.4 

func (wp *WorkerPool) SetNumActive(active int64)

Source Files

View all Source files

Directories

Path Synopsis
examples
base

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.