asyncjob

Documentation

Index

• func NewGroup(isConcurrent bool, jobs ...Job) *group
• func NewJob(handler JobHandler, options ...OptionHandler) *job
• type Job
• type JobHandler
• type JobState
• type OptionHandler
  • func WithName(name string) OptionHandler
  • func WithRetryDurations(times []time.Duration) OptionHandler

Functions

func NewGroup

func NewGroup(isConcurrent bool, jobs ...Job) *group

func NewJob

func NewJob(handler JobHandler, options ...OptionHandler) *job

Types

type Job

type Job interface {
	Name() string
	Execute(ctx context.Context) error
	Retry(ctx context.Context) error
	State() JobState
	RetryIndex() int
	SetRetryDurations(times []time.Duration)
	LastError() error
}

type JobHandler

type JobHandler func(ctx context.Context) error

type JobState

type JobState int

const (
	StateInit JobState = iota
	StateRunning
	StateFailed
	StateTimeout
	StateCompleted
	StateRetryFailed
)

type OptionHandler

type OptionHandler func(*jobConfig)

func WithName

func WithName(name string) OptionHandler

func WithRetryDurations

func WithRetryDurations(times []time.Duration) OptionHandler