jobs

Documentation

Index

• type Job
  • func All() []*Job
  • func Get(ID string) *Job
  • func NewJob(name string, fn JobFunction) (j *Job)
  • func (j *Job) GenerateID()
  • func (j *Job) Run()
  • func (j *Job) SetStatus(status string)
• type JobFunction

Types

type Job

type Job struct {
	ID        string
	Name      string
	Events    []string
	Status    string
	Completed bool
	Error     error
	Fn        JobFunction `json:"-"`
}

Job is a task being run asyncronosly

func All

func All() []*Job

func Get

func Get(ID string) *Job

func NewJob

func NewJob(name string, fn JobFunction) (j *Job)

func (*Job) GenerateID

func (j *Job) GenerateID()

func (*Job) Run

func (j *Job) Run()

func (*Job) SetStatus

func (j *Job) SetStatus(status string)

type JobFunction

type JobFunction func(*Job) error

JobFunction is a function to be run asyncronosly as a job