task

Documentation

Overview

Package task provides an interface for distributed jobs

Index

• type Command
  • func (c Command) Execute() error
  • func (c Command) String() string
• type Option
  • func WithPool(i int) Option
• type Options
• type Schedule
  • func (s Schedule) Run() <-chan time.Time
  • func (s Schedule) String() string
• type Task

Types

type Command

type Command struct {
	Name string
	Func func() error
}

Command to be executed

func (Command) Execute

func (c Command) Execute() error

func (Command) String

func (c Command) String() string

type Option

type Option func(o *Options)

func WithPool

func WithPool(i int) Option

WithPool sets the pool size for concurrent work

type Options

type Options struct {
	// Pool size for workers
	Pool int
	// Alternative options
	Context context.Context
}

type Schedule

type Schedule struct {
	// When to start the schedule. Zero time means immediately
	Time time.Time
	// Non zero interval dictates an ongoing schedule
	Interval time.Duration
}

Schedule represents a time or interval at which a task should run

func (Schedule) Run

func (s Schedule) Run() <-chan time.Time

func (Schedule) String

func (s Schedule) String() string

type Task

type Task interface {
	// Run runs a command immediately until completion
	Run(Command) error
	// Status provides status of last execution
	Status() string
}

Task represents a distributed task