task

README

Task module

Task runner

Files: task_config.go, task_runner.go, task_test.go, task.go

Task scheduler is a simple scheduler that runs tasks in a given interval. It is used to run tasks that need to be run periodically.

Job queue

Files: job_queue.go

Job queue is a simple queue that can be used to queue jobs that need to be run in a separate goroutine.

Retry logic

File: retry.go

This file has a single Retry function which retries the given config if it fails.

Command runner

TODO

Documentation

Index

• func Retry(ctx context.Context, maxRetry int, callback RetryCallback, ...) (err error)
• type Handler
• type Job
• type JobHandler
• type JobQueue
  • func NewJobQueue(size int) *JobQueue
  • func (q *JobQueue) Close() error
  • func (q *JobQueue) Queue(job JobHandler, arg ...any)
• type RetryBackoff
• type RetryCallback
• type Task
  • func (t *Task) Args() []any
  • func (t *Task) Elapsed() time.Duration
  • func (t *Task) Id() uuid.UUID
  • func (t *Task) Stop()
• type TaskConfig
  • func Every(interval ...int) *TaskConfig
  • func Once() *TaskConfig
  • func (c *TaskConfig) After(interval time.Duration) *TaskConfig
  • func (c *TaskConfig) At(hour, minute int) *TaskConfig
  • func (c *TaskConfig) Day() *TaskConfig
  • func (c *TaskConfig) Days() *TaskConfig
  • func (c *TaskConfig) Do(f Handler, args ...any) (r *TaskRunner, err error)
  • func (c *TaskConfig) Friday() *TaskConfig
  • func (c *TaskConfig) From(from time.Time) *TaskConfig
  • func (c *TaskConfig) Hour() *TaskConfig
  • func (c *TaskConfig) Hours() *TaskConfig
  • func (c *TaskConfig) Millisecond() *TaskConfig
  • func (c *TaskConfig) Milliseconds() *TaskConfig
  • func (c *TaskConfig) Minute() *TaskConfig
  • func (c *TaskConfig) Minutes() *TaskConfig
  • func (c *TaskConfig) Monday() *TaskConfig
  • func (c *TaskConfig) OnBeforeStart(f Handler) *TaskConfig
  • func (c *TaskConfig) OnFinish(f Handler) *TaskConfig
  • func (c *TaskConfig) Saturday() *TaskConfig
  • func (c *TaskConfig) Second() *TaskConfig
  • func (c *TaskConfig) Seconds() *TaskConfig
  • func (c *TaskConfig) Sunday() *TaskConfig
  • func (c *TaskConfig) Thursday() *TaskConfig
  • func (c *TaskConfig) To(to time.Time) *TaskConfig
  • func (c *TaskConfig) Tuesday() *TaskConfig
  • func (c *TaskConfig) Wednesday() *TaskConfig
  • func (c *TaskConfig) Week() *TaskConfig
  • func (c *TaskConfig) Weeks() *TaskConfig
• type TaskRunner
  • func (r *TaskRunner) Close() error

Functions

func Retry

func Retry(
	ctx context.Context,
	maxRetry int,
	callback RetryCallback,
	backoff RetryBackoff,
	errHook func(err error),
) (err error)

Types

type Handler

type Handler func(*Task) error

type Job

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

type JobHandler

type JobHandler func(ctx context.Context, arg any) error

type JobQueue

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

func NewJobQueue

func NewJobQueue(size int) *JobQueue

func (*JobQueue) Close

func (q *JobQueue) Close() error

Close closes the queue and waits for all jobs to finish

func (*JobQueue) Queue

func (q *JobQueue) Queue(job JobHandler, arg ...any)

Queue adds a new job to the queue

type RetryBackoff

type RetryBackoff func(retry int) time.Duration

type RetryCallback

type RetryCallback func(count int) (stop bool, err error)

type Task

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

Task is passed to task handlers and contains the payload

func (*Task) Args

func (t *Task) Args() []any

Args returns the task arguments.

func (*Task) Elapsed

func (t *Task) Elapsed() time.Duration

Elapsed returns the time elapsed since the last run.

func (*Task) Id

func (t *Task) Id() uuid.UUID

Id returns the task id.

func (*Task) Stop

func (t *Task) Stop()

Stop stops the task.

