import "code.gitea.io/gitea/modules/cron"
cron.go setting.go tasks.go tasks_basic.go tasks_extended.go
func NewContext()
NewContext begins cron tasks Each cron task is run within the shutdown context as a running server AtShutdown the cron server is stopped
func RegisterTask(name string, config Config, fun func(context.Context, *models.User, Config) error) error
RegisterTask allows a task to be registered with the cron service
func RegisterTaskFatal(name string, config Config, fun func(context.Context, *models.User, Config) error)
RegisterTaskFatal will register a task but if there is an error log.Fatal
BaseConfig represents the basic config for a Cron task
func (b *BaseConfig) DoNoticeOnSuccess() bool
DoNoticeOnSuccess returns whether a success notice should be posted
func (b *BaseConfig) DoRunAtStart() bool
DoRunAtStart returns whether the task should be run at the start
func (b *BaseConfig) FormatMessage(name, status string, doer *models.User, args ...interface{}) string
FormatMessage returns a message for the task
func (b *BaseConfig) GetSchedule() string
GetSchedule returns the schedule for the base config
func (b *BaseConfig) IsEnabled() bool
IsEnabled returns the enabled status for the config
type Config interface { IsEnabled() bool DoRunAtStart() bool GetSchedule() string FormatMessage(name, status string, doer *models.User, args ...interface{}) string DoNoticeOnSuccess() bool }
Config represents a basic configuration interface that cron task
type OlderThanConfig struct { BaseConfig OlderThan time.Duration }
OlderThanConfig represents a cron task with OlderThan setting
Task represents a Cron task
GetTask gets the named task
DoRunAtStart returns if this task should run at the start
GetConfig will return a copy of the task's config
IsEnabled returns if this task is enabled as cron task
Run will run the task incrementing the cron counter with no user defined
RunWithUser will run the task incrementing the cron counter at the time with User
type TaskTable []*TaskTableRow
TaskTable represents a table of tasks
ListTasks returns all running cron tasks.
TaskTableRow represents a task row in the tasks table
type UpdateExistingConfig struct { BaseConfig UpdateExisting bool }
UpdateExistingConfig represents a cron task with UpdateExisting setting
Package cron imports 16 packages (graph) and is imported by 58 packages. Updated 2020-12-30. Refresh now. Tools for package owners.