PriorityWorkerPool

README

Priority Worker Pool

A worker pool in GoLang which schedules job according to priority.

Installation

go get github.com/kc596/PriorityWorkerPool

Quickstart

var panicHandler = func(alias string, err interface{}) {
	fmt.Println(alias, err) // or use logger
}

pool := New("testPool", 100, panicHandler)

for _, job := range jobs {  // jobs are slices of func()
	pool.Submit(job, 1+rand.Float64())
}

APIs

Method	Return Type	Description
New(name string, workers int, panicHandler func(alias string, err interface{})	*Pool	Returns a new Worker pool
Submit(job func(), priority float64)	void	Submit a new job to worker pool
WaitGroup()	*sync.WaitGroup	Returns waitgroup to wait for all jobs submitted to finish

Documentation

Index

• type Pool
  • func New(name string, workers int, panicHandler func(alias string, err interface{})) *Pool
  • func (pool *Pool) Submit(job func(), priority float64)
  • func (pool *Pool) WaitGroup() *sync.WaitGroup

Types

type Pool

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

Pool is type for Worker Pool

func New

func New(name string, workers int, panicHandler func(alias string, err interface{})) *Pool

New creates a new worker pool to manage goroutines

func (*Pool) Submit

func (pool *Pool) Submit(job func(), priority float64)

Submit a job to worker pool

func (*Pool) WaitGroup

func (pool *Pool) WaitGroup() *sync.WaitGroup

WaitGroup to wait for all jobs submitted to finish WARNING: would not wait if there are no jobs at the instant