crontab

package

v1.1.196 Latest Latest Go to latest Published: Feb 13, 2026 License: MIT Imports: 15 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 AddEventJob(tag, spec, channel string, repetitions int, started bool, params et.Json, ...) error
func AddOneShotEventJob(tag, spec, channel string, started bool, params et.Json, ...) error
func Close()
func DeleteJob(tag string) error
func Load(tag string) error
func SetDeleteInstanceFn(fn DeleteInstanceFn)
func SetGetInstanceFn(fn GetInstanceFn)
func SetQueryInstanceFn(fn QueryInstanceFn)
func SetSetInstanceFn(fn SetInstanceFn)
func StartJob(tag string) (int, error)
func Stop() error
func StopJob(tag string) error
type DeleteInstanceFn
type GetInstanceFn
type Job
- func AddJob(tag, spec string, params et.Json, repetitions int, started bool, ...) (*Job, error)
- func AddOneShotJob(tag, spec string, params et.Json, repetitions int, started bool, ...) (*Job, error)
- func (s *Job) Remove()
- func (s *Job) Start() error
- func (s *Job) Stop()
- func (s *Job) ToJson() et.Json
type JobStatus
type Jobs
- func New() *Jobs
type QueryInstanceFn
type SetInstanceFn
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 AddEventJob ¶ added in v1.1.182

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

* * AddEventJob * Event job to crontab function execute was notified by event workers * @param tag, spec, channel string, repetitions int, started bool, params et.Json, fn func(event.EvenMessage) * @return *Job, error *

func AddOneShotEventJob ¶ added in v1.1.182

func AddOneShotEventJob(tag, spec, channel string, started bool, params et.Json, fn func(event.EvenMessage)) error

* * AddOneShotEventJob * Event job to crontab function execute was notified by event workers * @param tag, spec, channel string, repetitions int, started bool, params et.Json, fn func(event.EvenMessage) * @return *Job, 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 Load ¶

func Load(tag string) error

* * Load * @params tag string * @return error *

func SetDeleteInstanceFn ¶ added in v1.1.182

func SetDeleteInstanceFn(fn DeleteInstanceFn)

* * SetDeleteInstanceFn * @param fn DeleteInstanceFn *

func SetGetInstanceFn ¶ added in v1.1.182

func SetGetInstanceFn(fn GetInstanceFn)

* * SetGetInstanceFn * @param fn GetInstanceFn *

func SetQueryInstanceFn ¶ added in v1.1.182

func SetQueryInstanceFn(fn QueryInstanceFn)

* * SetQueryInstanceFn * @param fn QueryInstanceFn *

func SetSetInstanceFn ¶ added in v1.1.182

func SetSetInstanceFn(fn SetInstanceFn)

* * SetSetInstanceFn * @param fn SetInstanceFn *

func StartJob ¶

func StartJob(tag string) (int, error)

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

func Stop ¶

func Stop() error

* * Stop * @return error *

func StopJob ¶

func StopJob(tag string) error

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

Types ¶

type DeleteInstanceFn ¶ added in v1.1.182

type DeleteInstanceFn func(tag string) error

type GetInstanceFn ¶ added in v1.1.182

type GetInstanceFn func(tag string) (*Job, error)

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"`
	Idx         int           `json:"idx"`
	HostName    string        `json:"host_name"`
	Attempts    int           `json:"attempts"`
	Repetitions int           `json:"repetitions"`
	Duration    time.Duration `json:"duration"`
	ShotTime    time.Time     `json:"shot_time"`
	// contains filtered or unexported fields
}

func AddJob ¶

func AddJob(tag, spec string, params et.Json, repetitions int, started bool, fn func(job *Job)) (*Job, error)

* * AddJob * Add job to crontab in execute local * @param tag, spec string, params et.Json, repetitions int, started bool, fn func(job *Job) * @return *Job, error *

func AddOneShotJob ¶ added in v1.1.182

func AddOneShotJob(tag, spec string, params et.Json, repetitions int, started bool, fn func(job *Job)) (*Job, error)

* * AddOneShotJob * Add job to crontab in execute local * @param tag, spec string, params et.Json, repetitions int, started bool, fn func(job *Job) * @return *Job, error *

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

func (s *Job) Remove()

* * Remove * @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 (
	JobStatusPending  JobStatus = "pending"
	JobStatusRunning  JobStatus = "running"
	JobStatusDone     JobStatus = "done"
	JobStatusFailed   JobStatus = "failed"
	JobStatusStop     JobStatus = "stop"
	JobStatusFinished JobStatus = "finished"
)

type Jobs ¶

type Jobs struct {
	Id       string `json:"id"`
	HostName string `json:"host_name"`
	// contains filtered or unexported fields
}

func New ¶

func New() *Jobs

type QueryInstanceFn ¶ added in v1.1.182

type QueryInstanceFn func(query string) (et.Items, error)

type SetInstanceFn ¶ added in v1.1.182

type SetInstanceFn func(*Job) error

type TypeJob ¶ added in v1.1.182

type TypeJob string

const (
	TypeJobCron    TypeJob = "cron"
	TypeJobOneShot TypeJob = "one-shot"
)

Source Files ¶

View all Source files

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