scheduler

Documentation

Index

• func IsElastic(sc Scheduler) bool
• func IsParallel(sc Scheduler) bool
• func IsSingle(sc Scheduler) bool
• type Scheduler
  • func Elastic() Scheduler
  • func ElasticBounded() Scheduler
  • func Immediate() Scheduler
  • func NewAnts(pool *ants.Pool) Scheduler
  • func NewElastic(size int) Scheduler
  • func NewSingle() Scheduler
  • func Parallel() Scheduler
  • func Single() Scheduler
• type Task
• type Worker

Functions

func IsElastic

func IsElastic(sc Scheduler) bool

func IsParallel

func IsParallel(sc Scheduler) bool

func IsSingle

func IsSingle(sc Scheduler) bool

Types

type Scheduler

type Scheduler interface {
	io.Closer
	// Name return the name of scheduler.
	Name() string
	// Worker returns next worker.
	Worker() Worker
}

Scheduler schedule tasks.

func Elastic

func Elastic() Scheduler

Elastic is a dynamic alloc scheduler. It's based on ants goroutine pool.

func ElasticBounded

func ElasticBounded() Scheduler

ElasticBounded is a dynamic scheduler with bounded size. It's based on ants goroutine pool.

func Immediate

func Immediate() Scheduler

Immediate returns a scheduler which schedule tasks _immediate.

func NewAnts

func NewAnts(pool *ants.Pool) Scheduler

NewAnts creates a new scheduler over ants pool.

func NewElastic

func NewElastic(size int) Scheduler

NewElastic creates a new elastic scheduler.

func NewSingle

func NewSingle() Scheduler

NewSingle creates a new single scheduler with customized cap.

func Parallel

func Parallel() Scheduler

Parallel returns scheduler which schedule tasks in _parallel using native goroutines.

func Single

func Single() Scheduler

Single returns a scheduler which schedule tasks on a single goroutine. It will execute tasks one by one.

type Task

type Task func()

Task defines task function.

type Worker

type Worker interface {
	// Do executes a task.
	Do(Task) error
}

Worker is used to execute a task.