schedule

type Job interface {
	// Run starts running the task and blocks until the context is done or
	// an error occurs. Run may be called again after an error or timeout to
	// retry the job so implemententions must ensure that Run resets any
	// necessary state.
	Run(context.Context) error
}

type JobConfig struct {

	// Name is a human readable name for the job for use in logging
	Name string

	// Tasks is a list of tasks the job performs
	Tasks []string

	// Job is the job that will be executed.
	Job Job

	// Locker is an optional lock that must be taken before the job can execute.
	Locker Locker

	// RestartOnFailure controls whether the job should be restarted if it stops with an error.
	RestartOnFailure bool

	// RestartOnCompletion controls whether the job should be restarted if it stops without an error.
	RestartOnCompletion bool

	// RestartDelay is the amount of time to wait before restarting a stopped job
	RestartDelay time.Duration

	// Type is a human readable type for the job for use in logging.
	Type string

	// Params is a map of additional parameters that add human readable context to the job.
	Params map[string]string

	// StartedAt is the time the job started running.
	StartedAt time.Time

	// EndedAt is the time the job stopped running, either through successful completion or failure. Reset if job is restarted.
	EndedAt time.Time
	// contains filtered or unexported fields
}

type JobID int

type JobResult struct {
	ID    JobID
	Name  string
	Type  string
	Error string
	Tasks []string

	Running bool

	RestartOnFailure    bool
	RestartOnCompletion bool
	RestartDelay        time.Duration

	Params    map[string]string
	StartedAt time.Time
	EndedAt   time.Time
}

type Locker interface {
	Lock(context.Context) error
	Unlock(context.Context) error
}

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