dcron

type AfterFunc func(task Task)

type Atomic interface {
	// SetIfNotExists stores the key/value and return true if the key is not existed,
	// or does nothing and return false.
	// Note that the key/value should be kept for at least one minute.
	// For example, `SetNX(key, value, time.Minute)` via redis.
	SetIfNotExists(ctx context.Context, key, value string) bool
}

type BeforeFunc func(task Task) (skip bool)

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

type CronMeta interface {
	// Key returns the unique key of the cron.
	Key() string
	// Hostname returns current hostname.
	Hostname() string
	// Statistics returns statistics info of the cron's all jobs.
	Statistics() Statistics
	// Jobs returns the cron's all jobs as JobMeta.
	Jobs() []JobMeta
}

type CronOption func(c *Cron)

type Group interface {
	// contains filtered or unexported methods
}

type Job interface {
	// Key returns the unique key of the job.
	Key() string
	// Spec returns spec of the job, like "* * * * * *".
	Spec() string
	// Run is what the job do.
	Run(ctx context.Context) error
	// Options returns options of the job.
	Options() []JobOption
}

type JobMeta interface {
	// Key returns the unique key of the job.
	Key() string
	// Spec returns the spec of the job.
	Spec() string
	// Statistics returns statistics info of the job.
	Statistics() Statistics
}

type JobOption func(job *innerJob)

type RetryInterval func(triedTimes int) time.Duration

type RunFunc func(ctx context.Context) error

type Statistics struct {
	TotalTask   int64 // Total count of tasks processed
	PassedTask  int64 // Number of tasks successfully executed
	FailedTask  int64 // Number of tasks that failed during execution due to errors
	SkippedTask int64 // Number of tasks skipped due to BeforeFunc returning true
	MissedTask  int64 // Number of tasks executed by other instances

	TotalRun   int64 // Total count of execution runs
	PassedRun  int64 // Number of successfully executed runs
	FailedRun  int64 // Number of runs that have failed due to errors
	RetriedRun int64 // Number of runs that encountered errors and were subsequently retried
}

type Task struct {
	Key        string
	Cron       CronMeta
	Job        JobMeta
	PlanAt     time.Time
	BeginAt    *time.Time
	EndAt      *time.Time
	Return     error
	Skipped    bool
	Missed     bool
	TriedTimes int
}