scheduler

Documentation

Index

• Variables
• type Options
• type Scheduler
  • func New(opts Options) Scheduler
• type TaskDefinition
• type TaskFunc
• type TaskOptions

Variables

var (
	ErrTaskAlreadyExists        = errors.New("task already exists")
	ErrTaskNotFound             = errors.New("task not found")
	ErrIntervalTimeoutBothSet   = errors.New("only one of Interval or Timeout must be set")
	ErrIntervalTimeoutNoneSet   = errors.New("either Interval or Timeout must be set")
	ErrTaskFuncNotSet           = errors.New("TaskFunc must be set")
	ErrIntervalDurationTooShort = errors.New("interval duration must be greater than 1 second")
	ErrTimeoutDurationTooShort  = errors.New("timeout duration must be greater than 1 second")
	ErrSchedulerRunning         = errors.New("scheduler is already running")
	ErrSchedulerNotRunning      = errors.New("scheduler is not running")
)

Types

type Options

type Options struct {
	Interval time.Duration
	Logger   *zap.Logger
	AutoRun  bool
}

type Scheduler

type Scheduler interface {
	Start() error
	Stop()
	Running() bool
	GetTask(string) (TaskDefinition, bool)
	ScheduleTask(string, TaskOptions) error
	StopTask(string) error
	TotalTasks() int
}

func New

func New(opts Options) Scheduler

type TaskDefinition

type TaskDefinition struct {
	Name string
	Func TaskFunc
	// contains filtered or unexported fields
}

type TaskFunc

type TaskFunc func(context.Context)

type TaskOptions

type TaskOptions struct {
	// Interval is the time between each task run.
	// Timeout OR Interval must be set.
	Interval time.Duration
	// Timeout is the maximum time the task is allowed to run
	// before it is forcefully stopped.
	// Timeout OR Interval must be set.
	Timeout time.Duration
	// Overwrite indicates whether to overwrite the task if it already exists.
	// If set to false, an error will be returned if the task already exists.
	// If set to true, the task will be overwritten with the new task and any existing timers will be reset.
	Overwrite bool
	// TaskFunc is the function to run when the task is scheduled.
	TaskFunc TaskFunc
}