type TaskConfig

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

TaskConfig is responsible for configuring a task and scheduling it.

func Every

func Every(interval ...int) *TaskConfig

Every begins configuring a task. supply zero or one intervals. no intervals will be counted as 1

func Once

func Once() *TaskConfig

Once begins configuring a task. sets the task to run only once. use Config.After or TaskConfig.From to set the time.

func (*TaskConfig) After

func (c *TaskConfig) After(interval time.Duration) *TaskConfig

After starts the task after the specified duration. Short hand for From(time.Now().Add(interval))

func (*TaskConfig) At

func (c *TaskConfig) At(hour, minute int) *TaskConfig

At sets the time of day to run the task.

func (*TaskConfig) Day

func (c *TaskConfig) Day() *TaskConfig

Day sets the interval to days.

func (*TaskConfig) Days

func (c *TaskConfig) Days() *TaskConfig

Days is same as Day.

func (*TaskConfig) Do

func (c *TaskConfig) Do(f Handler, args ...any) (r *TaskRunner, err error)

Do run the task with the supplied payload in a new goroutine.

func (*TaskConfig) Friday

func (c *TaskConfig) Friday() *TaskConfig

Friday sets the unit to weeks and only runs on Fridays.

func (*TaskConfig) From

func (c *TaskConfig) From(from time.Time) *TaskConfig

From sets the run time of the task.

func (*TaskConfig) Hour

func (c *TaskConfig) Hour() *TaskConfig

Hour sets the interval to hours.

func (*TaskConfig) Hours

func (c *TaskConfig) Hours() *TaskConfig

Hours is same as Hour.

func (*TaskConfig) Millisecond

func (c *TaskConfig) Millisecond() *TaskConfig

Millisecond sets the interval to milliseconds.

func (*TaskConfig) Milliseconds

func (c *TaskConfig) Milliseconds() *TaskConfig

Milliseconds is same as Millisecond.

func (*TaskConfig) Minute

func (c *TaskConfig) Minute() *TaskConfig

Minute sets the interval to minutes.

func (*TaskConfig) Minutes

func (c *TaskConfig) Minutes() *TaskConfig

Minutes is same as Minute.

func (*TaskConfig) Monday

func (c *TaskConfig) Monday() *TaskConfig

Monday sets the unit to weeks and only runs on Mondays.

func (*TaskConfig) OnBeforeStart

func (c *TaskConfig) OnBeforeStart(f Handler) *TaskConfig

OnBeforeStart sets the handler to be called before the task starts.

func (*TaskConfig) OnFinish

func (c *TaskConfig) OnFinish(f Handler) *TaskConfig

OnFinish sets the finish handler for the task.

func (*TaskConfig) Saturday

func (c *TaskConfig) Saturday() *TaskConfig

Saturday sets the unit to weeks and only runs on Saturdays.

func (*TaskConfig) Second

func (c *TaskConfig) Second() *TaskConfig

Second sets the interval to seconds.

func (*TaskConfig) Seconds

func (c *TaskConfig) Seconds() *TaskConfig

Seconds is same as Second.

func (*TaskConfig) Sunday

func (c *TaskConfig) Sunday() *TaskConfig

Sunday sets the unit to weeks and only runs on Sundays.

func (*TaskConfig) Thursday

func (c *TaskConfig) Thursday() *TaskConfig

Thursday sets the unit to weeks and only runs on Thursdays.

func (*TaskConfig) To

func (c *TaskConfig) To(to time.Time) *TaskConfig

To sets the end time of the task.

func (*TaskConfig) Tuesday

func (c *TaskConfig) Tuesday() *TaskConfig

Tuesday sets the unit to weeks and only runs on Tuesdays.

func (*TaskConfig) Wednesday

func (c *TaskConfig) Wednesday() *TaskConfig

Wednesday sets the unit to weeks and only runs on Wednesdays.

func (*TaskConfig) Week

func (c *TaskConfig) Week() *TaskConfig

Week sets the interval to weeks.

func (*TaskConfig) Weeks

func (c *TaskConfig) Weeks() *TaskConfig

Weeks is same as Week.

type TaskRunner

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

TaskRunner is responsible for running the task given to them

func (*TaskRunner) Close

func (r *TaskRunner) Close() error

Close closes the task runner.