crontab

package

v1.1.208 Latest Latest Go to latest Published: Mar 5, 2026 License: MIT Imports: 19 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/celsiainternet/elvis

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func AddCronJob(tag, spec string, repetitions int, started bool, params et.Json, ...) error
func AddEventJob(tag, spec string, repetitions int, started bool, params et.Json, ...) error
func AddScheduleJob(tag, schedule string, started bool, params et.Json, fn func(event.EvenMessage)) error
func Close()
func DeleteJob(tag string) error
func HttpGet(w http.ResponseWriter, r *http.Request)
func HttpStart(w http.ResponseWriter, r *http.Request)
func HttpStop(w http.ResponseWriter, r *http.Request)
func Load(db *jdb.DB, schemaName, tag string) error
func SetLoadInstance(fn LoadInstanceFn)
func SetSaveInstance(fn SaveInstanceFn)
func StartJob(tag string) error
func Stop() error
func StopJob(tag string) error
type Job
- func (s *Job) Finish()
- func (s *Job) Save() error
- func (s *Job) Start() error
- func (s *Job) Stop()
- func (s *Job) ToJson() et.Json
type JobStatus
type Jobs
- func New(tag string) *Jobs
type LoadInstanceFn
type SaveInstanceFn
type TypeJob

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	EVENT_CRONTAB_SET    = "event:crontab:set"
	EVENT_CRONTAB_DELETE = "event:crontab:delete"
	EVENT_CRONTAB_STOP   = "event:crontab:stop"
	EVENT_CRONTAB_START  = "event:crontab:start"
)

View Source

var (
	ErrJobExists = fmt.Errorf("job already exists")
)

View Source

var (
	MSG_CRONTAB_UNLOAD = "crontab unloaded"
)

Functions ¶

func AddCronJob ¶ added in v1.1.197

func AddCronJob(tag, spec string, repetitions int, started bool, params et.Json, fn func(event.EvenMessage)) error

* * AddCronJob * @param tag, spec string, repetitions int, started bool, params et.Json, fn func(event.EvenMessage) * @return error *

func AddEventJob ¶ added in v1.1.182

func AddEventJob(tag, spec string, repetitions int, started bool, params et.Json, fn func(event.EvenMessage)) error

* * AddEventJob * @param tag, spec string, repetitions int, started bool, params et.Json, fn func(event.EvenMessage) * @return error *

func AddScheduleJob ¶ added in v1.1.208

func AddScheduleJob(tag, schedule string, started bool, params et.Json, fn func(event.EvenMessage)) error

* * AddScheduleJob * Add job to crontab in execute local * @param tag, schedule string, started bool, params et.Json, fn func(event.EvenMessage) * @return error *

func Close ¶ added in v1.1.142

func Close()

* * Close * @return void *

func DeleteJob ¶

func DeleteJob(tag string) error

* * DeleteJob * @param tag string * @return error *

func HttpGet ¶ added in v1.1.208

func HttpGet(w http.ResponseWriter, r *http.Request)

* * HttpGet * @params w http.ResponseWriter, r *http.Request *

func HttpStart ¶ added in v1.1.208

func HttpStart(w http.ResponseWriter, r *http.Request)

* * HttpStart * @params w http.ResponseWriter, r *http.Request *

func HttpStop ¶ added in v1.1.208

func HttpStop(w http.ResponseWriter, r *http.Request)

* * HttpStop * @params w http.ResponseWriter, r *http.Request *

func Load ¶

func Load(db *jdb.DB, schemaName, tag string) error

* * Load * @params db *jdb.DB, schemaName, tag string * @return error *

func SetLoadInstance ¶ added in v1.1.197

func SetLoadInstance(fn LoadInstanceFn)

func SetSaveInstance ¶ added in v1.1.197

func SetSaveInstance(fn SaveInstanceFn)

func StartJob ¶

func StartJob(tag string) error

* * StartJob * @param tag string * @return error *

func Stop ¶

func Stop() error

* * Stop * @return error *

func StopJob ¶

func StopJob(tag string) error

* * StopJob * @param tag string * @return error *

Types ¶

type Job ¶

type Job struct {
	Type        TypeJob       `json:"type"`
	Tag         string        `json:"tag"`
	Channel     string        `json:"channel"`
	Params      et.Json       `json:"params"`
	Spec        string        `json:"spec"`
	Started     bool          `json:"started"`
	Status      JobStatus     `json:"status"`
	HostName    string        `json:"host_name"`
	Attempts    int           `json:"attempts"`
	Repetitions int           `json:"repetitions"`
	Duration    time.Duration `json:"duration"`
	// contains filtered or unexported fields
}

func (*Job) Finish ¶ added in v1.1.197

func (s *Job) Finish()

* * Finish * @return error *

func (*Job) Save ¶ added in v1.1.197

func (s *Job) Save() error

* * Save * @return error *

func (*Job) Start ¶ added in v1.1.142

func (s *Job) Start() error

* * Start * @return error *

func (*Job) Stop ¶ added in v1.1.142

func (s *Job) Stop()

* * Stop * @return error *

func (*Job) ToJson ¶ added in v1.1.142

func (s *Job) ToJson() et.Json

* * ToJson * @return et.Json *

type JobStatus ¶ added in v1.1.182

type JobStatus string

const (
	Pending  JobStatus = "pending"
	Prepared JobStatus = "prepared"
	Running  JobStatus = "running"
	Done     JobStatus = "done"
	Failed   JobStatus = "failed"
	Finished JobStatus = "finished"
)

type Jobs ¶

type Jobs struct {
	Id       string          `json:"id"`
	Tag      string          `json:"tag"`
	HostName string          `json:"host_name"`
	Jobs     map[string]*Job `json:"jobs"`
	// contains filtered or unexported fields
}

func New ¶

func New(tag string) *Jobs

type LoadInstanceFn ¶ added in v1.1.197

type LoadInstanceFn func(id string, dest any) (bool, error)

type SaveInstanceFn ¶ added in v1.1.197

type SaveInstanceFn func(id, tag string, obj any) error

type TypeJob ¶ added in v1.1.182

type TypeJob string

const (
	CronJob     TypeJob = "cronJob"
	ScheduleJob TypeJob = "scheduleJob"
)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL