jobs

Documentation

Index

• Constants
• func PostUpdate(ctx context.Context, msg string)
• type DescribableJob
• type EventData
• type Job
  • func WithDescription(description string, job Job) Job
• type JobFunc
  • func (jf JobFunc) Execute(ctx context.Context)
• type Services
  • func NewService(bus *bus.Bus) *Services
  • func (jc *Services) CancelForegroundJob() bool
  • func (jc *Services) SubmitForegroundJob(job Job) error

Constants

const (
	JobStartEvent  = "jobs.start"
	JobIdleEvent   = "jobs.idle"
	JobUpdateEvent = "jobs.update"
)

Functions

func PostUpdate

func PostUpdate(ctx context.Context, msg string)

Types

type DescribableJob

type DescribableJob struct {
	Job
	Description string
}

type EventData

type EventData struct {
	Job Job
}

type Job

type Job interface {
	Execute(ctx context.Context)
}

func WithDescription

func WithDescription(description string, job Job) Job

type JobFunc

type JobFunc func(ctx context.Context)

func (JobFunc) Execute

func (jf JobFunc) Execute(ctx context.Context)

type Services

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

func NewService

func NewService(bus *bus.Bus) *Services

func (*Services) CancelForegroundJob

func (jc *Services) CancelForegroundJob() bool

func (*Services) SubmitForegroundJob

func (jc *Services) SubmitForegroundJob(job Job) error

SubmitForegroundJob starts a foreground job.